FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.fml
Resource TypeOperationDefinition
IdOperationDefinition-StructureMap-transform.json
FHIR VersionR6
Sourcehttps://build.fhir.org/ig/HL7/mapping-language-ig/OperationDefinition-StructureMap-transform.html
URLhttp://hl7.org/fhir/build/OperationDefinition/StructureMap-transform
Version0.1.0
Statusactive
Date2023-02-21T10:17:24+11:00
NameTransform
TitleModel Instance Transformation
Realmuv
Authorityhl7
DescriptionThe transform operation takes input content, applies a structure map transform, and then returns the output.
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition StructureMap-transform

Last updated: 2021-01-05 10:01:24+1100

URL: [base]/StructureMap/$transform

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsourcetype0..1uri

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

INsourceMap0..1StructureMap

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

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

INsrcMap0..*string

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

INcontent1..1Resource

The logical content to transform

OUTreturn1..1Resource

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


Source1

{
  "resourceType": "OperationDefinition",
  "id": "StructureMap-transform",
  "meta": {
    "lastUpdated": "2021-01-05T10:01:24.148+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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": "active",
  "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"
    }
  ]
}