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

Active as of 2024-09-17

Mappings for the NZCentralRegionReferral 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) - Referral (ServiceRequest) from REF^I12

NZCentralRegionReferral
ServiceRequestServiceRequest
      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
   extension (referral)
      extension (consultingPractitioner)
            type'Practitioner'
               use'usual'
                     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'
               valuePV1-9.1
            displayPV1-9.1
      extension (preferredSite)
            system'https://standards.digital.health.nz/ns/central-region/referral-site'
            codeZXV-35.1
            displayZXV-35.2
      extension (referralSource)
            system'https://standards.digital.health.nz/ns/central-region/referral-source'
            codeZXV-15.1
            displayZXV-15.2
      extension (referringPractice)
            type'Organisation'
               use'usual'
                     system'http://terminology.hl7.org/CodeSystem/v2-0203'
                     code'LR'
                     display'Local Registry ID'
               system'https://standards.digital.health.nz/ns/central-region/referring-practice'
               valueZXV-49.1
            displayZXV-49.2
      extension (healthPurchaser)
            system'https://standards.digital.health.nz/ns/central-region/health-purchaser'
            codeZXV-51.1
            displayZXV-51.2
      extension (clinicType)
            system'https://standards.digital.health.nz/ns/central-region/referral-clinic'
            codeZXV-37.1
            displayZXV-37.2
      extension (lastUpdated)
         value[x]ZXV-41, ZXV-41

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

,

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

      extension (informGP)
         value[x]ZXV-19

if ZXV-19 == 'Y' then 'true' else 'false'

      extension (webPASPriority)
         value[x]RF1.1

If present

            system'https://standards.digital.health.nz/ns/central-region/pas-referral-priority'
            codeRF1.1.2
            displayRF1.1.2
      extension (webPASStatus)
            system'https://standards.digital.health.nz/ns/central-region/pas-referral-status'
            codeRF1.1.1
            displayRF1.1.1
      extension (dateReceived)
         value[x]ZXV-36

Note: ISO-8601 Date has field separators

      extension (effectiveDateTime)
         value[x]RF1-7

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

   identifier
      use'usual'
      type
         coding
            system'http://terminology.hl7.org/CodeSystem/v2-0203'
            code'RI'
            display'Referral Identifier'
      system'https://standards.digital.health.nz/ns/central-region/pas-referral-id'
      valueRF1-11.1
   statusdraft | active | revoked

if RF1-1.1 == 'P' then 'draft'

elif RF1-1.1 == 'A' then 'active'

elif RF1-1.1 == 'R' then 'revoked'

else 'unknown'

   intent'order'
   priority$translate(RF1-2.1)

Use Referral Priority concept map

Note: use of two different CodeSystems - https://standards.digital.health.nz/ns/central-region/referral-priority and http://terminology.hl7.org/CodeSystem/v2-0280

   code
      coding
         system'https://standards.digital.health.nz/ns/central-region/referral-type'
         codeZXV-34.1
         displayZXV-34.2
   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
   authoredOnZXV-9

Note: ISO-8601 Date has field separators

   requesterPV1-8 / PRD

Repeat for each PV1-8 (or first PRD if no PV1 segment)

      referencen/a

Internal GUID

      type'Practitioner'
      identifier 

Only available from PV1-8

         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'
         valuePV1-8.1
   performerPV1-7

Repeat for each PV1-7 (or second PRD if no PV1 segment)

      referencen/a

Internal GUID

      type'Practitioner'
      identifier 

Only available from PV1-7

         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'
         valuePV1-7.1
   locationCode
      coding
         system'https://standards.digital.health.nz/ns/central-region/referral-department'
         codeZXV-40.1
         displayZXV-40.2
   reasonCode
         system'https://standards.digital.health.nz/ns/central-region/referral-reason'
         codeZXV-7.1
         displayZXV-7.2
   supportingInfo
   note