HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release
HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release
HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPatient | Version: 1.0.0 | |||
| Active as of 2023-12-04 |
Realm: 
|
Computable Name: NzPatient | ||
The base New Zealand Patient profile
Describe the Base New Zealand Patient resource profileI
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Path | Conformance | ValueSet |
| Patient.identifier:NHI.use | required | NHIUse |
| Id | Grade | Path(s) | Details | Requirements |
| nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | C | 0..* | Patient | 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 | 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 (L4) (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) | |
| acc-patient-occupation | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example) | |
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| nz-residency | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | |
 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: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 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
 telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
 deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |
| address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
 link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
 type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.identifier:NHI.use | required | NHIUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | Patient | 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 (L4) (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) | |||||
| acc-patient-occupation | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example) | |||||
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| nz-residency | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | |||||
| 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: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 | ||||
| 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) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | Σ | 0..* | HumanName | A name associated with the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full 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 | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderOriginalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
 multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| 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 | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| 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 | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier:NHI.use | required | NHIUse | ||||
| Patient.identifier:NHI.type | extensible | Identifier Type Codes | ||||
| Patient.name.use | required | NameUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
This structure is derived from Patient
Summary
Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Path | Conformance | ValueSet |
| Patient.identifier:NHI.use | required | NHIUse |
| Id | Grade | Path(s) | Details | Requirements |
| nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | Patient | 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 | 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 (L4) (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) | |
| acc-patient-occupation | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example) | |
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| nz-residency | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | |
| 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: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 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |
| address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.identifier:NHI.use | required | NHIUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| nz-pat-1 | error | Patient | only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | Patient | 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 (L4) (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) | |||||
| acc-patient-occupation | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example) | |||||
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| nz-residency | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | |||||
| 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: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 | ||||
| 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) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | Σ | 0..* | HumanName | A name associated with the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full 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 | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderOriginalText | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text | |||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| value | 0..1 | date | Primitive value for date | |||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| information-source | 0..1 | CodeableConcept | Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred) | |||||
| value | 0..1 | dateTime | Primitive value for dateTime | |||||
| address | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| 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 | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| 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.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| 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 | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier:NHI.use | required | NHIUse | ||||
| Patient.identifier:NHI.type | extensible | Identifier Type Codes | ||||
| Patient.name.use | required | NameUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
This structure is derived from Patient
Summary
Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
