This page is part of the FHIR Specification (v0.05: DSTU 1 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Animal - Content

Status: A domain resource developed as an examplar. Not an approved resource. Under consideration by the Patient Admin work group

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

The resource name as it appears in a RESTful URL is /animal/

Resource Content

UML Image

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

Alternate definitions: Schema/Schematron, RDF (to do), XML, Resource Profile

Terminology Bindings

Animal.species has the definition AnimalSpecies: "The species of an animal"
Animal.strain has the definition AnimalStrain: "The strain of an animal"
Animal.gender has the definition AnimalGender: "The gender of an animal"
Animal.relatedEntity.role has the definition 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

Search Parameters

Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.

n : integer	Starting offset of the first record to return in the search set
count : integer	Number of return records requested. The server is not bound to conform
id : token	The id of the resource
name : string	a portion of name in any name part
species : qtoken	the species, including by subsumption if the coding supports this
phonetic : string	a portion of name using some kind of phonetic matching algorithm
related : string	a portion of any part of a related entity's name
identifier : qtoken	an identifier for the animal

(See Searching).

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.05 generated on Sun, Sep 9, 2012 03:28+1000. License