MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: MHVallergyIntolerance - Mappings

Page standards status: Trial-use Maturity Level: 4

Mappings for the VA.MHV.PHR.allergyIntolerance resource profile.

Mappings for HDR Allergy to mhv-fhir-phr (intoleranceCondition)

Informative map to available elements in MHV FHIR API

MHVallergyIntolerance
AllergyIntoleranceHDR Allergy

Vista FileMan

   extension (observedHistoric)intoleranceCondition.informationSourceCategory

120.8-6 OBSERVED/HISTORICAL

   identifierintoleranceCondition.recordIdentifer
   clinicalStatus`active` if not entered-in-error

120.8-19 VERIFIED

   verificationStatuswould indicate `entered-in-error`

120.8-22 ENTERED IN ERROR

   category~intoleranceCondition.allergyType.code

120.8-3.1 ALLERGY TYPE

   code
      textintoleranceCondition.agent.code

120.8-.02 REACTANT

   patientGetPatient(intoleranceCondition.patient)

120.8-.01 PATIENT

   recordedDate~intoleranceCondition.observationTime.literal

120.8-9 HISTORICAL DATE/TIME OF EVENT

   recorder
      extension (visn)Organization(intoleranceCondition.facilityIdentifier)
   noteintoleranceCondition.commentEvents

120.8-26 COMMENTS

      time~intoleranceCondition.commentEvents.date.literal
      textintoleranceCondition.commentEvents.comment
   reaction
      manifestationintoleranceCondition.reaction.reaction

120.8-10 REACTIONS

         coding
            systemif code is 7 digits, then system is VUID, else use SNOMED-CT system
            codeintoleranceCondition.reaction.reaction.code
         textintoleranceCondition.reaction.reaction.displayText

Mappings for eVault-PHR to MHV-PHR (eVaultPHR)

Informative map that includes only the elements available in eVault PHR

MHVallergyIntolerance
AllergyIntoleranceHDR Allergy

eVault

   extension (observedHistoric)intoleranceCondition.informationSourceCategory

Observed/Historical

   identifierintoleranceCondition.recordIdentifer
   clinicalStatus`active` if not entered-in-error
   verificationStatuswould indicate `entered-in-error`
   category~intoleranceCondition.allergyType.code

Allergy Type

   code
      textintoleranceCondition.agent.code

Allergen

   patientGetPatient(intoleranceCondition.patient)
   recordedDate~intoleranceCondition.observationTime.literal

Date Entered

   recorder
      extension (visn)Organization(intoleranceCondition.facilityIdentifier)
   noteintoleranceCondition.commentEvents
      time~intoleranceCondition.commentEvents.date.literal
      textintoleranceCondition.commentEvents.comment

Comments

   reaction
      manifestationintoleranceCondition.reaction.reaction
         textintoleranceCondition.reaction.reaction.displayText

Reactions

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

MHVallergyIntolerance
AllergyIntoleranceEntity. Role, or Act, Observation[classCode=OBS, moodCode=EVN]
   textAct.text?
   containedN/A
   modifierExtensionN/A
   identifierid
   identifier (recordIdentifier)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
   identifier (TOid)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
   clinicalStatusObservation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
   verificationStatusObservation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
   typecode
   categoryvalue < IntoleranceValue (Agent)
   codesubstance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value
      idn/a
      extensionn/a
      text./originalText[mediaType/code="text/plain"]/data
   patient.participation[typeCode=SBJ].role[classCode=PAT]
   recordedDate.participation[typeCode=AUT].time
   recorder.participation[typeCode=AUT].role
      idn/a
      extensionn/a
      extension (visn)
         idn/a
         urlN/A
         value[x]N/A
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   notesubjectOf.observationEvent[code="annotation"].value
      idn/a
      extensionn/a
      timeAct.effectiveTime
      textAct.text
   reactionoutBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]
      idn/a
      extensionn/a
      modifierExtensionN/A
      manifestationcode
         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

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

MHVallergyIntolerance
AllergyIntolerance
   identifierFiveWs.identifier
   identifier (recordIdentifier)FiveWs.identifier
   identifier (TOid)FiveWs.identifier
   clinicalStatusFiveWs.status
   verificationStatusFiveWs.status
   typeFiveWs.class
   categoryFiveWs.class
   codeFiveWs.what[x]
   patientFiveWs.subject[x], FiveWs.subject
   recordedDateFiveWs.recorded
   recorderFiveWs.author

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

MHVallergyIntolerance
AllergyIntolerance
   identifierIAM-7
   identifier (recordIdentifier)IAM-7
      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)
   identifier (TOid)IAM-7
      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)
   typeIAM-9
   categoryAL1-2
   codeAL1-3 / IAM-3
      textC*E.9. But note many systems use C*E.2 for this
   patient(PID-3)
   recordedDateIAM-13
   note
      timeN/A
      textN/A
   reaction
      manifestationAL1-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