This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: animal

URL for this extension:

http://hl7.org/fhir/StructureDefinition/patient-animal

Status: draft. Extension maintained by: HL7

This patient is known to be an animal.

Comment:

The absence of the animal extension does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

Context of Use: Use on Element ID Patient

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
animal		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal animal: This patient is known to be an animal. Use on Element ID Patient
species		1..1	CodeableConcept	Identifies the high level taxonomic categorization of the kind of animal.
breed		0..1	CodeableConcept	Identifies the detailed categorization of the kind of animal.
genderStatus		0..1	CodeableConcept	Indicates the current state of the animal's reproductive organs.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal animal: This patient is known to be an animal. Use on Element ID Patient
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:species	I	1..1	Extension	The animal species. E.g. Dog, Cow.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"species"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Animal species (example)
extension:breed	I	0..1	Extension	The animal breed. E.g. Poodle, Angus.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"breed"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Animal breeds (example)
extension:genderStatus	I	0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"genderStatus"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Gender status (example)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- animal -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-animal" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="species">  1..1 Extension  <!--  1..1 The animal species.  E.g. Dog, Cow. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="breed">  0..1 Extension  <!--  0..1 The animal breed.  E.g. Poodle, Angus. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="genderStatus">  0..1 Extension  <!--  0..1 The status of the animal's reproductive parts.  E.g. Neutered, Intact. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // animal
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The animal species.  E.g. Dog, Cow. // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "species", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // The animal breed.  E.g. Poodle, Angus. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "breed", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // The status of the animal's reproductive parts.  E.g. Neutered, Intact. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "genderStatus", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
animal		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal animal: This patient is known to be an animal. Use on Element ID Patient
species		1..1	CodeableConcept	Identifies the high level taxonomic categorization of the kind of animal.
breed		0..1	CodeableConcept	Identifies the detailed categorization of the kind of animal.
genderStatus		0..1	CodeableConcept	Indicates the current state of the animal's reproductive organs.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal animal: This patient is known to be an animal. Use on Element ID Patient
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:species	I	1..1	Extension	The animal species. E.g. Dog, Cow.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"species"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Animal species (example)
extension:breed	I	0..1	Extension	The animal breed. E.g. Poodle, Angus.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"breed"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Animal breeds (example)
extension:genderStatus	I	0..1	Extension	The status of the animal's reproductive parts. E.g. Neutered, Intact.
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"genderStatus"
value[x]	I	1..1	CodeableConcept	Value of extension Binding: Gender status (example)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	I	0..0
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- animal -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/patient-animal" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="species">  1..1 Extension  <!--  1..1 The animal species.  E.g. Dog, Cow. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="breed">  0..1 Extension  <!--  0..1 The animal breed.  E.g. Poodle, Angus. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="genderStatus">  0..1 Extension  <!--  0..1 The status of the animal's reproductive parts.  E.g. Neutered, Intact. -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // animal
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The animal species.  E.g. Dog, Cow. // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "species", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // The animal breed.  E.g. Poodle, Angus. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "breed", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // The status of the animal's reproductive parts.  E.g. Neutered, Intact. // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "genderStatus", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

Constraints

• ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
• ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
• ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
• ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)