Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). 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 R4B R4

Extension: animal

Patient Administration Work Group   Maturity Level : 1 Informative Use Context : Any

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

Name Flags Card. Type Description & Constraints doco
. . 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.


doco Documentation for this format

Full Structure

I I I I
Name Flags Card. Type Description & Constraints doco
. . 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 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.
. . . extension . id I 0..0 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: Animal species 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 I 0..0
. . . . url 1..1 uri "breed"
. . . . value[x] I 1..1 CodeableConcept Value of extension
Binding: Animal breeds AnimalBreeds ( example ) ): The breed of an animal.

. . . extension . id I 0..0 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: Gender status 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
. . . . valueBase64Binary valueBoolean base64Binary boolean
. . . valueBoolean . valueCanonical boolean canonical (Any)
. . . valueCanonical . valueCode canonical code ()
. . . . valueCode valueDate code date
. . . . valueDate valueDateTime date dateTime
. . . . valueDateTime valueDecimal dateTime decimal
. . . . valueDecimal valueId decimal id
. . . . valueId valueInstant id instant
. . . . valueInstant valueInteger instant integer
. . . . valueInteger valueMarkdown integer markdown
. . . . valueMarkdown valueOid markdown oid
. . . . valueOid valuePositiveInt oid positiveInt
. . . . valuePositiveInt valueString positiveInt string
. . . . valueString valueTime string time
. . . . valueTime valueUnsignedInt time unsignedInt
. . . . valueUnsignedInt valueUri unsignedInt uri
. . . . valueUri valueUrl uri url
. . . . valueUrl valueUuid url uuid
. . . valueUuid . valueAddress uuid Address
. . . . valueAddress valueAge Address Age
. . . . valueAge valueAnnotation Age Annotation
. . . . valueAnnotation valueAttachment Annotation Attachment
. . . . valueAttachment valueCodeableConcept Attachment CodeableConcept
. . . . valueCodeableConcept valueCodeableReference CodeableConcept 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
. . . valueReference . valueRatioRange Reference RatioRange ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Meta Dosage

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"> ?? 1..1 Extension  <!-- ?? 1..1 The animal species.  E.g. Dog, Cow. -->
  <</valueCodeableConcept>

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

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

  <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 doco
. . 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.


doco Documentation for this format

Full Structure

I I I I
Name Flags Card. Type Description & Constraints doco
. . 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 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.
. . . extension . id I 0..0 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: Animal species 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 I 0..0
. . . . url 1..1 uri "breed"
. . . . value[x] I 1..1 CodeableConcept Value of extension
Binding: Animal breeds AnimalBreeds ( example ) ): The breed of an animal.

. . . extension . id I 0..0 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: Gender status 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
. . . . valueBase64Binary valueBoolean base64Binary boolean
. . . valueBoolean . valueCanonical boolean canonical (Any)
. . . valueCanonical . valueCode canonical code ()
. . . . valueCode valueDate code date
. . . . valueDate valueDateTime date dateTime
. . . . valueDateTime valueDecimal dateTime decimal
. . . . valueDecimal valueId decimal id
. . . . valueId valueInstant id instant
. . . . valueInstant valueInteger instant integer
. . . . valueInteger valueMarkdown integer markdown
. . . . valueMarkdown valueOid markdown oid
. . . . valueOid valuePositiveInt oid positiveInt
. . . . valuePositiveInt valueString positiveInt string
. . . . valueString valueTime string time
. . . . valueTime valueUnsignedInt time unsignedInt
. . . . valueUnsignedInt valueUri unsignedInt uri
. . . . valueUri valueUrl uri url
. . . . valueUrl valueUuid url uuid
. . . valueUuid . valueAddress uuid Address
. . . . valueAddress valueAge Address Age
. . . . valueAge valueAnnotation Age Annotation
. . . . valueAnnotation valueAttachment Annotation Attachment
. . . . valueAttachment valueCodeableConcept Attachment CodeableConcept
. . . . valueCodeableConcept valueCodeableReference CodeableConcept 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
. . . valueReference . valueRatioRange Reference RatioRange ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Meta Dosage

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"> ?? 1..1 Extension  <!-- ?? 1..1 The animal species.  E.g. Dog, Cow. -->
  <</valueCodeableConcept>

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

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

  <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 unless an empty Parameters resource (xpath: @value|f:*|h:div @value|f:*|h:div|self::f:Parameters )
  • 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 )