Cumuluz Translate Implementation Guide
0.1.0 - ci-build
Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
EPS is one specific R4 output family. Request it when a supported STU3 source Bundle must become a European Patient Summary document Bundle. Other Bundle translations use Bundle Translation.
Call POST /fhir/stu3-r4/$transform and set the top-level target profile to:
http://hl7.eu/fhir/eps/StructureDefinition/bundle-eu-eps
Every source entry still needs an exact registered route to its EPS resource profile. Package availability, a related resource type or an empty Composition section does not establish support. Unsupported entries cause the whole request to fail; they are not omitted.
The HTTP body is one UTF-8 JSON document with Content-Type: application/fhir+json:
R4-style Parameters JSON
├─ parameter[source].resource: STU3 Bundle
├─ parameter[targetProfile].valueCanonical: EPS Bundle canonical
├─ parameter[documentContext].resource: R4 Composition (optional)
└─ parameter[validationMode].valueCode: report | enforce | none
The source Bundle and document context use different FHIR versions inside the same operation envelope. The service parses source as STU3 and documentContext as R4. Pass both as nested resources, not strings or Binary payloads.
HTTP 200 returns R4 Parameters; parameter[result].resource is the R4 EPS document Bundle. Request failures return a standalone R4 OperationOutcome with HTTP 400.
documentContext is a caller-authored R4 Composition that supplies document assertions the translator must not infer: the source Patient subject, authors and other actors, identifier, date, status, title, narrative, section assertions and explicit empty-section reasons.
Authors and other referenced context actors must be contained in the Composition, except for the source Patient. Section entries are assembled from the translated Bundle entries.
| Context state | Result |
|---|---|
absent in report |
incomplete draft; no author or clinical absence is inferred |
absent in enforce |
request rejected because document evidence is incomplete |
| valid context | document assertions are used; entry governance and final validation still run |
The Composition is assembly context, not the source of a generic Composition translation route.
| Area | Registered source examples | EPS target |
|---|---|---|
| Patient | BgZ Patient, PZP ACP Patient | patient-eu-eps |
| Problem | BgZ Problem | condition-obl-eu-eps |
| Procedure | BgZ Procedure | procedure-eu-eps |
| Allergy | dependent Dutch STU3 AllergyIntolerance | allergyintolerance-obl-eu-eps |
| Medication | MedicationAgreement, MedicationUse | EPS MedicationRequest and MedicationStatement |
| Advance directives | selected PZP Consent routes | consent-eu-eps |
| Supporting actors and devices | selected PZP routes | matching EPS profiles |
The translation index is authoritative for exact canonicals. Organisation, alerts, immunisation, pregnancy, travel history and laboratory reporting remain unsupported unless a concrete source/target pair appears there.
The R4 response contains:
result: the document Bundle with Composition and translated resources;targetProfile: the EPS Bundle canonical;translationReport: document-level and per-entry route evidence;outcome: entry-stage and final document-profile validation diagnostics.Final EPS Bundle validation does not replace entry-level validation or governance. Before accepting the document, verify its Bundle type and profile, Composition completeness, Patient/author references, section entries, internal-reference closure, issue severities, conformance mode and every applicable loss decision.