The formal definitions for the elements in the animal resource. Also available as an XML file.
| Animal |
| Definition | An animal (non-human) that has relevance to the care process |
| Control | 1..1 |
| Requirements | Need to be able to track animals - veterinary medicine is an active user of HL7 standards. Animals are also relevant in clinical studies, as "animal helpers", etc. |
| Comments | Animals differ from Persons because you need to track species and strain, and also different kind of relationships - owners |
| RIM Mapping | NonPersonLivingSubject(classCode=ANM, determinerCode=INST) |
| v2 Mapping | PID |
| Animal.identifier |
| Definition | Identifier for the animal that is used to identify the person across multiple disparate systems and also for face to face identification of the person |
| Control | 0..* |
| Type | HumanId |
| Must Understand | true |
| Requirements | Animals are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the animal |
| RIM Mapping | .scopes[Role](classCode=IDENT) |
| v2 Mapping | PID.3 |
| Animal.name |
| Definition | A label assigned by humans to this specific individual animal |
| Control | 0..* |
| Type | HumanName |
| Must Understand | true |
| Requirements | Some animals have names, which are assigned by humans for human reasons, and follow human naming patterns |
| RIM Mapping | .name |
| v2 Mapping | PID.5 |
| Animal.dob |
| Definition | The year, date or date-time on which the animal was born |
| Control | 0..1 |
| Type | dateTime |
| Must Understand | true |
| Requirements | Age of the animal drives many clinical processes. |
| RIM Mapping | .dateOfBirth |
| v2 Mapping | PID.7 |
| To Do | RIM change to support human date (time only - but is this needed in this context?) |
| Animal.species |
| Definition | Identifies the high level categorization of the kind of animal |
| Control | 0..1 |
| Type | CodeableConcept from AnimalSpecies |
| Must Understand | true |
| Requirements | Need to know what kind of animal |
| RIM Mapping | .playedRole[classCode=GEN].scoper[classCode=ANM, determinerCode=KIND].code |
| v2 Mapping | PID.35 |
| Animal.breed |
| Definition | Identifies the detailed categorization of the kind of animal. |
| Control | 0..1 |
| Type | CodeableConcept from AnimalBreed |
| Must Understand | true |
| Requirements | May need to know the specific kind within the species |
| RIM Mapping | .code |
| v2 Mapping | PID.37 |
| To Do | Not sure why this is ED in the RIM. Should probably change to SC. |
| Animal.gender |
| Definition | Gender for the Animal |
| Control | 0..1 |
| Type | CodeableConcept from AnimalGender |
| Must Understand | true |
| Requirements | For managing the animal, including appropriate housing. |
| Comments | Note that some animals have additional genders not encountered in humans |
| RIM Mapping | .administrativeGenderCode |
| v2 Mapping | PID.8 |
| Animal.genderStatus |
| Definition | Indicates the current state of the animal's reproductive organs |
| Control | 0..1 |
| Type | CodeableConcept from AnimalGenderStatus |
| Requirements | Gender status can affect housing and animal behavior |
| RIM Mapping | .genderStatusCode |
| v2 Mapping | N/A |
| Animal.relatedEntity |
| Definition | People and animals that hold a relevant relationship to the animal |
| Control | 0..* |
| Requirements | Genetic relationships between animals can be relevant for some use-cases, but the primary use-case is to identify the humans affiliated with an animal |
| RIM Mapping | .scopes[Role](classCode=REL).player |
| v2 Mapping | ROL |
| Animal.relatedEntity.identifier |
| Definition | Human-displayable identifier associated with the referenced entity |
| Control | 0..1 |
| Type | HumanId |
| Requirements | Allows reliable identification of and potentially retrieval of additional information about the related entity |
| RIM Mapping | .id |
| v2 Mapping | ROL.4 |
| Animal.relatedEntity.role |
| Definition | Identifies how the referenced entity is related to the animal |
| Control | 1..1 |
| Type | CodeableConcept from AnimalRelationship |
| Requirements | Allows choosing between multiple related entities |
| RIM Mapping | .code |
| v2 Mapping | ROL.3 |
| Animal.relatedEntity.name |
| Definition | Name of the related entity |
| Control | 0..1 |
| Type | HumanName |
| Requirements | This is the human-recognizable label for the entity and indicates how to address a human |
| RIM Mapping | .name |
| v2 Mapping | ROL.4 |
| Animal.relatedEntity.address |
| Definition | Indicates where the related entity can be found or reached |
| Control | 0..* |
| Type | Address |
| Requirements | Allows contacting the related entity |
| Comments | Usually for human related entities, but could be the address of a related animal |
| RIM Mapping | .addr |
| v2 Mapping | ROL.11 |
| Animal.relatedEntity.contact |
| Definition | Indicates how the related entity can be contacted |
| Control | 0..* |
| Type | Contact |
| Requirements | Allows contacting the related entity |
| Comments | Usually for human related entities |
| RIM Mapping | .telecom |
| v2 Mapping | ROL.12 |
| Animal.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | [varies] |
| Animal.text |
| Definition | |
| Control | 1..1 |
| Type | Narrative |
| To Do | .text |
This is an old version of FHIR retained for archive purposes. Do not use for anything else