Release 5 Ballot

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

Extension: animal

Patient Administration Work Group Maturity Level: 1InformativeUse 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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. animal0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-animal
animal: This patient is known to be an animal.


Use on Element ID Patient
... species1..1CodeableConceptIdentifies the high level taxonomic categorization of the kind of animal.

... breed0..1CodeableConceptIdentifies the detailed categorization of the kind of animal.

... genderStatus0..1CodeableConceptIndicates the current state of the animal's reproductive organs.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

... extension:breed 0..1ExtensionThe animal breed. E.g. Poodle, Angus.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueAvailabilityAvailability
.... valueExtendedContactDetailExtendedContactDetail
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- animal -->doco

<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

NameFlagsCard.TypeDescription & Constraintsdoco
.. animal0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/patient-animal
animal: This patient is known to be an animal.


Use on Element ID Patient
... species1..1CodeableConceptIdentifies the high level taxonomic categorization of the kind of animal.

... breed0..1CodeableConceptIdentifies the detailed categorization of the kind of animal.

... genderStatus0..1CodeableConceptIndicates the current state of the animal's reproductive organs.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

... extension:breed 0..1ExtensionThe animal breed. E.g. Poodle, Angus.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueAvailabilityAvailability
.... valueExtendedContactDetailExtendedContactDetail
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- animal -->doco

<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

  • 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)

Search

No Search Extensions defined for this resource

Examples of this extension