Operation-structuremap-transform - FHIR v5.0.0-draft-final

R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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

Example OperationDefinition/StructureMap-transform (Narrative)

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Note that this is the formal definition for the transform operation as an OperationDefinition on StructureMap. See the Operation documentation

URL: [base]/StructureMap/$transform

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

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

IN

source

type

0..1

uri

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

IN

sourceMap

0..1

StructureMap

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

IN

supportingMap

0..*

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).

IN

srcMap

0..*

string

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

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.