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
| Draft as of 2026-04-01 |
{
"resourceType" : "OperationDefinition",
"id" : "BgzTransformOperation",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Gegenereerde narrative: OperationDefinition BgzTransformOperation</b></p><a name=\"BgzTransformOperation\"> </a><a name=\"hcBgzTransformOperation\"> </a><p>Url: [base]/$transform</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Gebruik</b></td><td><b>Naam</b></td><td><b>Scope</b></td><td><b>Kardinaliteit</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentatie</b></td></tr><tr><td>IN</td><td>source</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The STU3 source resource or STU3 Bundle to translate.</p>\n</div></td></tr><tr><td>IN</td><td>sourceProfile</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Canonical URL of the supported STU3 source profile.</p>\n</div></td></tr><tr><td>IN</td><td>targetProfile</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Canonical URL of the supported R4 target profile.</p>\n</div></td></tr><tr><td>IN</td><td>validate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>When true, validate the translated R4 result before returning.</p>\n</div></td></tr><tr><td>IN</td><td>returnLogical</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>When true, include the intermediate logical model as a Binary resource.</p>\n</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The translated R4 resource or Bundle.</p>\n</div></td></tr><tr><td>OUT</td><td>targetProfile</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Canonical URL of the target profile route used by the translation.</p>\n</div></td></tr><tr><td>OUT</td><td>logical</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td><div><p>The intermediate logical model serialized as FHIR JSON.</p>\n</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Validation output when validation is requested.</p>\n</div></td></tr></table></div>"
},
"url" : "https://translate-ig.cumuluz.dev/ig/OperationDefinition/BgzTransformOperation",
"version" : "0.1.0",
"name" : "BgzTransform",
"title" : "BgZ 2017 STU3 to R4 Transform",
"status" : "draft",
"kind" : "operation",
"date" : "2026-04-01T20:43:31+02:00",
"publisher" : "Cumuluz",
"description" : "System-level operation for translating a supported Dutch STU3 source resource or bundle into a supported R4 target profile.",
"affectsState" : false,
"code" : "transform",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "source",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The STU3 source resource or STU3 Bundle to translate.",
"type" : "Resource"
},
{
"name" : "sourceProfile",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Canonical URL of the supported STU3 source profile.",
"type" : "canonical"
},
{
"name" : "targetProfile",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Canonical URL of the supported R4 target profile.",
"type" : "canonical"
},
{
"name" : "validate",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "When true, validate the translated R4 result before returning.",
"type" : "boolean"
},
{
"name" : "returnLogical",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "When true, include the intermediate logical model as a Binary resource.",
"type" : "boolean"
},
{
"name" : "result",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The translated R4 resource or Bundle.",
"type" : "Resource"
},
{
"name" : "targetProfile",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Canonical URL of the target profile route used by the translation.",
"type" : "canonical"
},
{
"name" : "logical",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The intermediate logical model serialized as FHIR JSON.",
"type" : "Binary"
},
{
"name" : "outcome",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Validation output when validation is requested.",
"type" : "OperationOutcome"
}
]
}