Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions
Plain Language Summary goes here
Getting Started
Official URL: http://hl7.org/fhir/uv/phr/ImplementationGuide/hl7.fhir.uv.phr
The purpose of this implementation guide is to help the reader implement a Personal Health Record (in a programming language of their choice). The notion of a Personal Health Record (PHR) grows out of the concept of an Electronic Medical Record (EMR). The major difference being in ownership. The PHR being owned by the patient; and the EMR being owned by the hospital. Whereas an EMR is the digital chart maintained within a single organization, an Electronic Health Record (EHR) is the broader, interoperable longitudinal record shared across organizations; this guide uses the term EHR generically hereafter.
The following document will offer design guidance and standardized APIs for helping you develop your application; based on the healthcare industry standard of Fast Healthcare Interoperability Resources (FHIR). The scope of this document does not attempt to prescribe how you, the implementor, ought to go about programming your software. What it does provide, is guidance on how to successfully exchange data with other PHR and EHR apps. In effect, it documents widely supported (and government recognized) data standards and file formats for importing/exporting data into your software.
What is a Personal Health Record?
Nearly two decades ago, the Markle Foundation's Personal Health workgroup convened to discuss the state-of-the-art in managing personal health information. The workgroup defined the PHR as "an electronic application through which individuals can access, manage and share their health information, and that of others for whom they are authorized, in a private, secure, and confidential environment." Their early vision was that PHRs would enable individuals to access and coordinate comprehensive, lifelong health information and exchange necessary parts of it.
The diagram above shows the intersection of the data collected by the patient, compared to the data collected by clinical EHRs or insurance systems. The core of the Personal Health Record should be medical grade, and able to incorporate records from any clinical source or setting; and which the patient can then carry from one healthcare provider to the next. This specification establishes standard mechanisms for a PHR to interoperate with other systems (clinical and otherwise), thereby facilitating sharing of information obtained by the PHR from healthcare encounters, personal documentation and measurement, and other sources.
For more details on functionality of a personal health record system, the reader is encouraged to review the HL7 PHR System Functional Model.
Relevant Law
Country
Initiative / Law
Type
FHIR/API Integration
Netherlands
MedMij Framework
Policy/Standard + Certification
Yes (HL7 FHIR) – MedMij defines FHIR-based APIs; all certified PHRs use these standard APIs.
PGO Personal Health Environments (apps)
Private PHR Platforms (gov’t backed)
Yes – Must be MedMij-certified; patients access data via DigiD login and FHIR APIs.
Australia
My Health Record (MyHR)
Government-run National PHR
Partial – Transitioning from CDA to FHIR-based APIs via FHIR Gateway for consumer access.
Yes – HL7 FHIR adopted as primary exchange standard; personal consent-based PHR model.
Jurisdictional Variation and Change Over Time
Readers should be aware that the legal landscape above changes faster than ballot cycles. In particular:
Sub-legislative instruments move quickly. Executive orders, agency rules, and ministerial directives can change data requirements — including which demographic elements may be collected or displayed — between publications of this guide. Implementers SHOULD check current requirements in their jurisdiction rather than relying on this guide as a statement of current law.
Record keepers may be legally obligated to preserve historic records as written. Statutes of limitations, medical records retention laws, and litigation holds can require that records be maintained in the form in which they were created, even when current rules would prohibit creating such a record today. Faithful preservation of the record as received is a core function of a PHR (see the note on demographics on the Data Model page).
Longitudinal records cross jurisdictions. A PHR routinely integrates records from external jurisdictions — other countries, states, or health systems — that model demographics, identifiers, and terminology differently. Importers should expect and preserve this variation rather than normalizing it away.
How to Use This Implementation Guide
This Implementation Guide provides four main areas of guidance:
File Formats — The .phr and .sphr file extensions for portable personal health records (see Record Keeping)
API Patterns — Endpoints for importing and exporting health records (see API Endpoints)
Data Model — Mapping PHR-S Functional Model requirements to FHIR resources (see Data Model)
PGHD Code Mapping — A canonical vocabulary and ConceptMap crosswalk for patient-generated health data from consumer devices and apps (see Patient Generated Health Data)
Patient-Generated Health Data
Consumer devices and health apps (Apple HealthKit, Android Health Connect, fitness trackers, sleep monitors) each emit observations in their own vendor vocabularies. A core contribution of this guide is a canonical set of PHR-IG codes for these observations, together with a ConceptMap-based crosswalk that maps more than 400 device and app codes to LOINC and SNOMED CT. Source-system codes map into PHR-IG codes on import; PHR-IG codes map out to standard terminologies for clinical exchange and IPS generation. This is what allows step counts from two different phones, or sleep stages from two different wearables, to be reconciled into one longitudinal record.
The only portion of this guide required for conformance testing is the ability to import and export .sphr files. All other sections are informational and assist implementers in modeling patient health histories using FHIR.
Use Cases
This guide is particularly interested in the problem of collecting and aggregating medical records from multiple healthcare systems and devices into a coherent whole. In the healthcare industry, these types of compiled records are known as longitudinal records. These needs arise in many situations: longitudinal health records and studies, snowbirds, symptom tracking, Long COVID, multiple chronic conditions, lifelogs, healthy living, differential diagnoses, alternative care, bring-your-own-device, the foster care system, migrants/immigrants, climate refugees, and military service members and veterans.
See the Use Cases page for detailed scenarios describing how a Personal Health Record supports each of these situations.
Acknowledgements
Jan Oldenburg, Patient Empowerment Workgroup
Dr. Neelima Karipineni, MITRE
Salim K Semy, MITRE
Dave Carlson, Clinical Cloud Solutions
Savannah Mueller, EMI Advisors
Japanese PHR Council (日本PHR協会)
Japan Association for Medical Informatics (JAMI - 日本医療情報学会)
University of Ehime School of Medicine
Kyoto University Graduate School of Medicine
PHR Business Association
International Standards Alignment
This guide aligns with and acknowledges work from:
HL7 International Patient Summary (IPS) Task Force
HL7 Vulcan Accelerator (Real World Data & Adverse Events)
Copyright (c) 2021+ Health Level Seven International and MITRE.org.
Published under the Creative Commons "Attribution 4.0 International" (CC BY 4.0) License
This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, May 16, 2026 18:32+1000+10:00)
Package hl7.fhir.uv.ips#1.1.0
International Patient Summary (IPS) FHIR Implementation Guide (built Tue, Nov 22, 2022 03:24+0000+00:00)
Package hl7.fhir.uv.tools.r4#1.3.0
This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Oct 6, 2026 15:55+1100+11:00)
Globals
There are no Global profiles defined
Cross Version Analysis
This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.uv.phr.r4) and R4B (hl7.fhir.uv.phr.r4b) are available.
IP Statements
This publication includes IP covered under the following statements.
The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.