FHIR Mapping Language (FML)
0.1.0 - STU 1
FHIR Mapping Language (FML)
0.1.0 - STU 1
FHIR Mapping Language (FML), published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/mapping-language-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "OperationDefinition",
"id" : "StructureMap-transform",
"meta" : {
"lastUpdated" : "2021-01-05T10:01:24.148+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition StructureMap-transform</b></p><a name=\"StructureMap-transform\"> </a><a name=\"hcStructureMap-transform\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Last updated: 2021-01-05 10:01:24+1100</p></div><p>URL: [base]/StructureMap/$transform</p><p>URL: [base]/StructureMap/[id]/$transform</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>source</td><td>type</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#uri\">uri</a></td><td/><td><div><p>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</p>\n</div></td></tr><tr><td>IN</td><td>sourceMap</td><td/><td>0..1</td><td><a href=\"StructureDefinition-StructureMap.html\">StructureMap</a></td><td/><td><div><p>The structure map to apply. This is only needed when the operation is invoked at the resource level and no URI has been provided.</p>\n</div></td></tr><tr><td>IN</td><td>supportingMap</td><td/><td>0..*</td><td><a href=\"StructureDefinition-StructureMap.html\">StructureMap</a></td><td/><td><div><p>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).</p>\n</div></td></tr><tr><td>IN</td><td>srcMap</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td/><td><div><p>The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap.</p>\n</div></td></tr><tr><td>IN</td><td>content</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/resource.html\">Resource</a></td><td/><td><div><p>The logical content to transform</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/resource.html\">Resource</a></td><td/><td><div><p>The result of the transform</p>\n</div></td></tr></table><div><p>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 <a href=\"binary.html\">Binary</a> 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</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"extension" : [
{
"url" : "list",
"valueString" : "1"
},
{
"url" : "response",
"valueBoolean" : false
},
{
"url" : "content",
"valueString" : "$transform-request.txt"
}
],
"url" : "http://hl7.org/fhir/build/StructureDefinition/example"
},
{
"extension" : [
{
"url" : "list",
"valueString" : "1"
},
{
"url" : "response",
"valueBoolean" : true
},
{
"url" : "content",
"valueString" : "$transform-response.txt"
}
],
"url" : "http://hl7.org/fhir/build/StructureDefinition/example"
},
{
"url" : "http://hl7.org/fhir/build/StructureDefinition/footer",
"valueMarkdown" : "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"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}
],
"url" : "http://hl7.org/fhir/build/OperationDefinition/StructureMap-transform",
"version" : "0.1.0",
"name" : "Transform",
"title" : "Model Instance Transformation",
"status" : "draft",
"kind" : "operation",
"date" : "2023-02-21T10:17:24+11:00",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"name" : "HL7 International / FHIR Infrastructure",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "The transform operation takes input content, applies a structure map transform, and then returns the output.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"affectsState" : false,
"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",
"scope" : [
"type"
],
"min" : 0,
"max" : "1",
"documentation" : "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" : "uri"
},
{
"name" : "sourceMap",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "StructureMap"
},
{
"name" : "supportingMap",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "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" : "StructureMap"
},
{
"name" : "srcMap",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap.",
"type" : "string"
},
{
"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"
}
]
}
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.fml#0.1.0 based on FHIR 6.0.0-ballot3. Generated 2026-07-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change