HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

Resource Profile: PT_Encounter - Mappings

Active as of 2024-09-23

Mappings for the PTEncounter resource profile.

Mappings for ()

PT_Encounter
Encounter
   statusIt is possible to use the PV1-41 field to indicate whether it is a clinical or administrative discharge. The ValueSet is user defined

Mappings for ()

PT_Encounter
Encounter
   hospitalization
      destination
         referenceLocation/PV1-37

Mappings for ()

PT_Encounter
Encounter
   participant
      individual
         referenceEVN-5.1; PV1-7.1; PV1-8.1; PV1-9.1; PV1-17.1; PV1-52.1; PV2-13.1; ROL-4.1; ORC-12.1

Mappings for ()

PT_Encounter
Encounter
   participant
      individual
         referenceROL-1; PRD-7.1

Mappings for ()

PT_Encounter
Encounter
   meta
      lastUpdatedEVN-2
   identifier
      useif MRG-5.1 or MRG-6.1 = old
      type
         coding
            codePV1-19.5; PV1-50.5
         textTranslation to [PT] of the display field
      valuePV1-19.1; PV1-50.1
      period
         startPV1-19.7; PV1-50.7
         endPV1-19.8; PV1-50.8
      assigner
         displayPV1-19.4; PV1-50.4
   statusADT^A01, ADT^A04 = 'arrived'; ADT^A02 = 'in-progress'; ADT^A03 = 'finished'; ADT^A08 (if PV1-2 = URG) = 'triaged'; ADT^A11, ADT^A13 = 'canceled'; ADT^A12 = 'entered-in-error';
   classPV1-2
      codePV1-2
   typePV1-4
      coding
         codePV1-4
      textTranslation to [PT] of the display field
   serviceTypePV1-10
      coding
         codePV1-10
      textTranslation to [PT] of the display field
   priorityPV2-25
      coding
         codePV2-25
      textTranslation to [PT] of the display field
   subject
      referencePatient/PID-3 c/ SNS; PID-18.1; PID-3 c/ SONHO
   participantPV1; ROL; ORC
      typePV1-7; PV1-8; PV1-9; PV1-17; PV1-52, PV2-13, ROL-3, ORC-12
         coding
            codePV1-7 (code=ATND); PV1-8, PV2-13 (code=REF); PV1-9 (code=CON); PV1-17 (code=ADM); PV1-52, ORC-12 (code=PART); ROL-3
            displayPV1-7 (display=attender); PV1-8, PV2-13 (display=referrer); PV1-9 (display=consultant); PV1-17 (display=admitter); PV1-52, ORC-12 (display=Participation); ROL-3
         textTranslation to [PT] of the display field
      period
         startROL-5
         endROL-6
   period
      startPV1-44
      endPV1-45
   length
      valueCalculation performed through the PV1-44 and PV1-45 field; PV2-11
   reasonCodeEVN-4; PV2-3
      coding
         systemPV2-3.3
         codePV2-3.1
         displayPV2-3.2
      textTranslation to [PT] of the display field
   diagnosis
      condition
         referenceCondition/DG1-3.1; DG1-20.1
      useDG1-6
         coding
            codeDG1-6
         textTranslation to [PT] of the display field
      rankDG1-15
   hospitalization
      preAdmissionIdentifierPV1-5
         typePV1-5.5
            coding
               codePV1-5.5
            textTranslation to [PT] of the display field
         valuePV1-5.1
         period
            startPV1-5.7
            endPV1-5.8
         assigner
            displayPV1-5.4
      admitSourcePV1-14
         coding
            codePV1-14
         textTranslation to [PT] of the display field
      reAdmissionPV1-13
         coding
            codePV1-13
         textTranslation to [PT] of the display field
      dietPreferencePV1-38
         coding
            systemPV1-38.3
            codePV1-38.1
            displayPV1-38.2
         textTranslation to [PT] of the display field
      specialCourtesyPV1-16
         coding
            codePV1-16
         textTranslation to [PT] of the display field
      specialArrangement
         coding
            codePV1-15 (if information about wheelchair)
         textTranslation to [PT] of the display field
      dischargeDispositionPV1-36
         coding
            codePV1-36
         textTranslation to [PT] of the display field
   location
      locationPV1-3, PV1-6, PV1-11, PV1-42, PV1-43
         referenceLocation/PV1-3.(1, 2, 3, 4, 7, 8, 10), PV1-6.(1, 2, 3, 4, 7, 8, 10), PV1-11.(1, 2, 3, 4, 7, 8, 10), PV1-42.(1, 2, 3, 4, 7, 8, 10), PV1-43.(1, 2, 3, 4, 7, 8, 10)
      statusdefault = active
      physicalType
         coding
            codePV1-3.(1, 2, 3, 4, 7, 8, 10); PV1-6.(1, 2, 3, 4, 7, 8, 10); PV1-11.(1, 2, 3, 4, 7, 8, 10); PV1-42.(1, 2, 3, 4, 7, 8, 10); PV1-43.(1, 2, 3, 4, 7, 8, 10)
         textTranslation to [PT] of the display field
   serviceProvider
      referenceOrganization/EVN-7, MSH-6, ORG-2.1, XON-3 or XON-10 (HL7v2.5); ORC-17.1; ORC-21.3 or ORC-21.10 (HL7v2.5)

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

PT_Encounter
EncounterEvent
   identifierEvent.identifier
   statusEvent.status
   typeEvent.code
   serviceTypeEvent.code
   subjectEvent.subject
   episodeOfCareEvent.context
   basedOnEvent.basedOn
   participantEvent.performer
      typeEvent.performer.function
      individualEvent.performer.actor
   appointmentEvent.basedOn
   periodEvent.occurrence[x]
   lengthEvent.occurrence[x]
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonCode
   diagnosis
      conditionEvent.reasonReference
   location
      locationEvent.location
   serviceProviderEvent.performer.actor
   partOfEvent.partOf

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

PT_Encounter
EncounterEntity. Role, or Act, Encounter[@moodCode='EVN']
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      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
         idn/a
         extensionn/a
         start./low
         end./high
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
   status.statusCode
   statusHistoryn/a
      idn/a
      extensionn/a
      modifierExtensionN/A
      statusn/a
      periodn/a
   class.inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
      idn/a
      extensionn/a
      system./codeSystem
      version./codeSystemVersion
      code./code
      displayCV.displayName
      userSelectedCD.codingRationale
   classHistoryn/a
      idn/a
      extensionn/a
      modifierExtensionN/A
      classn/a
      periodn/a
   type.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   serviceTypen/a
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   priority.priorityCode
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   subject.participation[typeCode=SBJ]/role[classCode=PAT]
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   episodeOfCaren/a
   basedOn.reason.ClinicalDocument
   participant.participation[typeCode=PFM]
      idn/a
      extensionn/a
      modifierExtensionN/A
      type.functionCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      period.time
         idn/a
         extensionn/a
         start./low
         end./high
      individual.role
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
   appointment.outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]
   period.effectiveTime (low & high)
      idn/a
      extensionn/a
      start./low
      end./high
   length.lengthOfStayQuantity
      idn/a
      extensionn/a
      valuePQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
      comparatorIVL properties
      unitPQ.unit
      systemCO.codeSystem, PQ.translation.codeSystem
      codePQ.code, MO.currency, PQ.translation.code
   reasonCode.reasonCode
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   reasonReference.reasonCode
   diagnosis.outboundRelationship[typeCode=RSON]
      idn/a
      extensionn/a
      modifierExtensionN/A
      condition.outboundRelationship[typeCode=RSON].target
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
      usen/a
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      rank.outboundRelationship[typeCode=RSON].priority
   account.pertains.A_Account
   hospitalization.outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]
      idn/a
      extensionn/a
      modifierExtensionN/A
      preAdmissionIdentifier.id
         idn/a
         extensionn/a
         useRole.code or implied by context
         typeRole.code or implied by context
            idn/a
            extensionn/a
            codingunion(., ./translation)
               idn/a
               extensionn/a
               system./codeSystem
               version./codeSystemVersion
               code./code
               displayCV.displayName
               userSelectedCD.codingRationale
            text./originalText[mediaType/code="text/plain"]/data
         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
            idn/a
            extensionn/a
            start./low
            end./high
         assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
            idn/a
            extensionn/a
            referenceN/A
            typeN/A
            identifier.identifier
            displayN/A
      origin.participation[typeCode=ORG].role
      admitSource.admissionReferralSourceCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      reAdmissionn/a
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      dietPreference.outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      specialCourtesy.specialCourtesiesCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      specialArrangement.specialArrangementCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      destination.participation[typeCode=DST]
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
      dischargeDisposition.dischargeDispositionCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
   location.participation[typeCode=LOC]
      idn/a
      extensionn/a
      modifierExtensionN/A
      location.role
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
      status.role.statusCode
      physicalType
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      period.time
   serviceProvider.particiaption[typeCode=PFM].role
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   partOf.inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]

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

PT_Encounter
Encounter
   identifierFiveWs.identifier
   statusFiveWs.status
   classFiveWs.class
   typeFiveWs.class
   priorityFiveWs.grade
   subjectFiveWs.subject[x], FiveWs.subject
   episodeOfCareFiveWs.context
   participant
      individualFiveWs.who
   periodFiveWs.done[x]
   reasonCodeFiveWs.why[x]
   reasonReferenceFiveWs.why[x]
   diagnosis
      conditionFiveWs.why[x]
   location
      locationFiveWs.where[x]

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

PT_Encounter
Encounter
   identifierPV1-19
      useN/A
      typeCX.5
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
         startDR.1
         endDR.2
      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
      systemC*E.3
      versionC*E.7
      codeC*E.1
      displayC*E.2 - but note this is not well followed
      userSelectedSometimes implied by being first
   typePV1-4 / PV1-18
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   serviceTypePV1-10
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   priorityPV2-25
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   subjectPID-3
   episodeOfCarePV1-54, PV1-53
   participantROL
      typeROL-3 (or maybe PRT-4)
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      periodROL-5, ROL-6 (or maybe PRT-5)
         startDR.1
         endDR.2
      individualROL-4
   appointmentSCH-1 / SCH-2
   periodPV1-44, PV1-45
      startDR.1
      endDR.2
   length(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes
      valueSN.2 / CQ - N/A
      comparatorSN.1 / CQ.1
      unit(see OBX.6 etc.) / CQ.2
      system(see OBX.6 etc.) / CQ.2
      code(see OBX.6 etc.) / CQ.2
   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 )
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   reasonReferenceEVN-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.
      use
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
   hospitalization
      preAdmissionIdentifierPV1-5
         useN/A
         typeCX.5
            codingC*E.1-8, C*E.10-22
               systemC*E.3
               versionC*E.7
               codeC*E.1
               displayC*E.2 - but note this is not well followed
               userSelectedSometimes implied by being first
            textC*E.9. But note many systems use C*E.2 for this
         systemCX.4 / EI-2-4
         valueCX.1 / EI.1
         periodCX.7 + CX.8
            startDR.1
            endDR.2
         assignerCX.4 / (CX.4,CX.9,CX.10)
      admitSourcePV1-14
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      reAdmissionPV1-13
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      dietPreferencePV1-38
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      specialCourtesyPV1-16
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      specialArrangementPV1-15 / OBR-30 / OBR-43
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      destinationPV1-37
      dischargeDispositionPV1-36
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
   location
      locationPV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43
      physicalType
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
   serviceProviderPL.6 & PL.1