Personal Health Device Implementation Guide
3.0.0-ballot - STU 3 Ballot Global (Whole world)

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-ballot 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

Resource Profile: PhdPatient

Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdPatient Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 * 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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.text 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
Patient.contained 0..* Resource Contained, inline Resources
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding This element is included in summaries. 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:v2Coding.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:v2Coding.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.system This element is included in summaries. 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
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if/when the individual is deceased
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Patient.identifier:v2Coding.​use Base required IdentifierUse 📍6.0.0-snapshot1 FHIR Std.

Identifies the purpose for this identifier, if known .

Patient.identifier:v2Coding.​type Base extensible Identifier Type Codes 📍6.0.0-snapshot1 FHIR Std.

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5
Patient.link.type Base required Link Type 📍6.0.0-snapshot1 FHIR Std.

The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

Constraints

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())

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.type
Patient.Slices for identifier.identifier:v2Coding.type.coding 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.system 0..1 uri The system associated with the value. For XDS.b this would be the enterprise identifier (an OID).

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.text 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
Patient.contained 0..* Resource Contained, inline Resources
Patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding This element is included in summaries. 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:v2Coding.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:v2Coding.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:v2Coding.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Patient.Slices for identifier.identifier:v2Coding.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:v2Coding.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:v2Coding.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:v2Coding.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:v2Coding.value This element is included in summaries. C 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:v2Coding.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:v2Coding.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if/when the individual is deceased
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.contact.relationship 0..* CodeableConcept The kind of personal relationship
Binding: PersonalRelationshipRoleType (preferred): The nature of the personal relationship between the patient and the contact person.
Patient.contact.role 0..* CodeableConcept The kind of functional role
Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person.
Patient.contact.name C 0..1 HumanName A name associated with the contact person
Patient.contact.additionalName 0..* HumanName Additional names for the contact person
Patient.contact.telecom C 0..* ContactPoint A contact detail for the person
Patient.contact.address C 0..1 Address Address for the contact person
Patient.contact.additionalAddress 0..* Address Additional addresses for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.communication.language 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
Additional BindingsPurpose
CommonLanguages Starter
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Patient.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Patient.identifier:v2Coding.​use Base required IdentifierUse 📍6.0.0-snapshot1 FHIR Std.

Identifies the purpose for this identifier, if known .

Patient.identifier:v2Coding.​type Base extensible Identifier Type Codes 📍6.0.0-snapshot1 FHIR Std.

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5
Patient.gender Base required AdministrativeGender 📍6.0.0-snapshot1 FHIR Std.

The gender of a person used for administrative purposes.

Patient.maritalStatus Base extensible Marital Status Codes 📍6.0.0-snapshot1 FHIR Std.

The domestic partnership status of a person.

Patient.contact.relationship Base preferred PersonalRelationshipRoleType 📦3.0.0 THO v7.5

The nature of the personal relationship between the patient and the contact person.

Patient.contact.role Base preferred Patient Relationship Type 📍6.0.0-snapshot1 FHIR Std.

The nature of the personal relationship between the patient and the contact person.

Patient.contact.gender Base required AdministrativeGender 📍6.0.0-snapshot1 FHIR Std.

The gender of a person used for administrative purposes.

Patient.communication.​language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Patient.link.type Base required Link Type 📍6.0.0-snapshot1 FHIR Std.

The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

Constraints

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()

This structure is derived from Patient

Summary

Mandatory: 0 element(1 nested mandatory element)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.text 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
Patient.contained 0..* Resource Contained, inline Resources
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding This element is included in summaries. 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:v2Coding.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:v2Coding.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.system This element is included in summaries. 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
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if/when the individual is deceased
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Patient.identifier:v2Coding.​use Base required IdentifierUse 📍6.0.0-snapshot1 FHIR Std.

Identifies the purpose for this identifier, if known .

Patient.identifier:v2Coding.​type Base extensible Identifier Type Codes 📍6.0.0-snapshot1 FHIR Std.

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5
Patient.link.type Base required Link Type 📍6.0.0-snapshot1 FHIR Std.

The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

Constraints

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.type
Patient.Slices for identifier.identifier:v2Coding.type.coding 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.system 0..1 uri The system associated with the value. For XDS.b this would be the enterprise identifier (an OID).

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual or animal receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Patient.text 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
Patient.contained 0..* Resource Contained, inline Resources
Patient.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
Patient.Slices for identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type.coding.system
Patient.Slices for identifier.identifier:v2Coding This element is included in summaries. 0..1 Identifier Code defined by http://terminology.hl7.org/CodeSystem/v2-0203
Patient.Slices for identifier.identifier:v2Coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:v2Coding.type This element is included in summaries. 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.
Patient.Slices for identifier.identifier:v2Coding.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: hl7VS-identifierType (required)
Patient.Slices for identifier.identifier:v2Coding.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:v2Coding.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:v2Coding.type.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 (extensions allowed)
Patient.Slices for identifier.identifier:v2Coding.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:v2Coding.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Patient.Slices for identifier.identifier:v2Coding.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:v2Coding.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:v2Coding.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:v2Coding.system This element is included in summaries. 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
Patient.Slices for identifier.identifier:v2Coding.value This element is included in summaries. C 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:v2Coding.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:v2Coding.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if/when the individual is deceased
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.contact.relationship 0..* CodeableConcept The kind of personal relationship
Binding: PersonalRelationshipRoleType (preferred): The nature of the personal relationship between the patient and the contact person.
Patient.contact.role 0..* CodeableConcept The kind of functional role
Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person.
Patient.contact.name C 0..1 HumanName A name associated with the contact person
Patient.contact.additionalName 0..* HumanName Additional names for the contact person
Patient.contact.telecom C 0..* ContactPoint A contact detail for the person
Patient.contact.address C 0..1 Address Address for the contact person
Patient.contact.additionalAddress 0..* Address Additional addresses for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.communication.language 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
Additional BindingsPurpose
CommonLanguages Starter
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
Patient.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Patient.identifier:v2Coding.​use Base required IdentifierUse 📍6.0.0-snapshot1 FHIR Std.

Identifies the purpose for this identifier, if known .

Patient.identifier:v2Coding.​type Base extensible Identifier Type Codes 📍6.0.0-snapshot1 FHIR Std.

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Patient.identifier:v2Coding.​type.coding Base required hl7VS-identifierType 📦3.0.0 THO v7.5
Patient.gender Base required AdministrativeGender 📍6.0.0-snapshot1 FHIR Std.

The gender of a person used for administrative purposes.

Patient.maritalStatus Base extensible Marital Status Codes 📍6.0.0-snapshot1 FHIR Std.

The domestic partnership status of a person.

Patient.contact.relationship Base preferred PersonalRelationshipRoleType 📦3.0.0 THO v7.5

The nature of the personal relationship between the patient and the contact person.

Patient.contact.role Base preferred Patient Relationship Type 📍6.0.0-snapshot1 FHIR Std.

The nature of the personal relationship between the patient and the contact person.

Patient.contact.gender Base required AdministrativeGender 📍6.0.0-snapshot1 FHIR Std.

The gender of a person used for administrative purposes.

Patient.communication.​language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

Patient.link.type Base required Link Type 📍6.0.0-snapshot1 FHIR Std.

The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

Constraints

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()

This structure is derived from Patient

Summary

Mandatory: 0 element(1 nested mandatory element)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Notes:

PHG created Patient Resource

The PHG SHALL use a Patient.identifier supplied by the server when one is provided.§29 If the server does not provide an identifier, the PHG SHALL generate an implementation-dependent identifier whose value is unique within its assigning system.§30

  • The type for a PHG-generated patient identifier SHOULD use a suitable code from the HL7 v2-0203 coding system.§31 The PHG could use MR when the patient's medical record number is known to the PHG, or U when it generates an implementation-dependent unique identifier.

Examples:

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.