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

: PHR Export Operation

Page standards status: Informative

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/phr-export> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "phr-export"] ;
  fhir:Resource.language [ fhir:value "en"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition phr-export</b></p><a name=\"phr-export\"> </a><a name=\"hcphr-export\"> </a><p>URL: [base]/Bundle/$phr-export</p><p>URL: [base]/Bundle/[id]/$phr-export</p><p>URL: [base]/Patient/$phr-export</p><p>URL: [base]/Patient/[id]/$phr-export</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>outputFormat</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>Requested output format: bundle (default), ndjson, phr, or sphr. Servers implementing PHR export MUST support this parameter.</p>\n</div></td></tr><tr><td>IN</td><td>patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The patient whose record is being exported. Required when the operation is invoked at type level on a multi-patient system.</p>\n</div></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Earliest clinically-effective date to include (date or partial date).</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Latest clinically-effective date to include (date or partial date).</p>\n</div></td></tr><tr><td>IN</td><td>_since</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>Only include resources updated after this instant. Same meaning as in Patient/$everything.</p>\n</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Comma-separated list of resource types to include. Same meaning as in Patient/$everything.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The exported record: a Bundle when outputFormat is bundle, otherwise a Binary wrapping the NDJSON (.phr) or zip (.sphr) content.</p>\n</div></td></tr></table></div>"
  ] ;
  fhir:DomainResource.extension [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ;
     fhir:Extension.valueCode [ fhir:value "pe" ]
  ], [
     fhir:index -1 ;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
     fhir:Extension.valueCode [
       fhir:value "informative" ;
       fhir:Element.extension [
         fhir:index -1 ;
         fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom" ] ;
         fhir:Extension.valueCanonical [
           fhir:value "http://hl7.org/fhir/uv/phr/ImplementationGuide/hl7.fhir.uv.phr" ;
           fhir:link <http://hl7.org/fhir/uv/phr/ImplementationGuide/hl7.fhir.uv.phr>
         ]
       ]
     ]
  ] ;
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/uv/phr/OperationDefinition/phr-export"] ;
  fhir:OperationDefinition.version [ fhir:value "1.0.0-ballot2"] ;
  fhir:OperationDefinition.name [ fhir:value "PHRExport"] ;
  fhir:OperationDefinition.title [ fhir:value "PHR Export Operation"] ;
  fhir:OperationDefinition.status [ fhir:value "draft"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.experimental [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.date [ fhir:value "2026-10-09T01:04:02+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "HL7 International / Patient Empowerment"] ;
  fhir:OperationDefinition.contact [
     fhir:index -1 ;
     fhir:ContactDetail.name [ fhir:value "HL7 International / Patient Empowerment" ] ;
     fhir:ContactDetail.telecom [
       fhir:index -1 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "http://www.hl7.org/Special/committees/patientempowerment" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir:value "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."] ;
  fhir:OperationDefinition.jurisdiction [
     fhir:index -1 ;
     fhir:CodeableConcept.coding [
       fhir:index -1 ;
       fhir:Coding.system [ fhir:value "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
       fhir:Coding.code [ fhir:value "001" ] ;
       fhir:Coding.display [ fhir:value "World" ]
     ]
  ] ;
  fhir:OperationDefinition.code [ fhir:value "phr-export"] ;
  fhir:OperationDefinition.resource [
     fhir:value "Bundle" ;
     fhir:index -1
  ], [
     fhir:value "Patient" ;
     fhir:index -1
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.parameter [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "outputFormat" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Requested output format: bundle (default), ndjson, phr, or sphr. Servers implementing PHR export MUST support this parameter." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "code" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "patient" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The patient whose record is being exported. Required when the operation is invoked at type level on a multi-patient system." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "start" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Earliest clinically-effective date to include (date or partial date)." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "end" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Latest clinically-effective date to include (date or partial date)." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "date" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "_since" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Only include resources updated after this instant. Same meaning as in Patient/$everything." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "instant" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "_type" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Comma-separated list of resource types to include. Same meaning as in Patient/$everything." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "string" ]
  ], [
     fhir:index -1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "The exported record: a Bundle when outputFormat is bundle, otherwise a Binary wrapping the NDJSON (.phr) or zip (.sphr) content." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Resource" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/phr-export.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/phr-export.ttl> .