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

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

$tofhir — Convert openEHR Composition to FHIR

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.
$toopenehr — Convert FHIR Bundle to openEHR Composition

Converts a FHIR Bundle to an openEHR Composition using a FHIRConnect mapping.

The operation accepts a FHIR Bundle as input and returns a FHIR Parameters resource containing the serialized openEHR Composition as a JSON string.

When the mapping is fully successful the response contains only the composition parameter. When mapping issues occur (e.g. a source element could not be mapped, a required field was absent, or a partial result was produced), an additional outcome parameter carrying an OperationOutcome resource SHOULD be included alongside the composition. The presence of an OperationOutcome does not necessarily mean the composition is absent — a partial result MAY be returned together with issues describing what could not be mapped.

Example response with OperationOutcome:

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "composition",
      "valueString": "{\"_type\": \"COMPOSITION\", \"name\": {\"_type\": \"DV_TEXT\", \"value\": \"International Patient Summary\"}, ...}"
    },
    {
      "name": "outcome",
      "resource": {
        "resourceType": "OperationOutcome",
        "issue": [
          {
            "severity": "warning",
            "code": "incomplete",
            "details": {
              "text": "Element Observation.effectivePeriod could not be mapped; no corresponding openEHR archetype path found."
            }
          }
        ]
      }
    }
  ]
}