Person
Class Animal

A subtype of LivingSubject that includes all animals except the species homo sapiens which might be the subject of Healthcare-related activities. Note that this class does not include microorganisms, insects, plants, etc. A separate MicroOrganism class exists in Laboratory to handle identification of microorganisms in Laboratory Tests.
"This patient is known to be an animal." - HL7 FHIR, Patient.animal

Attributes
«BL» NullableBoolean isNeutered isNeutered

Indicates whether the animal has been altered such that they cannot procreate. Note that information that the animal has been neutered can also be modeled in a clinical domain as a procedure or observation, however it is captured in this domain as a simple property.
"Indicates the current state of the animal's reproductive organs." - HL7 FHIR, Patient.animal.genderStatus. Note that FHIR models this concept as a code with values Neutered, Intact.

String name name

A name used to identify the non-human individual. Typically used only when the individual is a pet or a beast of burden. Examples include "Spot", "Fido", "Seattle Slew". Note that this property is typically not used when the subject is a lower order organism or a stock animal.
"Contains one or more of the names of the patient.... For animals, if a Name Type of "R" is used, use "Name Context" to identify the authority with which the animal's name is registered." - HL7 Version 2.8, PID-5.
"A name associated with the individual." - HL7 FHIR, Patient.name
"Used if required by the PDMP for prescriptions written by a veterinarian and the pharmacist has access to this information at the time of preparing the prescription." - ASAP Standard for PDMP, PAT23: Name of Animal

«CS» Code organismTaxon organismTaxon

A categorization of non-human biological entities. Possible values include canine, German Shepherd, staphylococcus aureus, etc.
Note that breed is no longer a stand-alone concept, as this information is included in the SNOMED species hierarchy. Thus, this property handles both species and breed, and the separate breed property was removed.

"The species of living organism. This may include the common or scientific name, based on the coding system(s) used. SNOMED is the recommended coding system." - HL7 Version 2.8, PID-35.
"The specific breed of animal. This field, unlike Species and Strain is specific to animals and cannot be generally used for all living organisms. SNOMED is the recommended coding system." - HL7 Version 2.8, PID-36.
"Identifies the high level taxonomic categorization of the kind of animal." - HL7 FHIR, Patient.animal.species.
"Identifies the detailed categorization of the kind of animal." - HL7 FHIR, Patient.animal.breed.
"Used if required by the PDMP to differentiate a prescription for an individual from one prescribed for an animal." - ASAP Standard for PDMP, PAT20: Species Code

String primaryIntent primaryIntent

"The primary use for which the living subject was bred or grown." - HL7 Version 2.8, PID-38.

Attributes inherited from FHIM::Person::BiologicalEntity FHIM::Person::BiologicalEntity
age age, ageAtDeath ageAtDeath, ageGroup ageGroup, asPatient asPatient, biologicalSex biologicalSex, causeOfDeath causeOfDeath, dateOfBirth dateOfBirth, dateOfDeath dateOfDeath, isDeceased isDeceased, isOrganDonor isOrganDonor, multipleBirthOrder multipleBirthOrder, wasMultipleBirth wasMultipleBirth

Attributes inherited from FHIM::Person::Entity FHIM::Person::Entity
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameAnimal
Name Expression
NamespacePerson
Owned Template Signature
OwnerPerson
Owning Template Parameter
PackagePerson
Qualified NameFHIM::Person::Animal
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 isNeutered
Public «BL» NullableBoolean isNeutered

Indicates whether the animal has been altered such that they cannot procreate. Note that information that the animal has been neutered can also be modeled in a clinical domain as a procedure or observation, however it is captured in this domain as a simple property.
"Indicates the current state of the animal's reproductive organs." - HL7 FHIR, Patient.animal.genderStatus. Note that FHIR models this concept as a code with values Neutered, Intact.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnimal
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisNeutered
Name Expression
NamespaceAnimal
Opposite
OwnerAnimal
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::Animal::isNeutered
Stereotype
Template Parameter
Type«BL» NullableBoolean
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

A name used to identify the non-human individual. Typically used only when the individual is a pet or a beast of burden. Examples include "Spot", "Fido", "Seattle Slew". Note that this property is typically not used when the subject is a lower order organism or a stock animal.
"Contains one or more of the names of the patient.... For animals, if a Name Type of "R" is used, use "Name Context" to identify the authority with which the animal's name is registered." - HL7 Version 2.8, PID-5.
"A name associated with the individual." - HL7 FHIR, Patient.name
"Used if required by the PDMP for prescriptions written by a veterinarian and the pharmacist has access to this information at the time of preparing the prescription." - ASAP Standard for PDMP, PAT23: Name of Animal

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnimal
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namename
Name Expression
NamespaceAnimal
Opposite
OwnerAnimal
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::Animal::name
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 organismTaxon
Public «CS» Code organismTaxon

A categorization of non-human biological entities. Possible values include canine, German Shepherd, staphylococcus aureus, etc.
Note that breed is no longer a stand-alone concept, as this information is included in the SNOMED species hierarchy. Thus, this property handles both species and breed, and the separate breed property was removed.

"The species of living organism. This may include the common or scientific name, based on the coding system(s) used. SNOMED is the recommended coding system." - HL7 Version 2.8, PID-35.
"The specific breed of animal. This field, unlike Species and Strain is specific to animals and cannot be generally used for all living organisms. SNOMED is the recommended coding system." - HL7 Version 2.8, PID-36.
"Identifies the high level taxonomic categorization of the kind of animal." - HL7 FHIR, Patient.animal.species.
"Identifies the detailed categorization of the kind of animal." - HL7 FHIR, Patient.animal.breed.
"Used if required by the PDMP to differentiate a prescription for an individual from one prescribed for an animal." - ASAP Standard for PDMP, PAT20: Species Code

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnimal
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameorganismTaxon
Name Expression
NamespaceAnimal
Opposite
OwnerAnimal
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::Animal::organismTaxon
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 primaryIntent
Public String primaryIntent

"The primary use for which the living subject was bred or grown." - HL7 Version 2.8, PID-38.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnimal
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameprimaryIntent
Name Expression
NamespaceAnimal
Opposite
OwnerAnimal
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::Animal::primaryIntent
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic