| Person UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
A role of a person or animal as a recipient of health care services from a healthcare provider."Demographics and other administrative information about an individual or animal receiving care or other health-related services." - HL7 FHIR, Patient
Attributes | ||
AssignedFacility | assignedFacility |
Pointer to organization location which has been assigned to or elected by the Patient in order to schedule care. |
AssignedProvider | assignedProvider |
Pointer to clinician who has been assigned to or elected by the Patient for certain responsibilities. This relationship will typically be used to identify the patient's Primary Care Physician in outpatient situations or the Attending Physician in inpatient situations."Patient's nominated care provider." - HL7 FHIR, Patient.generalPractitioner |
«TS» PointInTime | beginDate |
The first date upon which the Person or Animal was a Patient of the associated Healthcare Provider. |
AbstractEncounter | encounter | |
«TS» PointInTime | endDate |
The last date upon which the Person or Animal was a Patient of the associated Healthcare Provider. For inactive patients, particularly in outpatient situations, this date is often not known. Each organization will set its own rules regarding when a patient is no longer considered active, often if they have not seen nor heard from the patient in over a year. |
HealthRecord | healthRecord |
Pointer to records regarding the Patient's healthcare that are subject to the consent rules in Consent Directives. |
ImplantedDevice | implantedDevice |
Pointer to any Devices that were implanted in the Patient (including those that may have been later explanted). |
OrganizationalProvider | managingOrganization |
Pointer to the Healthcare Provider that has established a Patient record for the Person or Animal being treated. Note that the Patient class represents a Role that the Person or Animal is playing; the Healthcare Provider is "scoping" that role. A single Person will have multiple Patient roles with different Healthcare Providers, and may have more than one with the same Provider, especially in in-patient settings."Organization that is the custodian of the patient record." - HL7 FHIR, Patient.managingOrganization. |
«II» Id | mothersIdentifier |
A unique identifer for the person's mother."This field is used, for example, as a link field for newborns. Typically a patient ID or account number may be used. This field can contain multiple identifiers for the same mother." - HL7 Version 2.8, PID-21. |
«II» Id | patientId |
A unique identifier for the Person or Animal while in the role of Patient. Note that the patient Id is assigned by the Healthcare Provider (organization), and that the Id data type includes an assigning authority component which identifies the organization that assigned the id. A single Person will typically have multiple patient Ids; one at each organization which considers that Person a Patient."Contains the list of identifiers (one or more) used by the healthcare facility to uniquely identify a patient (e.g., medical record number, billing number, birth registry, national unique individual identifier, etc.)." - HL7 Version 2.8, PID-3."An identifier for this patient." - HL7 FHIR, Patient.identifier."Arbitrary person-level identifier used to link across tables." - PCORnet Common Data Model, Demographic.PatId |
«CS» Code | status |
Indicates the state of the Patient Role instance. This property is used, among other purposes, to determine whether the Patient should be included in a particular population, such as the "denominator" for various quality-reporting criteria. Possible values are Active, Inactive-Moved or gone elsewhere, Inactive-Lost to follow up, Inactive-Unspecified, Inactive-Permanently. Note that the preceeding four Inactive states correspond to the V3 Terminated state.Note that for public health reporting purposes, this status indicates the active/inactive status of the patient at the provider site level. See MIROW “Management of Moved or Gone Elsewhere (MOGE) and Other Patient Status Designations in IIS guidelines."Whether this patient record is in active use." - HL7 FHIR, Patient.active. Note that FHIR has a boolean field indicating that the patient is active or not, while the FHIM has a more expressive set of statuses. A FHIM value of Active would correspond to true in FHIR, while all of the Inactive status types would correspond to a false in FHIR. When migrating from FHIR to FHIM, a false would translate to Inactive-Unspecified. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | true |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Patient |
Name Expression | |
Namespace | Person |
Owned Template Signature | |
Owner | Person |
Owning Template Parameter | |
Package | Person |
Qualified Name | FHIM::Person::Patient |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public AssignedFacility assignedFacility
Pointer to organization location which has been assigned to or elected by the Patient in order to schedule care.
Aggregation | None |
Alias | |
Association | patient_assignedFacility |
Association End | |
Class | Patient |
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 | * |
Name | assignedFacility |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::assignedFacility |
Stereotype | |
Template Parameter | |
Type | AssignedFacility |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public AssignedProvider assignedProvider
Pointer to clinician who has been assigned to or elected by the Patient for certain responsibilities. This relationship will typically be used to identify the patient's Primary Care Physician in outpatient situations or the Attending Physician in inpatient situations."Patient's nominated care provider." - HL7 FHIR, Patient.generalPractitioner
Aggregation | None |
Alias | |
Association | patient_assignedProvider |
Association End | |
Class | Patient |
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 | * |
Name | assignedProvider |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::assignedProvider |
Stereotype | |
Template Parameter | |
Type | AssignedProvider |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime beginDate
The first date upon which the Person or Animal was a Patient of the associated Healthcare Provider.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Patient |
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 | beginDate |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::beginDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public AbstractEncounter encounter
Aggregation | None |
Alias | |
Association | patient_encounter |
Association End | |
Class | Patient |
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 | * |
Name | encounter |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::encounter |
Stereotype | |
Template Parameter | |
Type | AbstractEncounter |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime endDate
The last date upon which the Person or Animal was a Patient of the associated Healthcare Provider. For inactive patients, particularly in outpatient situations, this date is often not known. Each organization will set its own rules regarding when a patient is no longer considered active, often if they have not seen nor heard from the patient in over a year.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Patient |
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 | endDate |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::endDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public HealthRecord healthRecord
Pointer to records regarding the Patient's healthcare that are subject to the consent rules in Consent Directives.
Aggregation | None |
Alias | |
Association | patient_healthRecord |
Association End | |
Class | Patient |
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 | * |
Name | healthRecord |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::healthRecord |
Stereotype | |
Template Parameter | |
Type | HealthRecord |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public ImplantedDevice implantedDevice
Pointer to any Devices that were implanted in the Patient (including those that may have been later explanted).
Aggregation | None |
Alias | |
Association | patient_implantedDevice |
Association End | |
Class | Patient |
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 | * |
Name | implantedDevice |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::implantedDevice |
Stereotype | |
Template Parameter | |
Type | ImplantedDevice |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public OrganizationalProvider managingOrganization
Pointer to the Healthcare Provider that has established a Patient record for the Person or Animal being treated. Note that the Patient class represents a Role that the Person or Animal is playing; the Healthcare Provider is "scoping" that role. A single Person will have multiple Patient roles with different Healthcare Providers, and may have more than one with the same Provider, especially in in-patient settings."Organization that is the custodian of the patient record." - HL7 FHIR, Patient.managingOrganization.
Aggregation | None |
Alias | |
Association | healthcareProvider_patient |
Association End | |
Class | Patient |
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 | managingOrganization |
Name Expression | |
Namespace | Patient |
Opposite | patient |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::managingOrganization |
Stereotype | |
Template Parameter | |
Type | OrganizationalProvider |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «II» Id mothersIdentifier
A unique identifer for the person's mother."This field is used, for example, as a link field for newborns. Typically a patient ID or account number may be used. This field can contain multiple identifiers for the same mother." - HL7 Version 2.8, PID-21.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Patient |
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 | * |
Name | mothersIdentifier |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::mothersIdentifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id patientId
A unique identifier for the Person or Animal while in the role of Patient. Note that the patient Id is assigned by the Healthcare Provider (organization), and that the Id data type includes an assigning authority component which identifies the organization that assigned the id. A single Person will typically have multiple patient Ids; one at each organization which considers that Person a Patient."Contains the list of identifiers (one or more) used by the healthcare facility to uniquely identify a patient (e.g., medical record number, billing number, birth registry, national unique individual identifier, etc.)." - HL7 Version 2.8, PID-3."An identifier for this patient." - HL7 FHIR, Patient.identifier."Arbitrary person-level identifier used to link across tables." - PCORnet Common Data Model, Demographic.PatId
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Patient |
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 | patientId |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::patientId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
Indicates the state of the Patient Role instance. This property is used, among other purposes, to determine whether the Patient should be included in a particular population, such as the "denominator" for various quality-reporting criteria. Possible values are Active, Inactive-Moved or gone elsewhere, Inactive-Lost to follow up, Inactive-Unspecified, Inactive-Permanently. Note that the preceeding four Inactive states correspond to the V3 Terminated state.Note that for public health reporting purposes, this status indicates the active/inactive status of the patient at the provider site level. See MIROW “Management of Moved or Gone Elsewhere (MOGE) and Other Patient Status Designations in IIS guidelines."Whether this patient record is in active use." - HL7 FHIR, Patient.active. Note that FHIR has a boolean field indicating that the patient is active or not, while the FHIM has a more expressive set of statuses. A FHIM value of Active would correspond to true in FHIR, while all of the Inactive status types would correspond to a false in FHIR. When migrating from FHIR to FHIM, a false would translate to Inactive-Unspecified.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Patient |
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 | status |
Name Expression | |
Namespace | Patient |
Opposite | |
Owner | Patient |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Person::Patient::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Person UML Documentation |
Summary:AttributesProperties | Detail:Attributes |