New Zealand MWS IG
1.1.5 - Release

New Zealand MWS IG - Local Development build (v1.1.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Mws Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/MwsPatient | Version: 1.1.5
Active as of 2025-05-06 | Computable Name: MwsPatient

A minimal profile of NzPatient, containing just enough information to validate a patient's NHI for the purposes of MWS

Usage:

- Refer to this Resource Profile: MwsAllergyIntolerance

### 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
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient(2.0.0) | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management nz-pat-1: only a single official NHI
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  |  |  | Content/Rules for all slices
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier | Σ | 1..1 | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:NHI | Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/nhi-id
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.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

This structure is derived from NzPatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | NzPatient(2.0.0) |
language |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..0 |  |
extension:nzCitizen |  | 0..0 |  |
extension:dhb |  | 0..0 |  |
extension:domicile-code |  | 0..0 |  |
extension:pho |  | 0..0 |  |
extension:sex-at-birth |  | 0..0 |  |
extension:iwi |  | 0..0 |  |
identifier |  | 1..1 | Identifier | An identifier for this patient
system |  | 0..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI |  | 0..1 | Identifier | An identifier for this patient
active |  | 0..0 |  |
telecom |  | 0..0 |  |
gender |  | 0..0 |  |
deceased[x] |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient(2.0.0) | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: 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 | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NHI | Σ | 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 | ?!Σ | 0..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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
name | Σ | 0..* | HumanName | A name associated with the patient
birthDate | Σ | 0..1 | date | The date of birth for the individual
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
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.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.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

This structure is derived from NzPatient

Summary

Mandatory: 1 element
Fixed: 1 element
Prohibited: 20 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient(2.0.0) | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management nz-pat-1: only a single official NHI
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  |  |  | Content/Rules for all slices
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier | Σ | 1..1 | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices |  |  |  | Content/Rules for all slices
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:NHI | Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/nhi-id
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.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` from the FHIR Standard

Differential View

This structure is derived from NzPatient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  |  | NzPatient(2.0.0) |
language |  | 0..0 |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:ethnicity |  | 0..0 |  |
extension:nzCitizen |  | 0..0 |  |
extension:dhb |  | 0..0 |  |
extension:domicile-code |  | 0..0 |  |
extension:pho |  | 0..0 |  |
extension:sex-at-birth |  | 0..0 |  |
extension:iwi |  | 0..0 |  |
identifier |  | 1..1 | Identifier | An identifier for this patient
system |  | 0..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:NHI |  | 0..1 | Identifier | An identifier for this patient
active |  | 0..0 |  |
telecom |  | 0..0 |  |
gender |  | 0..0 |  |
deceased[x] |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | C | 0..* | NzPatient(2.0.0) | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 1..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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: 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 | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier:NHI | Σ | 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 | ?!Σ | 0..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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
name | Σ | 0..* | HumanName | A name associated with the patient
birthDate | Σ | 0..1 | date | The date of birth for the individual
communication |  | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
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.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.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

This structure is derived from NzPatient

Summary

Mandatory: 1 element
Fixed: 1 element
Prohibited: 20 elements

Other representations of profile: CSV, Excel, Schematron