The formal definitions for the elements in the animal resource. Also available as an XML file.
Animal |
Definition | An animal that has relevance to the care process -usually this is for animals that are patients. |
Control | 1..1 |
Requirements | Need to be able to track animals - vetinary medicine is an active user of HL7 standards |
Comments | Animals differ because you need to track species and strain, and also different kind of relationships - owners |
RIM Mapping | NonPersonLivingSubject(classCode=ANM, determinerCode=INST) |
Animal.id |
Definition | Master Resource Id, always first in all resources |
Control | 1..1 |
Type | id |
Must Understand | true |
To Do | .id(scope=OBJ) |
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) |
Animal.name |
Definition | A name associated with the animal. The use code maiden does not apply. |
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 |
Animal.dob |
Definition | The birth date for the animal |
Control | 0..1 |
Type | dateTime |
Must Understand | true |
Requirements | Age of the animal drives many clinical processes. |
RIM Mapping | .dateOfBirth |
To Do | RIM change to support human date (time only - but is this needed in this context?) |
Animal.species |
Definition | Species for the animal |
Control | 0..1 |
Type | CodeableConcept from AnimalSpecies |
Must Understand | true |
Requirements | Need to know what kind of animal |
RIM Mapping | .code |
Animal.strain |
Definition | Strain for the animal |
Control | 0..1 |
Type | CodeableConcept from AnimalStrain |
Must Understand | true |
Requirements | May need to know the specific kind within the species |
RIM Mapping | .strainText |
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 |
Comments | Note that some animals have additional gender not encountered in humans? |
RIM Mapping | .administrativeGenderCode |
Animal.relatedEntity |
Definition | Kin, owner, care giver etc |
Control | 0..* |
Animal.relatedEntity.identifier |
Definition | Identifier for the entity |
Control | 0..1 |
Type | HumanId |
Animal.relatedEntity.role |
Definition | Type of relationship |
Control | 1..1 |
Type | CodeableConcept from AnimalRelationship |
Animal.relatedEntity.name |
Definition | Name of the related entity |
Control | 0..1 |
Type | HumanName |
Animal.relatedEntity.address |
Definition | An address (usually human, but may be kin) |
Control | 0..* |
Type | Address |
Animal.relatedEntity.contact |
Definition | Contact details (usually for humans) |
Control | 0..* |
Type | Contact |
Animal.extension |
Definition | See Extensions |
Control | 0..* |
Type | Extension |
RIM Mapping | [varies] |
Animal.text |
Definition | |
Control | 1..1 |
Type | Narrative |
To Do | .text |