Generated Narrative: OperationDefinition StructureMap-transform

URL: [base]/StructureMap/$transform

URL: [base]/StructureMap/[id]/$transform

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsourcetype0..1uri

The structure map to apply. This is only needed if the operation is invoked at the resource level and no structureMap has been provided. If the $transform operation is invoked on a particular structure map, this will be ignored by the server

INsourceMap0..1StructureMap

The structure map to apply. This is only needed when the operation is invoked at the resource level and no URI has been provided.

INsupportingMap0..*StructureMap

StructureMap resources that support the source map. If a source URL is provided, the map can be provided in this parameter (or it can be provided as sourceMap).

INsrcMap0..*string

The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap.

INcontent1..1Resource

The logical content to transform

OUTreturn1..1Resource

The result of the transform

The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a Binary resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved

<status value="active"/><kind value="operation"/><experimental value="false"/><date value="2026-04-03T20:06:10+00:00"/><publisher value="HL7 International / FHIR Infrastructure"/><contact><telecom><system value="url"/><value value="http://hl7.org/fhir"/></telecom><telecom><system value="email"/><value value="fhir@lists.hl7.org"/></telecom></contact><contact><telecom><system value="url"/><value value="http://www.hl7.org/Special/committees/fiwg"/></telecom></contact><description value="The transform operation takes input content, applies a structure map transform, and then returns the output."/><jurisdiction><coding><system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/><code value="001"/><display value="World"/></coding></jurisdiction><affectsState value="false"/><code value="transform"/><comment value="The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a [Binary](binary.html) resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved"/><resource value="StructureMap"/><system value="false"/><type value="true"/><instance value="true"/><parameter><name value="source"/><use value="in"/><scope value="type"/><min value="0"/><max value="1"/><documentation value="The structure map to apply. This is only needed if the operation is invoked at the resource level and no structureMap has been provided. If the $transform operation is invoked on a particular structure map, this will be ignored by the server"/><type value="uri"/></parameter><parameter><name value="sourceMap"/><use value="in"/><min value="0"/><max value="1"/><documentation value="The structure map to apply. This is only needed when the operation is invoked at the resource level and no URI has been provided."/><type value="StructureMap"/></parameter><parameter><name value="supportingMap"/><use value="in"/><min value="0"/><max value="*"/><documentation value="StructureMap resources that support the source map. If a source URL is provided, the map can be provided in this parameter (or it can be provided as sourceMap)."/><type value="StructureMap"/></parameter><parameter><name value="srcMap"/><use value="in"/><min value="0"/><max value="*"/><documentation value="The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap."/><type value="string"/></parameter><parameter><name value="content"/><use value="in"/><min value="1"/><max value="1"/><documentation value="The logical content to transform"/><type value="Resource"/></parameter><parameter><name value="return"/><use value="out"/><min value="1"/><max value="1"/><documentation value="The result of the transform"/><type value="Resource"/></parameter></OperationDefinition>