MyHealtheVet PHR FHIR API
0.3.9-current - ci-build
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
Page standards status: Trial-use | Maturity Level: 4 |
Mappings for the VA.MHV.PHR.allergyIntolerance resource profile.
Informative map to available elements in MHV FHIR API
MHVallergyIntolerance | ||
AllergyIntolerance | HDR Allergy | Vista FileMan |
extension (observedHistoric) | intoleranceCondition.informationSourceCategory | 120.8-6 OBSERVED/HISTORICAL |
identifier | intoleranceCondition.recordIdentifer | |
clinicalStatus | `active` if not entered-in-error | 120.8-19 VERIFIED |
verificationStatus | would indicate `entered-in-error` | 120.8-22 ENTERED IN ERROR |
category | ~intoleranceCondition.allergyType.code | 120.8-3.1 ALLERGY TYPE |
code | ||
text | intoleranceCondition.agent.code | 120.8-.02 REACTANT |
patient | GetPatient(intoleranceCondition.patient) | 120.8-.01 PATIENT |
recordedDate | ~intoleranceCondition.observationTime.literal | 120.8-9 HISTORICAL DATE/TIME OF EVENT |
recorder | ||
extension (visn) | Organization(intoleranceCondition.facilityIdentifier) | |
note | intoleranceCondition.commentEvents | 120.8-26 COMMENTS |
time | ~intoleranceCondition.commentEvents.date.literal | |
text | intoleranceCondition.commentEvents.comment | |
reaction | ||
manifestation | intoleranceCondition.reaction.reaction | 120.8-10 REACTIONS |
coding | ||
system | if code is 7 digits, then system is VUID, else use SNOMED-CT system | |
code | intoleranceCondition.reaction.reaction.code | |
text | intoleranceCondition.reaction.reaction.displayText |
Informative map that includes only the elements available in eVault PHR
MHVallergyIntolerance | ||
AllergyIntolerance | HDR Allergy | eVault |
extension (observedHistoric) | intoleranceCondition.informationSourceCategory | Observed/Historical |
identifier | intoleranceCondition.recordIdentifer | |
clinicalStatus | `active` if not entered-in-error | |
verificationStatus | would indicate `entered-in-error` | |
category | ~intoleranceCondition.allergyType.code | Allergy Type |
code | ||
text | intoleranceCondition.agent.code | Allergen |
patient | GetPatient(intoleranceCondition.patient) | |
recordedDate | ~intoleranceCondition.observationTime.literal | Date Entered |
recorder | ||
extension (visn) | Organization(intoleranceCondition.facilityIdentifier) | |
note | intoleranceCondition.commentEvents | |
time | ~intoleranceCondition.commentEvents.date.literal | |
text | intoleranceCondition.commentEvents.comment | Comments |
reaction | ||
manifestation | intoleranceCondition.reaction.reaction | |
text | intoleranceCondition.reaction.reaction.displayText | Reactions |
MHVallergyIntolerance | ||
AllergyIntolerance | Entity. Role, or Act, Observation[classCode=OBS, moodCode=EVN] | |
text | Act.text? | |
contained | N/A | |
modifierExtension | N/A | |
identifier | id | |
identifier (recordIdentifier) | id | |
id | n/a | |
extension | n/a | |
use | Role.code or implied by context | |
type | Role.code or implied by context | |
system | II.root or Role.id.root | |
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
period | Role.effectiveTime or implied by context | |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
identifier (TOid) | id | |
id | n/a | |
extension | n/a | |
use | Role.code or implied by context | |
type | Role.code or implied by context | |
system | II.root or Role.id.root | |
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
period | Role.effectiveTime or implied by context | |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
clinicalStatus | Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value | |
verificationStatus | Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value | |
type | code | |
category | value < IntoleranceValue (Agent) | |
code | substance/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 | |
id | n/a | |
extension | n/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 | |
id | n/a | |
extension | n/a | |
extension (visn) | ||
id | n/a | |
url | N/A | |
value[x] | N/A | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
note | subjectOf.observationEvent[code="annotation"].value | |
id | n/a | |
extension | n/a | |
time | Act.effectiveTime | |
text | Act.text | |
reaction | outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)] | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
manifestation | code | |
id | n/a | |
extension | n/a | |
coding | union(., ./translation) | |
id | n/a | |
extension | n/a | |
system | ./codeSystem | |
version | ./codeSystemVersion | |
code | ./code | |
display | CV.displayName | |
userSelected | CD.codingRationale | |
text | ./originalText[mediaType/code="text/plain"]/data |
MHVallergyIntolerance | ||
AllergyIntolerance | ||
identifier | FiveWs.identifier | |
identifier (recordIdentifier) | FiveWs.identifier | |
identifier (TOid) | FiveWs.identifier | |
clinicalStatus | FiveWs.status | |
verificationStatus | FiveWs.status | |
type | FiveWs.class | |
category | FiveWs.class | |
code | FiveWs.what[x] | |
patient | FiveWs.subject[x], FiveWs.subject | |
recordedDate | FiveWs.recorded | |
recorder | FiveWs.author |
MHVallergyIntolerance | ||
AllergyIntolerance | ||
identifier | IAM-7 | |
identifier (recordIdentifier) | IAM-7 | |
use | N/A | |
type | CX.5 | |
system | CX.4 / EI-2-4 | |
value | CX.1 / EI.1 | |
period | CX.7 + CX.8 | |
assigner | CX.4 / (CX.4,CX.9,CX.10) | |
identifier (TOid) | IAM-7 | |
use | N/A | |
type | CX.5 | |
system | CX.4 / EI-2-4 | |
value | CX.1 / EI.1 | |
period | CX.7 + CX.8 | |
assigner | CX.4 / (CX.4,CX.9,CX.10) | |
type | IAM-9 | |
category | AL1-2 | |
code | AL1-3 / IAM-3 | |
text | C*E.9. But note many systems use C*E.2 for this | |
patient | (PID-3) | |
recordedDate | IAM-13 | |
note | ||
time | N/A | |
text | N/A | |
reaction | ||
manifestation | AL1-5 | |
coding | C*E.1-8, C*E.10-22 | |
system | C*E.3 | |
version | C*E.7 | |
code | C*E.1 | |
display | C*E.2 - but note this is not well followed | |
userSelected | Sometimes implied by being first | |
text | C*E.9. But note many systems use C*E.2 for this |