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: NZCentralRegionFlag - Mappings

Active as of 2024-09-17

Mappings for the NZCentralRegionFlag 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) - Flag from ADT^031 ZAL where Alert Type field `ZAL-2.1` with values from [Flag Alert Code](./ValueSet-nzcr-flag-alert-code-vs.html) codes.

NZCentralRegionFlag
Flag
      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 (flag-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'
         value[x]ZAL-4.1

Optional field which is populated when ZAL-4.1 is present.
               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
               displayZAL-4.2
      extension (inactiveDate)
         url'inactiveDate'
         value[x]ZAL-8
      extension (reviewDate)
         url'reviewDate'
         value[x]ZAL-7
      extension (lastUpdatedBy)
         url'lastUpdatedBy'
         value[x]ZAL-12.1 + ' - ' + ZAL-12.2

Not to be confused with Author
      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/ns/central-region/hospital-code'
               codeZAL-13.1

if ZAL-13.1 is a recognised medical facility code
               displayZAL-13.2

if ZAL-13.1 is a recognised medical facility code
            text`ZAL-13.3` + ' defined code:' + `ZAL-13.1`

if ZAL-13.1 is not a recognised medical facility code
      extension (comments)
         url'comments'
         value[x]ZAL-14
      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
   statusZAL-5 & ZAL-9

if ZAL-5 is in the past AND ZAL-9 is in the future or empty then 'active' else 'inactive'
   categoryZAL-2, ZAL-2,

Repeat for each coding
      codingZAL-2

Repeat for each coding
         systemhttps://standards.digital.health.nz/ns/central-region/alert-category, http://terminology.hl7.org/CodeSystem/flag-category,
         codeZAL-2.1, ZAL-2.1,

Raw value and mapped from webPAS alert category
         displayZAL-2.2, ZAL-2.2,

Raw value and mapped from webPAS alert category
      coding (fhirOrig)
         system
         code
         display
      coding (rawSource)
         system
         code
         display
   codeZAL-3
      coding
         system 

One of:

  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-ls
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h2
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h4
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h5
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h6
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h7
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-h8
         codeZAL-3.1
         displayZAL-3.2
      textZAL-3.2

When ZAL-3.1 is one of:

  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-nhimws
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-mc
  • https://standards.digital.health.nz/ns/central-region/flag-alert-code-ma ie: these categories denote 'free-text' alert codes
   subject
      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
   period
      startZAL-5

Note: ISO-8601 date format includes dashes
      endZAL-9
   author
      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.1 + ', ' + ZAL-10.2 + ' ' + ZAL-10.3 + ' ' + ZAL-10.5