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

CapabilityStatement: This indicates how MHV exposes PHR using FHIR

Official URL: https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/CapabilityStatement/MHVcapabilities Version: 0.3.9-current
Standards status: Trial-use Maturity Level: 1 Computable Name: MHV_PHR

CapabilityStatement prototype for MHV as a FHIR Server exposing PHR data

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement MHVcapabilities

This indicates how MHV exposes PHR using FHIR

  • Implementation Guide Version: 0.3.9-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Supported Patch Formats:
  • Published on: 2023-08-23
  • Published by: VA Digital Services

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

MHV supports queries to PHR.

Security

Security is system level, PHR presumes MHV properly handles user (as patient) rights

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AllergyIntoleranceSupported Profiles
  VA MHV PHR Allergy and Intolerance		yy
ConditionSupported Profiles
  VA MHV PHR problems		yy
ObservationSupported Profiles
  VA MHV PHR Vital-Signs
  VA MHV PHR Vital-Signs for Blood Pressure
  VA MHV PHR Vital-Signs for PAIN
  VA MHV PHR Pulse Oximetry Vital-Signs		yy
ImmunizationSupported Profiles
  VA MHV PHR Immunization		yy
DocumentReferenceSupported Profiles
  VA MHV All DocumentReference
  VA MHV PHR Notes
  VA MHV PHR Imaging Report
  VA MHV PHR ECG		yy
DiagnosticReportSupported Profiles
  VA MHV DiagnosticReport
  VA MHV PHR HDR Chem-Hem Report
  VA MHV PHR SP Lab Report
  VA MHV PHR MB Lab Report		yy
PatientSupported Profiles
  VA MHV PHR Patient		yy

Resource Conformance: supported AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.allergyIntolerance

Documentation

MHV PHR use

Resource Conformance: supported Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.condition

Documentation

MHV PHR use

Resource Conformance: supported Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.vitals
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.vitalsBP
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.vitalsPain
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.vitalsOx

Documentation

MHV PHR use

Resource Conformance: supported Immunization

Core FHIR Resource
Immunization
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.immunization

Documentation

MHV PHR use

Resource Conformance: supported DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.documentReference
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.note
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.imaging
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.ecg

Documentation

MHV PHR use

Resource Conformance: supported DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.diagnosticReport
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.chReport
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.SPlabReport
https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.MBlabReport

Documentation

MHV PHR use

Resource Conformance: supported Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.patient