| Person UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
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 |
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 |
"The primary use for which the living subject was bred or grown." - HL7 Version 2.8, PID-38. |
Attributes inherited from FHIM::Person::BiologicalEntity | ||
age, ageAtDeath, ageGroup, asPatient, biologicalSex, causeOfDeath, dateOfBirth, dateOfDeath, isDeceased, isOrganDonor, multipleBirthOrder, wasMultipleBirth |
Attributes inherited from FHIM::Person::Entity | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Animal |
Name Expression | |
Namespace | Person |
Owned Template Signature | |
Owner | Person |
Owning Template Parameter | |
Package | Person |
Qualified Name | FHIM::Person::Animal |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Animal |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isNeutered |
Name Expression | |
Namespace | Animal |
Opposite | |
Owner | Animal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Animal::isNeutered |
Stereotype | |
Template Parameter | |
Type | «BL» NullableBoolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Animal |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | name |
Name Expression | |
Namespace | Animal |
Opposite | |
Owner | Animal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Animal::name |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Animal |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | organismTaxon |
Name Expression | |
Namespace | Animal |
Opposite | |
Owner | Animal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Animal::organismTaxon |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String primaryIntent
"The primary use for which the living subject was bred or grown." - HL7 Version 2.8, PID-38.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Animal |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | primaryIntent |
Name Expression | |
Namespace | Animal |
Opposite | |
Owner | Animal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Animal::primaryIntent |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Person UML Documentation |
Summary:AttributesProperties | Detail:Attributes |