Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: OHH Patient

Official URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-patient | Version: 0.1.0
Active as of 2025-12-03 | Computable Name: OhhPatient

Patient profile for ohh patient resources

Usages:

- Use this Profile: Encrypted Questionnaire Response Profile
- Refer to this Profile: Ohh Care Team Profile
- Examples for this Profile: Patient/patient

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
identifier |  | 1..* | Identifier | An identifier for this patient
type |  | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
name | S | 0..1 | HumanName | A name associated with the patient
text | S | 0..1 | string | Text representation of the full name
Slices for telecom | S | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
value | S | 0..1 | string | The actual contact point details
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 0..1 | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
Slices for telecom | S Σ | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())`
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 0..1 | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | S Σ | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | Address | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())`
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`
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: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

- https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.telecom

Differential View

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
identifier |  | 1..* | Identifier | An identifier for this patient
type |  | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
name | S | 0..1 | HumanName | A name associated with the patient
text | S | 0..1 | string | Text representation of the full name
Slices for telecom | S | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S | 0..1 | ContactPoint | A contact detail for the individual
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
value | S | 0..1 | string | The actual contact point details
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | An identifier for this patient
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 0..1 | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
Slices for telecom | S Σ | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())`
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:patientSignature | S | 0..1 | string | Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..* | Identifier | An identifier for this patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 0..1 | HumanName | A name associated with the patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
Slices for telecom | S Σ | 0..1 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email | S Σ | 0..1 | ContactPoint | A contact detail for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | S Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | Σ | 0..* | Address | An address for the individual
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name |  | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address |  | 0..1 | Address | Address for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Patient.identifier.type | Base | required | OHH Patient Identifier Type Value Set | 📦0.1.0 | This IG
Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Patient.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Patient.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.maritalStatus | Base | extensible | MaritalStatus | 📍4.0.1 | FHIR Std.
Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📍4.0.1 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Patient.communication.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std.

#### 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())`
exactly-one-official-program-patient | error | Patient | If there are multiple identifiers, exactly one must have use = 'official' | `identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
no-system-identifier-rules | error | Patient | Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT' | `identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())`
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: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

- https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.telecom

Other representations of profile: CSV, Excel, Schematron