FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

7.7.11 7.5.11 Resource StructureMap - Operations

Responsible Owner: FHIR Infrastructure icon Work Group Maturity Level Standards Status : 2 Informative   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

This resource has 1 operation operations associated with it:

$transform Model Instance Transformation

For more information about operations, including how they In addition, there are invoked, see Operations . 7.7.11.1 Model Instance Transformation The transform operation takes input content, applies a structure map transform, and then returns the output. The official URL for this operation definition is http://hl7.org/fhir/OperationDefinition/StructureMap-transform Formal Definition (as a OperationDefinition ). URL: [base]/StructureMap/$transform URL: [base]/StructureMap/[id]/$transform This is an idempotent operation operations that apply to all resource types:

In Parameters: Name Cardinality Type Binding Profile Documentation
source 0..1 uri $validate The structure map to apply. This is only needed if the operation is invoked at the resource level. If the $transform operation is invoked on Validate a particular structure map, this will be ignored by the server resource
content 1..1 Resource $convert The logical content Convert from one form to transform Out Parameters: Name Cardinality Type Binding Profile Documentation another
return 1..1 Resource $graphql The result of the transform Execute a graphql statement

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 7.7.11.1.1 Examples Transform input model (Request): POST [base]/StructureMap/example/$tansform Content-Type: text/xml <classA xmlns="http://example.org"> <test>value</test> </class> Response: HTTP/1.1 200 OK Content-Type: application/xml [other headers] <message xmlns="http://example.org/other"> <testValue value="value"/> </message>   more information about operations, including how they are invoked, see Operations .