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
| Draft as of 2026-05-27 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "ToFhir"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div [ fhir:v "<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>\n</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>\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> (<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>\n</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>\n</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>\n</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\n(collection, searchset, or document) is context-dependent. An OperationOutcome\nMAY be included as an entry to convey warnings or partial mapping failures.</p>\n</div></td></tr></table></div>"^^rdf:XMLLiteral ]
] ; #
fhir:url [
fhir:v "http://fhirconnect.org/fhir/OperationDefinition/ToFhir"^^xsd:anyURI ;
fhir:l <http://fhirconnect.org/fhir/OperationDefinition/ToFhir>
] ; #
fhir:version [ fhir:v "0.1.0"] ; #
fhir:name [ fhir:v "ToFhir"] ; #
fhir:title [ fhir:v "$tofhir — Convert openEHR Composition to FHIR"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2026-05-27T11:19:57+02:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "FHIRConnect"] ; #
fhir:contact ( [
fhir:name [ fhir:v "FHIRConnect" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://github.com/SevKohler/FHIRconnect-spec" ] ] )
] ) ; #
fhir:description [ fhir:v "Converts an openEHR Composition to one or more FHIR resources using a FHIRConnect mapping.\n\nThe operation accepts a FHIR Parameters resource containing the serialized openEHR Composition\nand optional context fields (patient reference, EHR ID, provenance policy). It returns a FHIR Bundle\ncontaining the mapped resources. The Bundle type is implementation-dependent\n(collection, searchset, or document) and is not fixed by this specification.\n\nAn OperationOutcome MAY be included in the returned Bundle to convey warnings or partial failures."] ; #
fhir:affectsState [ fhir:v false] ; #
fhir:code [ fhir:v "tofhir"] ; #
fhir:system [ fhir:v true] ; #
fhir:type [ fhir:v false] ; #
fhir:instance [ fhir:v false] ; #
fhir:parameter ( [
fhir:name [ fhir:v "composition" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The openEHR Composition serialized as a JSON string. Passed as valueString rather than resource to maintain FHIR SDK compatibility." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "ehr_id" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The openEHR EHR identifier associated with the Composition." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "patient" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Reference to the FHIR Patient resource that is the subject of the Composition. Used to populate subject/patient references in mapped resources." ] ;
fhir:type [ fhir:v "Reference" ] ;
( fhir:targetProfile [
fhir:v "http://hl7.org/fhir/StructureDefinition/Patient"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/StructureDefinition/Patient> ] )
] [
fhir:name [ fhir:v "provenance" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Provenance policy information. The engine resolves remaining provenance data; only the policy is required from the caller." ] ;
( fhir:part [
fhir:name [ fhir:v "policy" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "URI identifying the provenance policy." ] ;
fhir:type [ fhir:v "uri" ] ] )
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "A Bundle containing the FHIR resources produced by the mapping. The Bundle type\n(collection, searchset, or document) is context-dependent. An OperationOutcome\nMAY be included as an entry to convey warnings or partial mapping failures." ] ;
fhir:type [ fhir:v "Bundle" ]
] ) . #
IG © 2026+ FHIRConnect. Package org.fhirconnect.restful#0.1.0 based on FHIR 4.0.1. Generated 2026-05-27
Links: Table of Contents |
QA Report