Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

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

Resource Profile: NZCentralRegionAllergyIntolerance - Mappings

Active as of 2024-09-17

Mappings for the NZCentralRegionAllergyIntolerance resource profile.

Mappings for Central Region Message Specification (1.14) (https://standards.digital.health.nz/ns/central-region/hl7-v2)

Central Region Message Specification (1.14) - Allergy Intolerance from ADT^031 ZAL where Alert Type field `ZAL-2.1` with values from [Allergy Alert Category](./ValueSet-nzcr-allergy-alert-category-vs.html) codes.

NZCentralRegionAllergyIntolerance
AllergyIntolerance
      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
   extension (allergy-alert)
      extension
      extension (webPASCategory)
         url'webPASCategory'
         value[x]
            system'https://standards.digital.health.nz/ns/central-region/alert-category'
            codeZAL-2.1
            displayZAL-2.2
      extension (severityLevel)
         url'severityLevel'
         value[x]ZAL-6

TODO: severityLevel should be integer

      extension (allergyReaction)
         url'allergyReaction'
               system'https://standards.digital.health.nz/ns/central-region/allergy-reaction-a3-a4' or 'https://standards.digital.health.nz/ns/central-region/allergy-reaction-h1-h3'
               codeZAL-4.1

Note: can be NP for Not Present when field ZAL-4.1 is missing

               displayZAL-4.2

Note: can be Not Present when field ZAL-4.1 is missing

      extension (inactiveDate)
         url'inactiveDate'
         value[x]ZAL-8

Note: ISO-8601 date format includes dashes

      extension (reviewDate)
         url'reviewDate'
         value[x]ZAL-7

Note: ISO-8601 date format includes dashes

      extension (lastUpdatedBy)
         url'lastUpdatedBy'
         value[x]ZAL-12.1 + ' - ' + ZAL-12.2

Not to be confused with Recorder

      extension (lastUpdatedDateTime)
         url'lastUpdatedDateTime'
         value[x]ZAL-11

Note: ISO-8601 datetime format includes dashes, colons, 'T' and '+12:00' timezone

      extension (recordingHospital)
         url'recordingHospital'
               system'https://standards.digital.health.nz/fhir/central-region/hospital-code'
               codeZAL-13.1
               displayZAL-13.2
      url'https://standards.digital.health.nz/ns/central-region/alert'
   identifier
      use'usual'
      system'https://standards.digital.health.nz/ns/central-region/pas-alert-id'
      valuePID-3.1 + '-' + ZAL2.1 + '-' + ZAL-3.1

Concatenation of PatientId, Alert Category and Alert Code

   clinicalStatus
      coding
         system'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical'
         codeZAL-5 & ZAL-9

if ZAL-5 is in the past AND ZAL-9 is in the future or empty

**then** 'active'

**else** 'inactive'
         displayZAL-5 & ZAL-9

if ZAL-5 is in the past AND ZAL-9 is in the future or empty

**then** 'Active'

**else** 'Inactive'
   verificationStatus
      coding
         system'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification'
         code'confirmed'

No info available for any other coding

         display'Confirmed'
   typeallergy | intolerance

ConceptMap translation from ZAL-4.1 - nzcr-allergy-type-map

Default Value: 'allergy' when field ZAL-4 is missing

Note: not coding, so no system or display sub-fields

   categoryfood | medication | environment | biologic

ConceptMap translation from ZAL-4.1 - nzcr-allergy-category-map

Default Value: when field ZAL-4 is missing

  • 'medication' if ZAL-2.1 is H1
  • 'environment' if ZAL-2.1 is H3

Note: not coding, so no system or display sub-fields

   criticalitylow | high | unable-to-assess

ConceptMap translation from ZAL-4.1 - nzcr-allergy-criticality-map

Default Value: 'unable-to-assess' when field ZAL-4 is missing

Note: not coding, so no system or display sub-fields

   code
      coding
         system 

One of:

  • https://standards.digital.health.nz/ns/central-region/allergy-alert-code-a3
  • https://standards.digital.health.nz/ns/central-region/allergy-alert-code-a4
  • https://standards.digital.health.nz/ns/central-region/allergy-alert-code-h1
  • https://standards.digital.health.nz/ns/central-region/allergy-alert-code-h3

depending upon value of ZAL-2.1

         codeZAL-3.1
         displayZAL-3.2
   patient
      reference 

read-only field

      type'Patient'
      identifier 

Select the NHI identifier from the list provided; where PID-3.4.2 = 2.16.840.1.113883.2.18.2

         use'usual'
         type
            coding
               system'http://terminology.hl7.org/CodeSystem/v2-0203'
               code'MR'
               display'Medical record number'
         system'https://standards.digital.health.nz/ns/nhi-id'
         valuePID-3.1
      displayPID-5.1 + ', ' + PID-5.2 + ' ' + PID-5.3 + ' ' + PID-5.5
   onset[x]
   onset[x] (onsetDateTime)ZAL-5

if there is no ZAL-9 value to complete onsetPeriod Note: ISO-8601 datetime format includes dashes, colons, 'T' and '+12:00' timezone

   onset[x] (onsetPeriod)
      startZAL-5

only if there is ZAL-9 value to complete Period Note: ISO-8601 datetime format includes dashes, colons, 'T' and '+12:00' timezone

      endZAL-9
   recorder
      reference 

read-only field

      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'
         valueZAL-10.1
      displayZAL-10.2 + ', ' + ZAL-10.3 + ' ' + ZAL-10.4 + ' ' + ZAL-10.5
   note
      textZAL-14