R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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 : 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 element 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

usage info: insert a list of places where this extension is used

Extension Content

Summary

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

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
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension The animal species. E.g. Dog, Cow.
. . . . extension 0..0
. . . . url 1..1 uri "species"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AnimalSpecies Animal species ( example )
. . . extension 0..1 Extension The animal breed. E.g. Poodle, Angus.
. . . . extension 0..0
. . . . url 1..1 uri "breed"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AnimalBreeds Animal breeds ( example )
. . . extension 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
. . . . extension 0..0
. . . . url 1..1 uri "genderStatus"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GenderStatus Gender status ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
. . . value[x] 0 .. 0

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><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="breed"> 0..1 Extension  <!-- 0..1 The animal breed.  E.g. Poodle, Angus. -->
  <valueCodeableConcept><!-- 0..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><!-- 0..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. // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "species", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // The animal breed.  E.g. Poodle, Angus. //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "breed", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // The status of the animal's reproductive parts.  E.g. Neutered, Intact. //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "genderStatus", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 


// value[x]: Value of extension. One of these 49:
  }

Summary

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

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
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension The animal species. E.g. Dog, Cow.
. . . . extension 0..0
. . . . url 1..1 uri "species"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AnimalSpecies Animal species ( example )
. . . extension 0..1 Extension The animal breed. E.g. Poodle, Angus.
. . . . extension 0..0
. . . . url 1..1 uri "breed"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: AnimalBreeds Animal breeds ( example )
. . . extension 0..1 Extension The status of the animal's reproductive parts. E.g. Neutered, Intact.
. . . . extension 0..0
. . . . url 1..1 uri "genderStatus"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GenderStatus Gender status ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
. . . value[x] 0 .. 0

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><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="breed"> 0..1 Extension  <!-- 0..1 The animal breed.  E.g. Poodle, Angus. -->
  <valueCodeableConcept><!-- 0..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><!-- 0..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. // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "species", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // The animal breed.  E.g. Poodle, Angus. //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "breed", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // The status of the animal's reproductive parts.  E.g. Neutered, Intact. //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "genderStatus", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 


// value[x]: Value of extension. One of these 49:
  }

 

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')]) )