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

: BgZ 2017 STU3 to R4 Transform - XML Representation

Draft as of 2026-04-01

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="BgzTransformOperation"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://translate-ig.cumuluz.dev/ig/OperationDefinition/BgzTransformOperation"/>
  <version value="0.1.0"/>
  <name value="BgzTransform"/>
  <title value="BgZ 2017 STU3 to R4 Transform"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2026-04-01T20:43:31+02:00"/>
  <publisher value="Cumuluz"/>
  <description
               value="System-level operation for translating a supported Dutch STU3 source resource or bundle into a supported R4 target profile."/>
  <affectsState value="false"/>
  <code value="transform"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="source"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The STU3 source resource or STU3 Bundle to translate."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="sourceProfile"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Canonical URL of the supported STU3 source profile."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="targetProfile"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Canonical URL of the supported R4 target profile."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="validate"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="When true, validate the translated R4 result before returning."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="returnLogical"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="When true, include the intermediate logical model as a Binary resource."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="result"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The translated R4 resource or Bundle."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="targetProfile"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Canonical URL of the target profile route used by the translation."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="logical"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The intermediate logical model serialized as FHIR JSON."/>
    <type value="Binary"/>
  </parameter>
  <parameter>
    <name value="outcome"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Validation output when validation is requested."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>