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: 3 |
Mappings for the VA.MHV.PHR.patient resource profile.
MHVpatient | ||
Patient | Entity. Role, or Act, Patient[classCode=PAT] | |
text | Act.text? | |
contained | N/A | |
extension (birthsex) | player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender | |
modifierExtension | N/A | |
identifier | 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 (PatientId) | 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 | |
active | statusCode | |
name | name | |
id | n/a | |
extension | n/a | |
use | unique(./use) | |
text | ./formatted | |
family | ./part[partType = FAM] | |
given | ./part[partType = GIV] | |
prefix | ./part[partType = PFX] | |
suffix | ./part[partType = SFX] | |
period | ./usablePeriod[type="IVL<TS>"] | |
gender | player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender | |
birthDate | player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime |
MHVpatient | ||
Patient | ClinicalDocument.recordTarget.patientRole | |
identifier | .id | |
identifier (PatientId) | .id | |
active | n/a | |
name | .patient.name | |
gender | .patient.administrativeGenderCode | |
birthDate | .patient.birthTime |
MHVpatient | ||
Patient | ||
identifier | FiveWs.identifier | |
identifier (PatientId) | FiveWs.identifier | |
active | FiveWs.status |
MHVpatient | ||
Patient | ||
identifier | PID-3 | |
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 (PatientId) | PID-3 | |
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) | |
name | PID-5, PID-9 | |
use | XPN.7, but often indicated by which field contains the name | |
text | implied by XPN.11 | |
family | XPN.1/FN.1 | |
given | XPN.2 + XPN.3 | |
prefix | XPN.5 | |
suffix | XPN/4 | |
period | XPN.13 + XPN.14 | |
gender | PID-8 | |
birthDate | PID-7 |
MHVpatient | ||
Patient | ||
birthDate | 21112-8 |