This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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
Patient Administration Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Summary
Defining URL: | http://hl7.org/fhir/StructureDefinition/patient-animal |
Version: | 5.0.0-ballot |
Name: | animal |
Title: | animal |
Modifier: | This extension is not a modifier extension |
Status: | draft |
Definition: | This patient is known to be an animal. |
Committee: | Patient Administration Work Group |
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
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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension:species | 1..1 | Extension | The animal species. E.g. Dog, Cow. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "species" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AnimalSpecies (example): The species of an animal. | |
extension:breed | 0..1 | Extension | The animal breed. E.g. Poodle, Angus. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "breed" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. | |
extension:genderStatus | 0..1 | Extension | The status of the animal's reproductive parts. E.g. Neutered, Intact. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "genderStatus" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs. | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |
value[x] | 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 | |||
valueCodeableReference | CodeableReference | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueRatioRange | RatioRange | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueAvailability | Availability | |||
valueExtendedContactDetail | ExtendedContactDetail | |||
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"> I 1..1 Extension <!-- I 1..1 The animal species. E.g. Dog, Cow. --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="breed"> I 0..1 Extension <!-- I 0..1 The animal breed. E.g. Poodle, Angus. --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="genderStatus"> I 0..1 Extension <!-- I 0..1 The status of the animal's reproductive parts. E.g. Neutered, Intact. --> <valueCodeableConcept><!-- I 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. // I R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "species", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension }, { // The animal breed. E.g. Poodle, Angus. // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "breed", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension }, { // The status of the animal's reproductive parts. E.g. Neutered, Intact. // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "genderStatus", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension } ], "extension" : [{ Extension }], // IAdditional content defined by implementations "extension" : { Extension }, // I R! The animal species. E.g. Dog, Cow. "extension" : { Extension }, // IThe animal breed. E.g. Poodle, Angus. "extension" : { Extension }, // IThe status of the animal's reproductive parts. E.g. Neutered, Intact. "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal" // R! // value[x]: Value of extension: Prohibited }
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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
extension:species | 1..1 | Extension | The animal species. E.g. Dog, Cow. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "species" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AnimalSpecies (example): The species of an animal. | |
extension:breed | 0..1 | Extension | The animal breed. E.g. Poodle, Angus. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "breed" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. | |
extension:genderStatus | 0..1 | Extension | The status of the animal's reproductive parts. E.g. Neutered, Intact. | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "genderStatus" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: GenderStatus (example): The state of the animal's reproductive organs. | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |
value[x] | 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 | |||
valueCodeableReference | CodeableReference | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueRatioRange | RatioRange | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueAvailability | Availability | |||
valueExtendedContactDetail | ExtendedContactDetail | |||
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"> I 1..1 Extension <!-- I 1..1 The animal species. E.g. Dog, Cow. --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="breed"> I 0..1 Extension <!-- I 0..1 The animal breed. E.g. Poodle, Angus. --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="genderStatus"> I 0..1 Extension <!-- I 0..1 The status of the animal's reproductive parts. E.g. Neutered, Intact. --> <valueCodeableConcept><!-- I 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. // I R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "species", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension }, { // The animal breed. E.g. Poodle, Angus. // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "breed", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension }, { // The status of the animal's reproductive parts. E.g. Neutered, Intact. // I // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "genderStatus", // R! "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension } ], "extension" : [{ Extension }], // IAdditional content defined by implementations "extension" : { Extension }, // I R! The animal species. E.g. Dog, Cow. "extension" : { Extension }, // IThe animal breed. E.g. Poodle, Angus. "extension" : { Extension }, // IThe status of the animal's reproductive parts. E.g. Neutered, Intact. "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal" // R! // value[x]: Value of extension: Prohibited }
Constraints
Search
No Search Extensions defined for this resource |
Examples of this extension