This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). 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 3.2

Status: Not an approved resource: examplar. Under Consideration by Patient Administration Working Group

An animal (non-human) that has relevance to the care process.

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

Animals are relevant to healthcare in various contexts including (but not limited to) the following:

They may be patients in veterinary medicine
They may be monitored by public health systems
They may be dispensed for in narcotic tracking systems
They can be subjects of clinical research
They can provide services to those with special needs

Resource Content 3.2.1

UML Image

<Animal xmlns="http://hl7.org/fhir">
 <identifier><!-- 0..* HumanId Human identifiers for this animal --></identifier>
 <name><!-- 0..* HumanName A name associated with the animal --></name>
 <dob><!-- 0..1 dateTime The birth date for the animal --></dob>
 <species><!-- 0..1 CodeableConcept E.g. Dog, Cow --></species>
 <breed><!-- 0..1 CodeableConcept E.g. Poodle, Angus --></breed>
 <gender><!-- 0..1 CodeableConcept E.g. Male, Female --></gender>
 <genderStatus><!-- 0..1 CodeableConcept E.g. Neutered, Intact --></genderStatus>
 <relatedEntity>  <!-- 0..* Kin, owner, care giver, etc. -->
  <identifier><!-- 0..1 HumanId Identifier for the entity --></identifier>
  <role><!-- 1..1 CodeableConcept Type of relationship --></role>
  <name><!-- 0..1 HumanName Name of the related entity --></name>
  <address><!-- 0..* Address Physical or postal address --></address>
  <contact><!-- 0..* Contact Phone, e-mail, etc. --></contact>
 </relatedEntity>
 <extension><!-- 0..* Extension  See Extensions  --></extension>
 <text><!-- 1..1 Narrative Text summary of resource (for human interpretation) --></text>
</Animal>

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

Terminology Bindings

Path	Details	Strength
Animal.species	The species of an animal (not bound to any particular codes)	complete/unstated
Animal.breed	The breed of an animal (not bound to any particular codes)	complete/unstated
Animal.gender	The gender of an animal (not bound to any particular codes)	complete/unstated
Animal.genderStatus	The state of the animal's reproductive organs (not bound to any particular codes)	complete/unstated
Animal.relatedEntity.role	The relationship of an animal to another entity (person, corporation, or other animal) (not bound to any particular codes)	complete/unstated

Path

Details

Strength

Animal.species

The species of an animal (not bound to any particular codes)

complete/unstated

Animal.breed

The breed of an animal (not bound to any particular codes)

complete/unstated

Animal.gender

The gender of an animal (not bound to any particular codes)

complete/unstated

Animal.genderStatus

The state of the animal's reproductive organs (not bound to any particular codes)

complete/unstated

Animal.relatedEntity.role

The relationship of an animal to another entity (person, corporation, or other animal) (not bound to any particular codes)

complete/unstated

Constraints

Name use cannot be "maiden" (xpath on /name: not(f:use='maiden'))

Notes: 3.2.2

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

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

$page : integer	Starting offset of the first record to return in the search set	single
$count : integer	Number of return records requested. The server is not bound to conform	single
$id : token	The logical resource id associated with the resource (must be supported by all servers)	single
name : string	A portion of the name in any name part	union
species : qtoken	The species, including by subsumption if the coding supports this	union
phonetic : string	A portion of name using some kind of phonetic matching algorithm	union
related : string	A portion of any part of a related entity's name	union
identifier : qtoken	An identifier for the animal	union

(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.06 generated on Tue, Dec 4, 2012 00:03+1100. License