This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R4
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A |
|
Compartments : Not linked to any defined compartments |
This
is
the
narrative
for
the
resource.
See
also
the
XML
or
,
JSON
or
Turtle
format.
OPERATION: Model Instance Transformation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureMap-transform
The transform operation takes input content, applies a structure map transform, and then returns the output.
URL: [base]/StructureMap/$transform
URL: [base]/StructureMap/[id]/$transform
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | source | 0..1 | uri |
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 a particular structure map, this will be ignored by the server |
|
| IN | content | 1..1 | Resource |
The logical content to transform |
|
| OUT | return | 1..1 | Resource |
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
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.