Primary care data acquisition API
0.2.0 - ci-build

Primary care data acquisition API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-primary-care-acquisition/ and changes regularly. See the Directory of published versions

Resource Profile: PrimaryCareEncounter - Mappings

Draft as of 2024-12-06

Mappings for the PrimaryCareEncounter resource profile.

Mappings for Workflow Pattern (http://hl7.org/fhir/workflow)

PrimaryCareEncounter
EncounterEvent
   identifierEvent.identifier
   identifier (HealthRecordKey)Event.identifier
   statusEvent.status
   typeEvent.code
   serviceTypeEvent.code
   subjectEvent.subject
   participantEvent.performer
      typeEvent.performer.function
      individualEvent.performer.actor
   periodEvent.occurrence[x]
   reasonCodeEvent.reasonCode
   diagnosis
      conditionEvent.reasonReference
   location
      locationEvent.location
   partOfEvent.partOf

Mappings for RIM Mapping (http://hl7.org/v3)

PrimaryCareEncounter
EncounterEntity. Role, or Act, Encounter[@moodCode='EVN']
   textAct.text?
   identifier.id
   identifier (HealthRecordKey).id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   status.statusCode
   class.inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
   type.code
   serviceTypen/a
   priority.priorityCode
   subject.participation[typeCode=SBJ]/role[classCode=PAT]
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   participant.participation[typeCode=PFM]
      idn/a
      extensionn/a
      modifierExtensionN/A
      type.functionCode
      period.time
      individual.role
   period.effectiveTime (low & high)
   reasonCode.reasonCode
   diagnosis.outboundRelationship[typeCode=RSON]
      idn/a
      extensionn/a
      modifierExtensionN/A
      condition.outboundRelationship[typeCode=RSON].target
      usen/a
      rank.outboundRelationship[typeCode=RSON].priority
   location.participation[typeCode=LOC]
      idn/a
      extensionn/a
      modifierExtensionN/A
      location.role
      status.role.statusCode
      period.time
   partOf.inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

PrimaryCareEncounter
Encounter
   identifierFiveWs.identifier
   identifier (HealthRecordKey)FiveWs.identifier
   statusFiveWs.status
   classFiveWs.class
   typeFiveWs.class
   priorityFiveWs.grade
   subjectFiveWs.subject[x], FiveWs.subject
   participant
      individualFiveWs.who
   periodFiveWs.done[x]
   reasonCodeFiveWs.why[x]
   diagnosis
      conditionFiveWs.why[x]
   location
      locationFiveWs.where[x]

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

PrimaryCareEncounter
Encounter
   identifierPV1-19
   identifier (HealthRecordKey)PV1-19
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   statusNo clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16
   classPV1-2
   typePV1-4 / PV1-18
   serviceTypePV1-10
   priorityPV2-25
   subjectPID-3
   participantROL
      typeROL-3 (or maybe PRT-4)
      periodROL-5, ROL-6 (or maybe PRT-5)
      individualROL-4
   periodPV1-44, PV1-45
   reasonCodeEVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
   diagnosis
      conditionResources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
   location
      locationPV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43