Person
Class BiologicalEntity

This class represents an organism, whether it is currently alive or not. This class is equivalent to the HL7 V3 Living Subject class.

Attributes
«PQ» TimeQuantity age age

The length of time that an organism has lived. Note that this property will typically be derived or calculated as needed, and as such may not always be present as a separate concept. Added 7/8/10 for vMR.

«PQ» TimeQuantity ageAtDeath ageAtDeath

The length of time that a now-deceased organism had lived. Note that this property will typically be derived or calculated as needed, and as such may not always be present as a separate concept. Added 11/23/2010 for Problem List.

String ageGroup ageGroup

This is a user-defined property that categorizes a person or animal entity based on their age. The strata used to classify the entity vary according to the purpose of use, therefore this property is derived and ought never be considered outside the context of the stratification.

Patient asPatient asPatient

Pointer to the role of a person or animal as a recipient of health care services from a healthcare provider. Note that if the person or animal is a research subject, a different association (asResearchSubject) is used.

«CS» Code biologicalSex biologicalSex

The sex of a living subject. Note that the biological sex is different from administrative gender which is defined for administrative purposes. This attribute reflects the karyotypic sex of the patient, regardless of whether sexual organs may have been altered. For example, a neutered dog will still have the same underlying chromosomes.
"Sex assigned at birth." - PCORnet Common Data Model, Demographic.Sex. Possible values include: Ambiguous, Female, Male, No information, Unknown, Other.

CauseOfDeath causeOfDeath causeOfDeath

A pointer to zero or more Cause Of Death instances that provide information on the condition(s) that caused or contributed to the death of the organism.

«TS» PointInTime dateOfBirth dateOfBirth

The date (and, optionally, time) of the birth or hatching of the living subject.

"The patient's date and time of birth." - HL7 Version 2.8, PID-7.
"The next of kin/associated party's birth date and time." - HL7 Version 2.8, NK1-16.
"The birth date for the person." - HL7 FHIR, Person.birthDate.
"The date of birth for the individual." - HL7 FHIR, Patient.birthDate.
"The date of birth for the practitioner." - HL7 FHIR, Practitioner.birthDate
"Date patient was born." - ASAP Standard for PDMP, PAT18: Date of Birth
"Date of birth." -     , Demographic.Birth_Date
"Time of birth." - PCORnet Common Data Model, Demographic.Birth_Time
"A date a person was born." - NIEM Core, PersonBirthDate

«TS» PointInTime dateOfDeath dateOfDeath

This property contains the date (and optionally time) that the subject died. If the date of death is known, the isDeceased property should be set to true. However, in some cases it might only be known that the subject is deceased while the actual date of death might be unknown, so it is possible that the isDeceased property could be true even though this dateOfDeath property is empty.

"Contains the date and time at which the patient death occurred." - HL7 Version 2.8, PID-29.
"Indicates if the individual is deceased or not." - HL7 FHIR, Patient.deceased[x]. Note that FHIR has a single concept with a choice of datatypes (dateTime or boolean), thus FHIR handles both the dateOfDeath and isDeceased concepts in a single field. The FHIM separates these two into separate properties.
"A date a person died or was declared legally dead." NIEM PersonDeathDate

Boolean isDeceased isDeceased

This property indicates whether or not the subject is deceased. Among other uses, this field (as an alternative to examining the date of death) is often used to quickly separate living patients from dead ones. If the date of death is known, this field could be calculated on the basis of whether the date of death is filled in. However, in some cases it might only be known that the patient is deceased while the actual date of death might be unknown. Therefore this property is not modeled as a calculated field, but can be manually populated.

"Indicates whether the patient is deceased." - HL7 Version 2.8, PID-30.
"Indicates if the individual is deceased or not." - HL7 FHIR, Patient.deceased[x]. Note that FHIR has a single concept with a choice of datatypes (dateTime or boolean), thus FHIR handles both the dateOfDeath and isDeceased concepts in a single field. The FHIM separates these two into separate properties.
"True if a person is alive; false if a person is dead." NIEM PersonLivingIndicator

Boolean isOrganDonor isOrganDonor

Indicates whether the patient has consented to be an organ donor upon their demise.

Integer multipleBirthOrder multipleBirthOrder

If the biological entity was born along with other siblings, this property indicates the order the entity was born. For example, for a set of twins, this property indicates which twin was born first and which was born second. This property is primarily used to distinguish records for newborn infants who have not yet have been given names. This property may also be used in research situations to distinguish individuals who were part of a multi-child pregnancy.
"When a patient was part of a multiple birth, a value (number) indicating the patient's birth order is entered in this field." - HL7 Version 2.8, PID-25.
"Indicates whether the patient is part of a multiple or indicates the actual birth order." - HL7 FHIR, Patient.multipleBirth[x]. Note that FHIR has a single concept with a choice of datatypes (boolean or integer), thus FHIR handles both the multipleBirthOrder and wasMultipleBirth concepts in a single field. The FHIM separates these two into separate properties.

Boolean wasMultipleBirth wasMultipleBirth

This property serves as an indication as to whether the person was born along with other siblings as part of a single pregnancy. This property is primarily used to distinguish records for newborn infants who have not yet have been given names. This property may also be used in research situations to distinguish individuals who were part of a multi-child pregnancy.
"Indicates whether the patient was part of a multiple birth." - HL7 Version 2.8, PID-24.
"Indicates whether the patient is part of a multiple or indicates the actual birth order." - HL7 FHIR, Patient.multipleBirth[x]. Note that FHIR has a single concept with a choice of datatypes (boolean or integer), thus FHIR handles both the multipleBirthOrder and wasMultipleBirth concepts in a single field. The FHIM separates these two into separate properties.

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

Properties:

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

Attribute Details

 age
Public «PQ» TimeQuantity age

The length of time that an organism has lived. Note that this property will typically be derived or calculated as needed, and as such may not always be present as a separate concept. Added 7/8/10 for vMR.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameage
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::age
Stereotype
Template Parameter
Type«PQ» TimeQuantity
Upper1
Upper Value(1)
VisibilityPublic


 ageAtDeath
Public «PQ» TimeQuantity ageAtDeath

The length of time that a now-deceased organism had lived. Note that this property will typically be derived or calculated as needed, and as such may not always be present as a separate concept. Added 11/23/2010 for Problem List.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameageAtDeath
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::ageAtDeath
Stereotype
Template Parameter
Type«PQ» TimeQuantity
Upper1
Upper Value(1)
VisibilityPublic


 ageGroup
Public String ageGroup

This is a user-defined property that categorizes a person or animal entity based on their age. The strata used to classify the entity vary according to the purpose of use, therefore this property is derived and ought never be considered outside the context of the stratification.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameageGroup
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::ageGroup
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 asPatient
Public Patient asPatient

Pointer to the role of a person or animal as a recipient of health care services from a healthcare provider. Note that if the person or animal is a research subject, a different association (asResearchSubject) is used.

Constraints:
Properties:

AggregationNone
Alias
AssociationbiologicalEntity_asPatient
Association End
ClassBiologicalEntity
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquefalse
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameasPatient
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::asPatient
Stereotype
Template Parameter
TypePatient
Upper*
Upper Value(*)
VisibilityPublic


 biologicalSex
Public «CS» Code biologicalSex

The sex of a living subject. Note that the biological sex is different from administrative gender which is defined for administrative purposes. This attribute reflects the karyotypic sex of the patient, regardless of whether sexual organs may have been altered. For example, a neutered dog will still have the same underlying chromosomes.
"Sex assigned at birth." - PCORnet Common Data Model, Demographic.Sex. Possible values include: Ambiguous, Female, Male, No information, Unknown, Other.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NamebiologicalSex
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::biologicalSex
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 causeOfDeath
Public CauseOfDeath causeOfDeath

A pointer to zero or more Cause Of Death instances that provide information on the condition(s) that caused or contributed to the death of the organism.

Constraints:
Properties:

AggregationNone
Alias
AssociationcauseOfDeathListEntry_causeOfDeath
Association End
ClassBiologicalEntity
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)
Multiplicity*
NamecauseOfDeath
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::causeOfDeath
Stereotype
Template Parameter
TypeCauseOfDeath
Upper*
Upper Value(*)
VisibilityPublic


 dateOfBirth
Public «TS» PointInTime dateOfBirth

The date (and, optionally, time) of the birth or hatching of the living subject.

"The patient's date and time of birth." - HL7 Version 2.8, PID-7.
"The next of kin/associated party's birth date and time." - HL7 Version 2.8, NK1-16.
"The birth date for the person." - HL7 FHIR, Person.birthDate.
"The date of birth for the individual." - HL7 FHIR, Patient.birthDate.
"The date of birth for the practitioner." - HL7 FHIR, Practitioner.birthDate
"Date patient was born." - ASAP Standard for PDMP, PAT18: Date of Birth
"Date of birth." -     , Demographic.Birth_Date
"Time of birth." - PCORnet Common Data Model, Demographic.Birth_Time
"A date a person was born." - NIEM Core, PersonBirthDate

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NamedateOfBirth
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::dateOfBirth
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateOfDeath
Public «TS» PointInTime dateOfDeath

This property contains the date (and optionally time) that the subject died. If the date of death is known, the isDeceased property should be set to true. However, in some cases it might only be known that the subject is deceased while the actual date of death might be unknown, so it is possible that the isDeceased property could be true even though this dateOfDeath property is empty.

"Contains the date and time at which the patient death occurred." - HL7 Version 2.8, PID-29.
"Indicates if the individual is deceased or not." - HL7 FHIR, Patient.deceased[x]. Note that FHIR has a single concept with a choice of datatypes (dateTime or boolean), thus FHIR handles both the dateOfDeath and isDeceased concepts in a single field. The FHIM separates these two into separate properties.
"A date a person died or was declared legally dead." NIEM PersonDeathDate

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NamedateOfDeath
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::dateOfDeath
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 isDeceased
Public Boolean isDeceased

This property indicates whether or not the subject is deceased. Among other uses, this field (as an alternative to examining the date of death) is often used to quickly separate living patients from dead ones. If the date of death is known, this field could be calculated on the basis of whether the date of death is filled in. However, in some cases it might only be known that the patient is deceased while the actual date of death might be unknown. Therefore this property is not modeled as a calculated field, but can be manually populated.

"Indicates whether the patient is deceased." - HL7 Version 2.8, PID-30.
"Indicates if the individual is deceased or not." - HL7 FHIR, Patient.deceased[x]. Note that FHIR has a single concept with a choice of datatypes (dateTime or boolean), thus FHIR handles both the dateOfDeath and isDeceased concepts in a single field. The FHIM separates these two into separate properties.
"True if a person is alive; false if a person is dead." NIEM PersonLivingIndicator

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NameisDeceased
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::isDeceased
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isOrganDonor
Public Boolean isOrganDonor

Indicates whether the patient has consented to be an organ donor upon their demise.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NameisOrganDonor
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::isOrganDonor
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 multipleBirthOrder
Public Integer multipleBirthOrder

If the biological entity was born along with other siblings, this property indicates the order the entity was born. For example, for a set of twins, this property indicates which twin was born first and which was born second. This property is primarily used to distinguish records for newborn infants who have not yet have been given names. This property may also be used in research situations to distinguish individuals who were part of a multi-child pregnancy.
"When a patient was part of a multiple birth, a value (number) indicating the patient's birth order is entered in this field." - HL7 Version 2.8, PID-25.
"Indicates whether the patient is part of a multiple or indicates the actual birth order." - HL7 FHIR, Patient.multipleBirth[x]. Note that FHIR has a single concept with a choice of datatypes (boolean or integer), thus FHIR handles both the multipleBirthOrder and wasMultipleBirth concepts in a single field. The FHIM separates these two into separate properties.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NamemultipleBirthOrder
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::multipleBirthOrder
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 wasMultipleBirth
Public Boolean wasMultipleBirth

This property serves as an indication as to whether the person was born along with other siblings as part of a single pregnancy. This property is primarily used to distinguish records for newborn infants who have not yet have been given names. This property may also be used in research situations to distinguish individuals who were part of a multi-child pregnancy.
"Indicates whether the patient was part of a multiple birth." - HL7 Version 2.8, PID-24.
"Indicates whether the patient is part of a multiple or indicates the actual birth order." - HL7 FHIR, Patient.multipleBirth[x]. Note that FHIR has a single concept with a choice of datatypes (boolean or integer), thus FHIR handles both the multipleBirthOrder and wasMultipleBirth concepts in a single field. The FHIM separates these two into separate properties.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassBiologicalEntity
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
NamewasMultipleBirth
Name Expression
NamespaceBiologicalEntity
Opposite
OwnerBiologicalEntity
Owning Association
Owning Template Parameter
Qualified NameFHIM::Person::BiologicalEntity::wasMultipleBirth
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic