New Zealand ICP Implementation Guide
1.0.0 - release
New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-patient | Version: 1.0.0 | |||
Active as of 2022-11-20 | Computable Name: IcpPatient | |||
Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved. |
The ACC ICP Patient resource based on NzPatient. Used to verify that an ICP Case has a valid claim.
An ICP Patient resource is used within an Icp Case, as a data point to verify weither an Icp case has a valid claim
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | NzPatient | |||
identifier | 0..* | Identifier | An identifier for this patient | |
period | 0..0 | |||
Slices for identifier | Content/Rules for all slices | |||
identifier:NHI | 0..* | Identifier | An identifier for this patient | |
period | 0..0 | |||
active | 0..0 | |||
name | ||||
text | 0..0 | |||
period | 0..0 | |||
birthDate | C | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future |
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
ethnicity | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
nzCitizen | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
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 | |
domicile-code | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |
sex-at-birth | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) | |
iwi | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
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 . |
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
birthDate | ΣC | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
ethnicity | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |||||
nzCitizen | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |||||
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 | |||||
domicile-code | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |||||
pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |||||
sex-at-birth | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) | |||||
iwi | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | 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 Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:NHI | Σ | 0..* | 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 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
name | Σ | 0..* | HumanName | A name associated with the 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | ΣC | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future | ||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.identifier:NHI.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://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 | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
This structure is derived from NzPatient
Differential View
This structure is derived from NzPatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | NzPatient | |||
identifier | 0..* | Identifier | An identifier for this patient | |
period | 0..0 | |||
Slices for identifier | Content/Rules for all slices | |||
identifier:NHI | 0..* | Identifier | An identifier for this patient | |
period | 0..0 | |||
active | 0..0 | |||
name | ||||
text | 0..0 | |||
period | 0..0 | |||
birthDate | C | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future |
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
managingOrganization | 0..0 | |||
link | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
ethnicity | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |
nzCitizen | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |
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 | |
domicile-code | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |
pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |
sex-at-birth | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) | |
iwi | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
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 . |
identifier:NHI | Σ | 0..* | Identifier | An identifier for this patient |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id |
birthDate | ΣC | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
ethnicity | 0..* | CodeableConcept | NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred) | |||||
nzCitizen | 0..1 | (Complex) | Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship | |||||
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 | |||||
domicile-code | 0..1 | CodeableConcept | NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred) | |||||
pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |||||
sex-at-birth | 0..1 | CodeableConcept | Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required) | |||||
iwi | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | 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 Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:NHI | Σ | 0..* | 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 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
name | Σ | 0..* | HumanName | A name associated with the 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | ΣC | 1..1 | date | The date of birth for the individual date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). date-not-in-future-invariant: The date value cannot be in the future | ||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
Patient.identifier:NHI.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://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 | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
date-invariant | error | Patient.birthDate | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
date-not-in-future-invariant | error | Patient.birthDate | The date value cannot be in the future : $this <= today() |
This structure is derived from NzPatient
Other representations of profile: CSV, Excel, Schematron