New Zealand NES IG
1.4.10 - Release

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

Resource Profile: NES Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NesPatient Version: 1.4.10
Active as of 2025-04-08 Computable Name: NesPatient

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

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NzPatient 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from NzPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NzPatient
... 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 0..0
.... identifier:NHI 0..0
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NzPatient 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
... 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
... 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 BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from NzPatient

Summary

Prohibited: 22 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NzPatient 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Differential View

This structure is derived from NzPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NzPatient
... 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 0..0
.... identifier:NHI 0..0
... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* NzPatient 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
... 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
... 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 BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from NzPatient

Summary

Prohibited: 22 elements

 

Other representations of profile: CSV, Excel, Schematron