Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
| Active as of 2024-09-17 |
Mappings for the NZCentralRegionPatient resource profile.
Central Region Message Specification (1.14) - Patient from ADT^031
| NZCentralRegionPatient | ||
| Patient | Patient | |
| extension | ||
| extension (hl7v2Message) | ||
| url | 'https://standards.digital.health.nz/ns/central-region/hl7-message' | |
| value[x] | Entire incoming HL7 message | Base64 encoded |
| extension (process-timestamp) | ||
| extension (source-event-trigger) | ||
| extension (source-record-type) | ||
| extension (source-record-id) | ||
| extension (source-data-mode-version) | ||
| extension (process-client-id) | ||
| extension (l4h-template-version) | ||
| extension (ethnicity) | PID-22, PID-10 | Repeat for each entry in PID-22. Two coding entries, one each for
|
| url | 'http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity' | |
| value[x] (valueCodeableConcept) | ||
| system | https://standards.digital.health.nz/ns/ethnic-group-level-4-code and https://standards.digital.health.nz/ns/ethnic-group-level-2-code | |
| code | PID-22.1 | Which is group-level-2; lookup required for group-level-4. ConceptMap ? |
| display | PID-22.2 | Check for macrons in Māori and Cook Island Māori |
| extension (nzCitizen) | PID-26 | Only using status, source not available |
| extension | ||
| extension (status) | ||
| url | 'status' | |
| value[x] (valueCodeableConcept) | ||
| coding | ||
| system | https://standards.digital.health.nz/ns/nz-citizenship-status-code | |
| code | PID-26.1 | if PID-26.1 = 'Y' then 'yes*' elif PID-26.1='N' then 'no' else 'unknown' |
| display | PID-26.1 | if PID-26.1 = 'Y' then 'Yes' elif PID-26.1='N' then 'No' else 'Unknown' |
| url | 'http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship' | |
| extension (dhb) | - | Not used, as no suitable ConceptMap available |
| url | 'http://hl7.org.nz/fhir/StructureDefinition/dhb' | Not used, as no suitable ConceptMap available |
| coding | ||
| system | https://standards.digital.health.nz/ns/dhb-code | Not used, as no suitable ConceptMap available |
| code | PID-12 | one-to-many mapping from PID-12. Perhaps with ConceptMap ?? |
| display | ||
| extension (domicile-code) | ||
| url | 'http://hl7.org.nz/fhir/StructureDefinition/domicile-code' | |
| value[x] (valueCodeableConcept) | ||
| coding | ||
| system | https://standards.digital.health.nz/ns/domicile-code | |
| code | PID-12 | |
| display | ||
| extension (nzcrEthnicity) | ||
| coding | ||
| system | ||
| code | ||
| display | ||
| coding (level2) | ||
| system | ||
| code | ||
| display | ||
| coding (level4) | ||
| system | ||
| code | ||
| display | ||
| extension (nzcrResidency) | PID-28 | Only using status, source not available |
| extension (status) | ||
| url | 'status' | |
| coding | Repeat for each coding | |
| system | https://standards.digital.health.nz/ns/central-region/nz-residency-code AND https://standards.digital.health.nz/ns/nz-residency-code | |
| code | PID-28.1 | Raw value and mapped from webPAS residency status |
| display | PID-28.2 | Raw value and mapped from webPAS residency status. |
| coding (nzBase) | ||
| system | ||
| code | ||
| display | ||
| coding (rawSource) | ||
| system | ||
| code | ||
| display | ||
| url | 'http://hl7.org.nz/fhir/StructureDefinition/nz-residency' | |
| extension (nzcrReligion) | ||
| url | 'http://hl7.org/fhir/StructureDefinition/patient-religion' | |
| coding | Repeat for each coding | Some codes don't map - eg: Ratana, No Religion, Refused to Answer, etc. |
| system | https://standards.digital.health.nz/ns/central-region/patient-religion AND http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation | |
| code | PID-17.1 | Raw value and mapped from webPAS religion codes |
| display | PID-17.2 | Appropriate value from code lookup |
| coding (origFhir) | ||
| system | ||
| code | ||
| display | ||
| coding (rawSource) | ||
| system | ||
| code | ||
| display | ||
| extension (interpreterRequired) | ||
| url | 'http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired' | |
| value[x] | PID-15.4 | if PID-15.4='Y' then 'true' else 'false' |
| identifier | if PID-3.4.2 != '2.16.840.1.113883.2.18.2' | |
| use | 'temp' | if PID-3.4.2 != '2.16.840.1.113883.2.18.2' |
| type | ||
| coding | ||
| system | 'http://terminology.hl7.org/CodeSystem/v2-0203' | |
| code | 'MR' | |
| display | 'Medical record number' | |
| system | 'https://standards.digital.health.nz/ns/central-region/pas-patient-id' | if PID-3.4.2 != '2.16.840.1.113883.2.18.2' |
| value | PID-3.1 | |
| identifier (NHI) | if PID-3.4.2 == '2.16.840.1.113883.2.18.2' | |
| use | 'usual' | if PID-3.4.2 == '2.16.840.1.113883.2.18.2' |
| type | as above | |
| system | 'https://standards.digital.health.nz/ns/nhi-id' | if PID-3.4.2 == '2.16.840.1.113883.2.18.2' |
| value | PID-3.1 | |
| name | PID-5 and PID-9 | Repeat for PID-5 Patient Name and PID-9 Patient Aliases |
| use | 'usual' | 'old' | if mapping PID-5 then 'usual' elif mapping PID-9 then 'old' |
| text | PID-5.5 + ' ' + PID-5.2 + ' ' + PID-5.3 + ' ' + PID-5.1 or PID-9.5 + ' ' + PID-9.2 + ' ' + PID-9.3 + ' ' + PID-9.1 | |
| family | PID-5.1 or PID-9.1 | |
| given | PID-5.2 or PID-9.2 and PID-5.3 or PID-9.3 | PID-5.2 and PID-9.2 -> name.given[0] AND PID-5.3 and PID-9.3 -> name.given[1] Do NOT attempt to separate middle names |
| prefix | PID-5.5 or PID-9.5 | |
| telecom | PID-13 and PID-14 | Repeat for PID-13 and PID-14 |
| system | PID-13.3 or PID-14.3 | if 'PH' then 'phone' if 'FX' then 'fax' if 'CP' then 'sms' if 'BP' then 'pager' if 'NET' then 'email' Note: If only one phone entry with type 'CP' then use 'phone' |
| value | PID-13.1 or PID-14.1 | |
| use | 'home' | 'work' | if mapping PID-13 then 'home' elif mapping PID-14 then 'work' |
| gender | PID-8 | if PID-8 == 'F' then 'female' elif PID-8 == 'M' then 'male' elif PIF-8 == 'U' then 'unknown' |
| birthDate | PID-7 | |
| deceased[x] | ||
| deceased[x] (deceasedDateTime) | PID-29 | if known |
| deceased[x] (deceasedBoolean) | PID-30 | |
| address | ||
| extension (suburb) | ||
| url | 'http://hl7.org.nz/fhir/StructureDefinition/suburb' | |
| value[x] | PID-11.8 | if present |
| extension (domicile-code) | ||
| value[x] (valueCodeableConcept) | ||
| coding | ||
| system | ||
| code | ||
| display | ||
| use | ||
| type | 'physical' | 'postal' | if PID-11.7 == 'C' then 'physical' elif PID 11.7 == 'M' then 'postal' |
| line | PID-11.1 and PID-11.2 | if present, repeat as required |
| city | PID-11.3 | |
| state | PID-11.4 | if present |
| postalCode | PID-11.5 | if present |
| country | PID-11.6 | if present |
| maritalStatus | ||
| coding | ||
| system | http://terminology.hl7.org/CodeSystem/v3-MaritalStatus or http://terminology.hl7.org/CodeSystem/v3-NullFlavor | According to Marital Status Concept Map |
| code | PID-16.1 | |
| display | PID-16.2 | |
| contact | NK1 | Repeat for each NK1 segment |
| relationship | ||
| extension (contact-relationship) | ||
| system | https://standards.digital.health.nz/ns/central-region/contact-relationship | |
| code | NK1-3.1 | Raw value |
| display | NK1-3.2 | |
| coding | NK1 | |
| system | http://terminology.hl7.org/CodeSystem/v2-0131 | |
| code | C | |
| display | Emergency Contact | |
| name | ||
| text | NK1-2.5 + ' ' + NK1-2.1 + ' 'NK1-2.2 + ' | |
| family | NK1-2.1 | |
| given | NK1-2.2 | |
| prefix | NK1-2.5 | if present |
| telecom | NK1 | Repeat for NK1-5 and NK1-6 |
| system | NK1-5.3 or NK1-6.3 | if 'PH' then 'phone' if 'FX' then 'fax' if 'CP' then 'sms' if 'BP' then 'pager' if 'NET' then 'email' Note: If only one phone entry with type 'CP' then use 'phone' |
| value | NK1-5.1 or NK1-6.1 | |
| use | 'home' | 'work' | if mapping NK1-5 then 'home' elif mapping NK1-6 then 'work' |
| period | ||
| communication | ||
| language | ||
| coding | PID-15 | At least two codings:
|
| system | https://standards.digital.health.nz/ns/central-region/pas-language OR urn:ietf:bcp:47 | ietf:bcp:47 includes all iso-639 language codes; |
| code | PID-15.1 | Language Concept Map provides mapping from WebPAS raw code
Note: |
| display | PID-15.2 | |
| preferred | 'true' | PID-15 is by definition the patient's preferred language |
| generalPractitioner | PD1-4 | Lookup using PD1-4.1 (local identifier) ?? |
| reference | n/a | Internal GUID |
| type | 'Practitioner' | |
| identifier | ||
| use | 'usual' | |
| type | ||
| coding | Practitioner Identifiers are locally assigned within PAS | |
| system | 'http://terminology.hl7.org/CodeSystem/v2-0203' | |
| code | 'LR' | |
| display | 'Local registry ID' | |
| system | https://standards.digital.health.nz/ns/central-region/pas-practitioner-id | if PD1-4.9.2 == '2.16.840.1.113883.2.18.66.3.2.0' |
| value | PD1-4.1 | |
| display | PD1-4.2 + ', ' + PD1-4.3 + ' ' + PD1-4.4 + ' + PD1=4.6 | |
| link | ||
| other | ||
| type | ||
| identifier | ||
| type | ||