This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
Operation Definition
{
"resourceType": "OperationDefinition",
"id": "StructureMap-transform",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
}
],
"url": "http://hl7.org/fhir/OperationDefinition/StructureMap-transform",
"name": "Model Instance Transformation",
"status": "draft",
"kind": "operation",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "The transform operation takes input content, applies a structure map transform, and then returns the output.",
"code": "transform",
"comment": "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": [
"StructureMap"
],
"system": false,
"type": true,
"instance": true,
"parameter": [
{
"name": "source",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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",
"type": "uri"
},
{
"name": "content",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The logical content to transform",
"type": "Resource"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The result of the transform",
"type": "Resource"
}
]
}
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.