Snapshot 3: Connectathon 32 Base

This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.

Extension: Patient Animal

Patient Administration Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/patient-animal`				Version: 5.0.0-snapshot3
draft as of 2021-01-02				Computable Name: PatAnimal
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1343

Context of Use: Use on Element ID Patient

Definition

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

Summary

Name	Card.	Type	Description & Constraints
PatAnimal	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal PatAnimal: This patient is known to be an animal. Use on Element ID Patient
species	1..1	CodeableConcept	The animal species. E.g. Dog, Cow. Binding: AnimalSpecies (example): The species of an animal.
breed	0..1	CodeableConcept	The animal breed. E.g. Poodle, Angus. Binding: AnimalBreeds (example): The breed of an animal.
genderStatus	0..1	CodeableConcept	The status of the animal's reproductive parts. E.g. Neutered, Intact. Binding: GenderStatus (example): The state of the animal's reproductive organs.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal PatAnimal: 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
Documentation for this format

XML Template

<!-- PatAnimal -->

<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

{ // PatAnimal
    "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	Card.	Type	Description & Constraints
PatAnimal	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal PatAnimal: This patient is known to be an animal. Use on Element ID Patient
species	1..1	CodeableConcept	The animal species. E.g. Dog, Cow. Binding: AnimalSpecies (example): The species of an animal.
breed	0..1	CodeableConcept	The animal breed. E.g. Poodle, Angus. Binding: AnimalBreeds (example): The breed of an animal.
genderStatus	0..1	CodeableConcept	The status of the animal's reproductive parts. E.g. Neutered, Intact. Binding: GenderStatus (example): The state of the animal's reproductive organs.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/patient-animal PatAnimal: 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
Documentation for this format

XML Template

<!-- PatAnimal -->

<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

{ // PatAnimal
    "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: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

Animal: Patient/animal