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

API

Page standards status: Informative

This section is focused on use of the FHIR API. The FHIR API is made up of the data that is mapped. Thus the Vista Mapping is not critical but may be useful background.

Note that the example data conversion in this publication is notional, and may not be perfect. Most of the examples are converted by hand. As part of this conversion some values are not perfectly converted. Such as time is not properly converted to the timezone, rather Z time is used. A small number of Patient, Practitioner, Location, and Organization resources are reused.

All MHV profiles are based on HL7 FHIR US-Core implementation guide, which provides guidance to the USA marketplace that VHA participates within. Deeper explanation is provided in the US-Core specification.

The MHV FHIR Server would have a similar CapabilityStatement.

Patient

Note that the above APIs take a patient/subject as a parameter. The expectation is that one will lookup that Patient by the MHV patientId (jwt subjectId) to get the FHIR Patient.id, and use the Patient.id where ever a subject or patient parameter is needed. It is possible to provide the MHV patientId (not ICN) in a patient.identifier parameter rather than using patient.id, but this will be slower and more error prone.

The Patient resource is minimally populated.