New Zealand NHI IG
0.2.0 - CI Build

New Zealand NHI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/nhi/ and changes regularly. See the Directory of published versions

Resource Profile: CommonPatient

The base Patient resource in NZ. Slices on identifer for NHI numbers (current & old), uses nzAddress and adds sme commonly used extensions

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/CommonPatient

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of pattern:use (Open at End)

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
... birth-place 0..1(Complex)Where the person was born
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
... nz-residency-status 0..1CodeableConceptIs the person a NZ resident
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... sex-at-birth 0..1CodeableConceptThe sex that the patient was at birth. Considered immutable.
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
... identifier 0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI S0..1IdentifierThe persons current NHI number
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
.... identifier:dormantNHI S0..*IdentifierNHI numbers that have been deprecated
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity I0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
... birth-place I0..1(Complex)Where the person was born
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
... patient-iwi I0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/patient-iwi
... nz-residency-status I0..1CodeableConceptIs the person a NZ resident
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
... nz-citizenship I0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... sex-at-birth I0..1CodeableConceptThe sex that the patient was at birth. Considered immutable.
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣI0..1IdentifierThe persons current NHI number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantNHI SΣI0..*IdentifierNHI numbers that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name ΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientInformation about an individual or animal receiving health care services
... identifier:NHI ΣI0..1IdentifierThe persons current NHI number
... identifier:dormantNHI ΣI0..*IdentifierNHI numbers that have been deprecated

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of pattern:use (Open at End)

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
... birth-place 0..1(Complex)Where the person was born
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
... nz-residency-status 0..1CodeableConceptIs the person a NZ resident
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... sex-at-birth 0..1CodeableConceptThe sex that the patient was at birth. Considered immutable.
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
... identifier 0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI S0..1IdentifierThe persons current NHI number
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
.... identifier:dormantNHI S0..*IdentifierNHI numbers that have been deprecated
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
... address 0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity I0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
... birth-place I0..1(Complex)Where the person was born
URL: http://hl7.org.nz/fhir/StructureDefinition/birth-place
... patient-iwi I0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/patient-iwi
... nz-residency-status I0..1CodeableConceptIs the person a NZ resident
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
... nz-citizenship I0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... sex-at-birth I0..1CodeableConceptThe sex that the patient was at birth. Considered immutable.
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)An identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣI0..1IdentifierThe persons current NHI number
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantNHI SΣI0..*IdentifierNHI numbers that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/id/nhi
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name ΣI0..*HumanNameA name associated with the patient
... telecom ΣI0..*ContactPointA contact detail for the individual
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address I0..*CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship I0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name I0..1HumanNameA name associated with the contact person
.... telecom I0..*ContactPointA contact detail for the person
.... address I0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication I0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner I0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.identifier:NHI.userequiredFixed Value: official
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
Patient.identifier:dormantNHI.userequiredFixed Value: old
Patient.identifier:dormantNHI.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType

Constraints

IdPathDetailsRequirements
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()