Personal Health Records
1.0.0-ballot2 - STU 1 ballot International flag

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

OperationDefinition: PHR Export Operation (Experimental)

Official URL: http://hl7.org/fhir/uv/phr/OperationDefinition/phr-export Version: 1.0.0-ballot2
Standards status: Informative Computable Name: PHRExport

Generates a complete patient health record. The default output is a FHIR Bundle; the outputFormat parameter selects NDJSON, .phr, or .sphr packaging. Parameters are aligned with the R5 Patient/$everything operation (_since, _type), so a server MAY implement this operation as a façade over $everything plus serialization. See the API Endpoints page for conformance requirements and worked examples.

Language: en

URL: [base]/Bundle/$phr-export

URL: [base]/Bundle/[id]/$phr-export

URL: [base]/Patient/$phr-export

URL: [base]/Patient/[id]/$phr-export

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INoutputFormat0..1code

Requested output format: bundle (default), ndjson, phr, or sphr. Servers implementing PHR export MUST support this parameter.

INpatient0..1Reference

The patient whose record is being exported. Required when the operation is invoked at type level on a multi-patient system.

INstart0..1date

Earliest clinically-effective date to include (date or partial date).

INend0..1date

Latest clinically-effective date to include (date or partial date).

IN_since0..1instant

Only include resources updated after this instant. Same meaning as in Patient/$everything.

IN_type0..1string

Comma-separated list of resource types to include. Same meaning as in Patient/$everything.

OUTreturn1..1Resource

The exported record: a Bundle when outputFormat is bundle, otherwise a Binary wrapping the NDJSON (.phr) or zip (.sphr) content.