Personal Health Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 3.0.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdPatient | Version: 3.0.0-draft | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: PhdPatient | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.73.42.13 | |||||
The patient information reported from personal health gateways (PHG)
A Patient resource adhering to the PHD Patient Profile is used as a reference for most Observations. Dependent on the use case, the Patient resource may contain only minimal information sufficient to identify the patient resource on the server. It is also possible that the Patient resource is never uploaded by the PHG. In that case, the logical id to a Patient resource on the FHIR server must be provided to the PHG by some other means.
The PHD Patient Profile may or may not include patient-identifiable information, depending on the use case. For example, in Remote Patient Monitoring, PII/PHI protection may be critical, while in other cases, such as fitness tracking by a coach monitoring team performance. In such cases, protecting fitness data may not justify the associated effort and inconvenience. This profile supports both scenarios.
If a Patient resource is created by the PHG, only Patient.identifier.system, Patient.identifier.value, Patient.identifier.type.coding.code, and Patient.identifier.type.coding.system are required. The Patient.name element is optional, helping in PII/PHI protection since the required fields cannot be linked to a person without a dictionary that should only be available to the healthcare provider.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
?!Σ | 0..1 | Indicates if/when the individual is deceased | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:v2Coding.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system | |
![]() ![]() ![]() |
0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: hl7VS-identifierType (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:v2Coding.type.coding | Base | required | hl7VS-identifierType | 📦3.0.0 | THO v7.3 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: hl7VS-identifierType (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() |
?!Σ | 0..1 | Indicates if/when the individual is deceased | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of personal relationship Binding: PersonalRelationshipRoleType (preferred): The nature of the personal relationship between the patient and the contact person. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of functional role Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person. | |||||
![]() ![]() ![]() |
C | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() |
0..* | HumanName | Additional names for the contact person | |||||
![]() ![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() |
C | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() |
0..* | Address | Additional addresses for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.type.coding | Base | required | hl7VS-identifierType | 📦3.0.0 | THO v7.3 |
| Patient.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.contact.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3 |
| Patient.contact.role | Base | preferred | Patient Relationship Type | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization |
name.exists() or telecom.exists() or address.exists() or organization.exists()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
?!Σ | 0..1 | Indicates if/when the individual is deceased | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:v2Coding.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() |
0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system | |
![]() ![]() ![]() |
0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Binding: hl7VS-identifierType (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.identifier:v2Coding.type.coding | Base | required | hl7VS-identifierType | 📦3.0.0 | THO v7.3 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type.coding.system | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Code defined by http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Binding: hl7VS-identifierType (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The system associated with the value. For XDS.b this would be the enterprise identifier (an OID). Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() |
?!Σ | 0..1 | Indicates if/when the individual is deceased | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of personal relationship Binding: PersonalRelationshipRoleType (preferred): The nature of the personal relationship between the patient and the contact person. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of functional role Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person. | |||||
![]() ![]() ![]() |
C | 0..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() |
0..* | HumanName | Additional names for the contact person | |||||
![]() ![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() |
C | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() |
0..* | Address | Additional addresses for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.identifier:v2Coding.type.coding | Base | required | hl7VS-identifierType | 📦3.0.0 | THO v7.3 |
| Patient.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.contact.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3 |
| Patient.contact.role | Base | preferred | Patient Relationship Type | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.communication.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std. |
| Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Patient | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization |
name.exists() or telecom.exists() or address.exists() or organization.exists()
|
Other representations of profile: CSV, Excel, Schematron
A Patient resource for a known or an unknown patient shall be created by the PHG according to this profile. This implies:
Patient.identifier element from a known HL7 v2-0203 coding system.MR (Medical Record) code from this coding system may be used.Patient.identifier.value element shall contain a value that is unique for the patient in the context of the health care provider.An example of a PHD generated patient for a known patient is given here.
An example of a PHD generated patient for an unknown patient is given here.
These examples contain an optional name element.