Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.4 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Dunedin Hospital Outpatient Get Patient Profile

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOutpatient | Version: 0.0.2
Active as of 2025-12-11 | Computable Name: DHOutpatient

This profile derives from the Patient Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

Describe the Dunedin Hospital Outpatient resource profile

Usages:

- Examples for this Profile: Patient/DHO-outpatient-instance, Patient/DHO-sipics-alex-morgan, Patient/DHO-sipics-curious-george and Patient/DHO-sipics-emily-white

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.

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen |  | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb |  | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code |  | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho |  | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth |  | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi |  | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address |  | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
identifier:NHI | S Σ | 0..1 | Identifier | An identifier for this patient
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
Slices for extension |  | 0..0 |  |
use | ?!S Σ | 1..1 | code | one of: usual / old Binding: NameUse (required): The use of a human name.
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | S C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Slices for extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:genderOriginalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
birthDate | S Σ | 1..1 | date | The date of birth for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb | S | 0..1 | string | NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code | S | 0..1 | (Complex) | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
coding | S Σ | 0..1 | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
extension:country-name |  | 0..1 | string | The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use | ?!S Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 1..1 | code | PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line | S Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 0..1 | string | Postal code for area Example General: 9132
country | S Σ | 0..1 | string | Should be the ISO 3166 code
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
extension |  | 0..0 |  |
text | S Σ | 1..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | S | 0..* | ContactPoint | A contact detail for the person
extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier:NHI.use | required | NHIUse `https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code`
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.extension:domicile-code.value[x] | preferred | DomicileCode `https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code`
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`
Patient.contact.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.contact.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() |
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()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
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 NzPatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | NzPatient | Information about an individual or animal receiving health care services
meta |  |  |  |
tag |  | 1..* | Coding | Correlation-id where the record is sourced
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
contained |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
identifier | S | 1..* | Identifier | An identifier for this patient
id |  | 0..0 |  |
extension |  | 0..1 | Extension | Extension
use | S | 1..1 | code | usual | official | temp | secondary | old (If known)
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
period |  | 0..0 |  |
assigner |  | 0..0 |  |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI | S | 0..1 | Identifier | An identifier for this patient
id |  | 0..0 |  |
extension |  | 0..1 | Extension | Extension
use | S | 1..1 | code | usual | official | temp | secondary | old (If known)
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
period |  | 0..0 |  |
assigner |  | 0..0 |  |
name | S | 1..* | HumanName | A name associated with the patient
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..0 |  |
use | S | 1..1 | code | one of: usual / old
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 0..* | string | Given names (not always 'first'). Includes middle names
prefix | S | 0..* | string | Parts that come before the name
suffix |  | 0..0 |  |
telecom | S | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.)
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:cp-purpose |  | 0..0 |  |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point
period |  | 0..0 |  |
gender | S | 1..1 | code | male | female | other | unknown
birthDate | S | 1..1 | date | The date of birth for the individual
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean |  | 0..0 |  |
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:suburb | S | 0..1 | Suburb | NZ Suburb
extension:domicile-code | S | 0..1 | Domicile_code | NZ Domicile Code
id |  | 0..0 |  |
value[x] |  |  |  |
coding | S | 0..1 | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version |  | 0..0 |  |
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
userSelected |  | 0..0 |  |
use | S | 1..1 | code | home | work | temp | old | billing - purpose of this address
type | S | 1..1 | code | PHYSICAL | POSTAL
text |  | 0..0 |  |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc.
city | S | 0..1 | string | Name of city, town etc.
district |  | 0..0 |  |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S | 0..1 | string | Postal code for area
country | S | 0..1 | string | Should be the ISO 3166 code
period |  | 0..0 |  |
photo |  | 0..0 |  |
contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
id |  | 0..0 |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
text | S | 1..1 | string | Text representation of the full name
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 0..* | string | Given names (not always 'first'). Includes middle names
prefix | S | 0..1 | string | Parts that come before the name
suffix |  | 0..0 |  |
telecom | S | 0..* | ContactPoint | A contact detail for the person
id |  | 0..0 |  |
extension |  | 0..0 |  |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point
period |  | 0..0 |  |
address |  | 0..0 |  |
gender |  | 0..0 |  |
organization |  | 0..0 |  |
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..0 |  |
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 1..* | Coding | Correlation-id where the record is sourced Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ethnicity |  | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen |  | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb |  | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code |  | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho |  | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth |  | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi |  | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address |  | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
identifier:NHI | S Σ | 0..1 | Identifier | An identifier for this patient
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
Slices for extension |  | 0..0 |  |
use | ?!S Σ | 1..1 | code | one of: usual / old Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Slices for extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..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)
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderOriginalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value |  | 0..1 | string | Primitive value for code
birthDate | S Σ | 1..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value |  | 0..1 | dateTime | Primitive value for dateTime
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb | S | 0..1 | string | NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code | S | 0..1 | (Complex) | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..1 | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
text | Σ | 0..1 | string | Plain text representation of the concept
extension:country-name |  | 0..1 | string | The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use | ?!S Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 1..1 | code | PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line | S Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 0..1 | string | Postal code for area Example General: 9132
country | S Σ | 0..1 | string | Should be the ISO 3166 code
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 |
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
extension |  | 0..0 |  |
text | S Σ | 1..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S | 0..* | ContactPoint | A contact detail for the person
extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..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 | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Patient.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags` From the FHIR Standard
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.identifier:NHI.use | required | NHIUse `https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code`
Patient.identifier:NHI.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.extension:domicile-code.value[x] | preferred | DomicileCode `https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code`
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`
Patient.contact.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.contact.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() |
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()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
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 NzPatient

Summary

Mandatory: 9 elements(14 nested mandatory elements)
Must-Support: 44 elements
Prohibited: 40 elements

Structures

This structure refers to these other structures:

- Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
- Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
- PractitionerRole resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.2.0
- https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen |  | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb |  | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code |  | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho |  | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth |  | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi |  | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address |  | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
identifier:NHI | S Σ | 0..1 | Identifier | An identifier for this patient
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
Slices for extension |  | 0..0 |  |
use | ?!S Σ | 1..1 | code | one of: usual / old Binding: NameUse (required): The use of a human name.
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | S C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Slices for extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:genderOriginalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
birthDate | S Σ | 1..1 | date | The date of birth for the individual
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb | S | 0..1 | string | NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code | S | 0..1 | (Complex) | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
coding | S Σ | 0..1 | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
extension:country-name |  | 0..1 | string | The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use | ?!S Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 1..1 | code | PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line | S Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 0..1 | string | Postal code for area Example General: 9132
country | S Σ | 0..1 | string | Should be the ISO 3166 code
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
extension |  | 0..0 |  |
text | S Σ | 1..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom | S | 0..* | ContactPoint | A contact detail for the person
extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier:NHI.use | required | NHIUse `https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code`
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.extension:domicile-code.value[x] | preferred | DomicileCode `https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code`
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`
Patient.contact.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.contact.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() |
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()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
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() |

Differential View

This structure is derived from NzPatient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | NzPatient | Information about an individual or animal receiving health care services
meta |  |  |  |
tag |  | 1..* | Coding | Correlation-id where the record is sourced
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
contained |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
identifier | S | 1..* | Identifier | An identifier for this patient
id |  | 0..0 |  |
extension |  | 0..1 | Extension | Extension
use | S | 1..1 | code | usual | official | temp | secondary | old (If known)
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
period |  | 0..0 |  |
assigner |  | 0..0 |  |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI | S | 0..1 | Identifier | An identifier for this patient
id |  | 0..0 |  |
extension |  | 0..1 | Extension | Extension
use | S | 1..1 | code | usual | official | temp | secondary | old (If known)
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
period |  | 0..0 |  |
assigner |  | 0..0 |  |
name | S | 1..* | HumanName | A name associated with the patient
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:information-source |  | 0..0 |  |
use | S | 1..1 | code | one of: usual / old
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 0..* | string | Given names (not always 'first'). Includes middle names
prefix | S | 0..* | string | Parts that come before the name
suffix |  | 0..0 |  |
telecom | S | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.)
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:cp-purpose |  | 0..0 |  |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point
period |  | 0..0 |  |
gender | S | 1..1 | code | male | female | other | unknown
birthDate | S | 1..1 | date | The date of birth for the individual
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean |  | 0..0 |  |
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:suburb | S | 0..1 | Suburb | NZ Suburb
extension:domicile-code | S | 0..1 | Domicile_code | NZ Domicile Code
id |  | 0..0 |  |
value[x] |  |  |  |
coding | S | 0..1 | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version |  | 0..0 |  |
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
userSelected |  | 0..0 |  |
use | S | 1..1 | code | home | work | temp | old | billing - purpose of this address
type | S | 1..1 | code | PHYSICAL | POSTAL
text |  | 0..0 |  |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc.
city | S | 0..1 | string | Name of city, town etc.
district |  | 0..0 |  |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S | 0..1 | string | Postal code for area
country | S | 0..1 | string | Should be the ISO 3166 code
period |  | 0..0 |  |
photo |  | 0..0 |  |
contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
id |  | 0..0 |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
text | S | 1..1 | string | Text representation of the full name
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 0..* | string | Given names (not always 'first'). Includes middle names
prefix | S | 0..1 | string | Parts that come before the name
suffix |  | 0..0 |  |
telecom | S | 0..* | ContactPoint | A contact detail for the person
id |  | 0..0 |  |
extension |  | 0..0 |  |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
use | S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point
period |  | 0..0 |  |
address |  | 0..0 |  |
gender |  | 0..0 |  |
organization |  | 0..0 |  |
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..0 |  |
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services Constraints: nz-pat-1
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 1..* | Coding | Correlation-id where the record is sourced Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ethnicity |  | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen |  | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb |  | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code |  | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho |  | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth |  | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi |  | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation |  | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address |  | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required |  | 0..1 | boolean | Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
identifier:NHI | S Σ | 0..1 | Identifier | An identifier for this patient
extension |  | 0..1 | Extension | Extension Slice: Unordered, Open by value:url
use | ?!S Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ | 1..* | HumanName | A name associated with the patient
Slices for extension |  | 0..0 |  |
use | ?!S Σ | 1..1 | code | one of: usual / old Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Slices for extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..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)
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:genderOriginalText |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value |  | 0..1 | string | Primitive value for code
birthDate | S Σ | 1..1 | date | The date of birth for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value |  | 0..1 | date | Primitive value for date
Slices for deceased[x] | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:information-source |  | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value |  | 0..1 | dateTime | Primitive value for dateTime
address | S | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb | S | 0..1 | string | NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code | S | 0..1 | (Complex) | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..1 | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
text | Σ | 0..1 | string | Plain text representation of the concept
extension:country-name |  | 0..1 | string | The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use | ?!S Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 1..1 | code | PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line | S Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 0..1 | string | Postal code for area Example General: 9132
country | S Σ | 0..1 | string | Should be the ISO 3166 code
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 |
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:role |  | 0..* | CodeableConcept | HNZ Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship |  | 0..* | CodeableConcept | The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name | S | 1..1 | HumanName | A name associated with the contact person
extension |  | 0..0 |  |
text | S Σ | 1..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 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 | S Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S | 0..* | ContactPoint | A contact detail for the person
extension |  | 0..0 |  |
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 1..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 | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner |  | 0..* | Reference(Organization resource for use in NZ | Practitioner resource for use in NZ | PractitionerRole resource for use in NZ) | Patient's nominated primary care provider
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` From the FHIR Standard
Patient.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags` From the FHIR Standard
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.identifier:NHI.use | required | NHIUse `https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code`
Patient.identifier:NHI.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.extension:domicile-code.value[x] | preferred | DomicileCode `https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code`
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | required | PersonalRelationshipRoleType `http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType|3.0.0`
Patient.contact.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.contact.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() |
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()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
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 NzPatient

Summary

Mandatory: 9 elements(14 nested mandatory elements)
Must-Support: 44 elements
Prohibited: 40 elements

Structures

This structure refers to these other structures:

- Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
- Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
- PractitionerRole resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.2.0
- https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-patient-contact-role-extension-id

Other representations of profile: CSV, Excel, Schematron