New Zealand NHI IG
0.1.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.1.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: NHI Patient

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/NhiPatient
Version:0.1.0
Name:NhiPatient
Title:NHI Patient
Status:Active as of 2020-11-25T23:02:28+00:00
Definition:

The Patient resource exposed by the NHI.

Publisher:David Hay
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 4 elements
Prohibited: 8 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.deceased[x] is sliced based on the value of type:$this

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... active 0..0
... name 1..*HumanNameA name associated with the patient
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... originalText 0..1stringOriginal Text that represents the data as seen/selected/uttered originally
URL: http://hl7.org/fhir/StructureDefinition/originalText
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
... deceased[x] 0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
... deceasedDateTime 0..1dateTimeIndicates if the individual is deceased or not
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
... address 1..*NhiAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 1..*stringStreet name, number, direction & P.O. Box etc.
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..*Reference(PractitionerRole)Patient's nominated primary care provider
... managingOrganization 0..0
... link 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for this patient
... name Σ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... originalText 0..1stringOriginal Text that represents the data as seen/selected/uttered originally
URL: http://hl7.org/fhir/StructureDefinition/originalText
.... value 0..1stringPrimitive value for code
... birthDate Σ1..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeIndicates if the individual is deceased or not
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
..... value 0..1dateTimePrimitive value for dateTime
... address 1..*NhiAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
.... not-validated-address-reason 0..1CodeableConceptThe reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated reason (preferred)
.... is-primary-address 0..1booleanIf true, this is the primary address
URL: http://hl7.org.nz/fhir/StructureDefinition/is-primary-address
.... nhi-address-derived 0..1(Complex)Elements that are directly derived from the address
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ1..*stringStreet 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 Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... generalPractitioner 0..*Reference(PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 4 elements
Prohibited: 8 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.deceased[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... active 0..0
... name 1..*HumanNameA name associated with the patient
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... originalText 0..1stringOriginal Text that represents the data as seen/selected/uttered originally
URL: http://hl7.org/fhir/StructureDefinition/originalText
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
... deceased[x] 0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
... deceasedDateTime 0..1dateTimeIndicates if the individual is deceased or not
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
... address 1..*NhiAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 1..*stringStreet name, number, direction & P.O. Box etc.
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..*Reference(PractitionerRole)Patient's nominated primary care provider
... managingOrganization 0..0
... link 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for this patient
... name Σ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... originalText 0..1stringOriginal Text that represents the data as seen/selected/uttered originally
URL: http://hl7.org/fhir/StructureDefinition/originalText
.... value 0..1stringPrimitive value for code
... birthDate Σ1..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1(Slice Definition)Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedDateTime ?!Σ0..1dateTimeIndicates if the individual is deceased or not
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... information-source 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/information-source
Binding: InformationSource (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/information-source"
...... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: InformationSource (required)
..... value 0..1dateTimePrimitive value for dateTime
... address 1..*NhiAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
.... not-validated-address-reason 0..1CodeableConceptThe reason an address was not validated
URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Binding: Address Not Validated reason (preferred)
.... is-primary-address 0..1booleanIf true, this is the primary address
URL: http://hl7.org.nz/fhir/StructureDefinition/is-primary-address
.... nhi-address-derived 0..1(Complex)Elements that are directly derived from the address
URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ1..*stringStreet 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 Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... generalPractitioner 0..*Reference(PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.name.extension:information-source.value[x]:valueCodeableConceptrequiredInformationSource
Patient.name.userequiredNameUse
Patient.genderrequiredAdministrativeGender
Patient.birthDate.extension:information-source.value[x]:valueCodeableConceptrequiredInformationSource
Patient.deceased[x]:deceasedDateTime.extension:information-source.value[x]:valueCodeableConceptrequiredInformationSource
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType