FHIRConnect RESTful Implementation Guide
0.1.0 - ci-build

FHIRConnect RESTful Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: $tofhir — Convert openEHR Composition to FHIR - XML Representation

Draft as of 2026-05-27

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ToFhir"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition ToFhir</b></p><a name="ToFhir"> </a><a name="hcToFhir"> </a><p>URL: [base]/$tofhir</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>composition</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The openEHR Composition serialized as a JSON string. Passed as valueString rather than resource to maintain FHIR SDK compatibility.</p>
</div></td></tr><tr><td>IN</td><td>ehr_id</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The openEHR EHR identifier associated with the Composition.</p>
</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> (<a href="http://hl7.org/fhir/R4/patient.html" title="http://hl7.org/fhir/StructureDefinition/Patient">Patient</a>)</td><td/><td><div><p>Reference to the FHIR Patient resource that is the subject of the Composition. Used to populate subject/patient references in mapped resources.</p>
</div></td></tr><tr><td>IN</td><td>provenance</td><td/><td>0..1</td><td/><td/><td><div><p>Provenance policy information. The engine resolves remaining provenance data; only the policy is required from the caller.</p>
</div></td></tr><tr><td>IN</td><td>provenance.policy</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>URI identifying the provenance policy.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>A Bundle containing the FHIR resources produced by the mapping. The Bundle type
(collection, searchset, or document) is context-dependent. An OperationOutcome
MAY be included as an entry to convey warnings or partial mapping failures.</p>
</div></td></tr></table></div>
  </text>
  <url value="http://fhirconnect.org/fhir/OperationDefinition/ToFhir"/>
  <version value="0.1.0"/>
  <name value="ToFhir"/>
  <title value="$tofhir — Convert openEHR Composition to FHIR"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2026-05-27T11:19:57+02:00"/>
  <publisher value="FHIRConnect"/>
  <contact>
    <name value="FHIRConnect"/>
    <telecom>
      <system value="url"/>
      <value value="https://github.com/SevKohler/FHIRconnect-spec"/>
    </telecom>
  </contact>
  <description
               value="Converts an openEHR Composition to one or more FHIR resources using a FHIRConnect mapping.

The operation accepts a FHIR Parameters resource containing the serialized openEHR Composition
and optional context fields (patient reference, EHR ID, provenance policy). It returns a FHIR Bundle
containing the mapped resources. The Bundle type is implementation-dependent
(collection, searchset, or document) and is not fixed by this specification.

An OperationOutcome MAY be included in the returned Bundle to convey warnings or partial failures."/>
  <affectsState value="false"/>
  <code value="tofhir"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="composition"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The openEHR Composition serialized as a JSON string. Passed as valueString rather than resource to maintain FHIR SDK compatibility."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="ehr_id"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The openEHR EHR identifier associated with the Composition."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Reference to the FHIR Patient resource that is the subject of the Composition. Used to populate subject/patient references in mapped resources."/>
    <type value="Reference"/>
    <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
  </parameter>
  <parameter>
    <name value="provenance"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Provenance policy information. The engine resolves remaining provenance data; only the policy is required from the caller."/>
    <part>
      <name value="policy"/>
      <use value="in"/>
      <min value="0"/>
      <max value="*"/>
      <documentation value="URI identifying the provenance policy."/>
      <type value="uri"/>
    </part>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="A Bundle containing the FHIR resources produced by the mapping. The Bundle type
(collection, searchset, or document) is context-dependent. An OperationOutcome
MAY be included as an entry to convey warnings or partial mapping failures."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>