This page is part of the FHIR Specification (v0.01: Historical Archive Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

# Animal

An animal that has relevance to the care process -usually this is for animals that are patients..

The relative url is /animals

## Content

    <Animal xmlns="http://www.hl7.org/fhir">
      <id> mand id Master Resource Id, always first in all resources</id>
      <identifier> Zero+ HumanId Human identifiers for this animal</identifier>
      <name> Zero+ HumanName A name associated with the animal</name>
      <dob> opt dateTime The birth date for the animal</dob>
      <species> opt CodeableConcept Species for the Animal</species>
      <strain> opt CodeableConcept Strain for the Animal</strain>
      <gender> opt CodeableConcept Gender for the Animal</gender>
      <relatedEntity>  <!-- Zero+ Kin, owner, care giver etc -->
       <id> opt HumanId Identifier for the entity</id>
       <role> mand CodeableConcept Type of relationship</role>
       <name> opt HumanName Name of the related entity</name>
       <address> Zero+ Address An address (usually human, but may be kin)</address>
       <contact> Zero+ Contact Contact details (usually for humans)</contact>
      </relatedEntity>
      <extensions> opt See Extensions   See Extensions </extensions>
      <text> mand Narrative Text summary of animal, fall back for human interpretation</text>
    </Animal>

Schema for Animal and an example (or formatted for browser)

Terminology Bindings

- Animal.species is bound to the concept domain AnimalSpecies: "The species of an animal"
- Animal.strain is bound to the concept domain AnimalStrain: "The strain of an animal"
- Animal.gender is bound to the concept domain AnimalGender: "The gender of an animal"
- Animal.relatedEntity.role is bound to the concept domain AnimalRelationship: "The relationship of an animal to another entity (person, corporation, or other animal)"

Notes:

- Animals are assigned human names, since humans tend to assign names using human patterns.
- Related entities include owners, and care givers, as well as the kin of the animal should that be relevant.
- The organization references are all optional, so can be replaced by simple text rather than a full resource reference
- The organization references are all optional, so can be replaced by simple text rather than a full resource reference
- A related entity can be either reference to another resource using the id, or can provide what is known about the entity directly

## Searching Criteria

The following simple search/filter parameters are defined for person:

name | a portion of name in any name part
species | the species, including by subsumption if the coding supports this
phonetic | a portion of name using some kind of phonetic matching algorithm
id | search id in any identifiers

The standard search parameters also apply (see Searching).

## Formal Definitions

The formal definitions for the elements above. 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 | Mandatory, 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 | Mandatory, 1..1
Type | id
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 | Optional, 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 | Optional, 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 | Optional, 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 | Optional, 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.id
Definition | Identifier for the entity
Control | Optional, 0..1
Type | HumanId
Animal.relatedEntity.role
Definition | Type of relationship
Control | Mandatory, 1..1
Type | CodeableConcept from AnimalRelationship
Animal.relatedEntity.name
Definition | Name of the related entity
Control | Optional, 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.extensions
Definition | See Extensions
Control | Optional, 0..1
RIM Mapping | [varies]
Animal.text
Definition |
Control | Mandatory, 1..1
Type | Narrative
To Do | .text

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.01 generated on Mon, May 14, 2012 09:48+1000.