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

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

## Resource Profile: Dunedin Hospital Outpatient Update profile

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

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

Dunedin Hospital outpatient update profile

Usages:

- Examples for this Profile: Patient/DHOutpatientUpdateExample
- CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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: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
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
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
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
telecom | S C | 1..* | 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.
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)
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
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.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 |

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:ethnicity |  | 0..0 |  |
identifier | S | 1..* | Identifier | An identifier for this patient
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
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI | S | 0..1 | Identifier | An identifier for this patient
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
name |  | 0..0 |  |
telecom | S | 1..* | 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 |  | 0..0 |  |
birthDate |  | 0..0 |  |
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
communication |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

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: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
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
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 | ?!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
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)
identifier:NHI | S Σ | 0..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 | ?!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
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
telecom | S C | 1..* | 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)
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
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
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.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|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 |

This structure is derived from NzPatient

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 21 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.multipleBirth[x]

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: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
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
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
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
telecom | S C | 1..* | 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.
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)
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
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.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 |

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:ethnicity |  | 0..0 |  |
identifier | S | 1..* | Identifier | An identifier for this patient
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
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI | S | 0..1 | Identifier | An identifier for this patient
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
name |  | 0..0 |  |
telecom | S | 1..* | 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 |  | 0..0 |  |
birthDate |  | 0..0 |  |
Slices for deceased[x] |  |  |  | Content/Rules for all slices
deceased[x]:deceasedBoolean |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
communication |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

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: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
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
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 | ?!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
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)
identifier:NHI | S Σ | 0..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 | ?!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
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
telecom | S C | 1..* | 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)
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
Slices for multipleBirth[x] |  | 0..1 | integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
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.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|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 |

This structure is derived from NzPatient

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 21 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Patient.multipleBirth[x]

Other representations of profile: CSV, Excel, Schematron