Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU 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

Operation-structuremap-transform.ttl

Example OperationDefinition/StructureMap-transform (Turtle)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative

Raw Turtle (+ also see Turtle/RDF Format Specification )

Operation Definition

@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

[] a fhir:OperationDefinition;
  fhir:Resource.id [ fhir:value "StructureMap-transform"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ]
  ];
  fhir:DomainResource.extension [
     fhir:index 0;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
     fhir:Extension.value [ fhir:value "2" ]
  ], [
     fhir:index 1;
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
     fhir:Extension.value [ fhir:value "trial-use" ]
  ];
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/StructureMap-transform"];
  fhir:OperationDefinition.version [ fhir:value "4.3.0"];
  fhir:OperationDefinition.name [ fhir:value "Transform"];
  fhir:OperationDefinition.title [ fhir:value "Model Instance Transformation"];
  fhir:OperationDefinition.status [ fhir:value "draft"];
  fhir:OperationDefinition.kind [ fhir:value "operation"];
  fhir:OperationDefinition.experimental [ fhir:value "false"];
  fhir:OperationDefinition.date [ fhir:value "2022-05-28T12:47:40+10:00"];
  fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"];
  fhir:OperationDefinition.contact [
     fhir:index 0;
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ], [
       fhir:index 1;
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
     ]
  ];
  fhir:OperationDefinition.description [ fhir:value "The transform operation takes input content, applies a structure map transform, and then returns the output."];
  fhir:OperationDefinition.affectsState [ fhir:value "false"];
  fhir:OperationDefinition.code [ fhir:value "transform"];
  fhir:OperationDefinition.comment [ fhir:value "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"];
  fhir:OperationDefinition.resource [
     fhir:value "StructureMap";
     fhir:index 0
  ];
  fhir:OperationDefinition.system [ fhir:value "false"];
  fhir:OperationDefinition.type [ fhir:value "true"];
  fhir:OperationDefinition.instance [ fhir:value "true"];
  fhir:OperationDefinition.parameter [
     fhir:index 0;
     fhir:OperationDefinition.name [ fhir:value "source" ];
     fhir:OperationDefinition.use [ fhir:value "in" ];
     fhir:OperationDefinition.min [ fhir:value "0" ];
     fhir:OperationDefinition.max [ fhir:value "1" ];
     fhir:OperationDefinition.documentation [ fhir:value "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" ];
     fhir:OperationDefinition.type [ fhir:value "uri" ]
  ], [
     fhir:index 1;
     fhir:OperationDefinition.name [ fhir:value "content" ];
     fhir:OperationDefinition.use [ fhir:value "in" ];
     fhir:OperationDefinition.min [ fhir:value "1" ];
     fhir:OperationDefinition.max [ fhir:value "1" ];
     fhir:OperationDefinition.documentation [ fhir:value "The logical content to transform" ];
     fhir:OperationDefinition.type [ fhir:value "Resource" ]
  ], [
     fhir:index 2;
     fhir:OperationDefinition.name [ fhir:value "return" ];
     fhir:OperationDefinition.use [ fhir:value "out" ];
     fhir:OperationDefinition.min [ fhir:value "1" ];
     fhir:OperationDefinition.max [ fhir:value "1" ];
     fhir:OperationDefinition.documentation [ fhir:value "The result of the transform" ];
     fhir:OperationDefinition.type [ fhir:value "Resource" ]
  ] .

[] a fhir:OperationDefinition ;
  fhir:id [ fhir:v "StructureMap-transform"] ;
  fhir:text [
     fhir:status [ fhir:v "extensions" ]
  ] ;
  fhir:extension ( [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
     fhir:value [ fhir:v "2" ]
  ] [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
     fhir:value [ fhir:v "trial-use" ]
  ] ) ;
  fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/StructureMap-transform"], [ fhir:v "http://hl7.org/fhir/OperationDefinition/StructureMap-transform"] ;
  fhir:version [ fhir:v "5.0.0-draft-final"], [ fhir:v "5.0.0-draft-final"] ;
  fhir:name [ fhir:v "Transform"], [ fhir:v "Transform"] ;
  fhir:title [ fhir:v "Model Instance Transformation"], [ fhir:v "Model Instance Transformation"] ;
  fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ;
  fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
  fhir:date [ fhir:v "2023-03-01T23:03:57+11:00"], [ fhir:v "2023-03-01T23:03:57+11:00"] ;
  fhir:publisher [ fhir:v "HL7 (FHIR Project)"], [ fhir:v "HL7 (FHIR Project)"] ;
  fhir:contact ( [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "fhir@lists.hl7.org" ]
     ] )
  ] [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "fhir@lists.hl7.org" ]
     ] )
  ] ) ;
  fhir:description [ fhir:v "The transform operation takes input content, applies a structure map transform, and then returns the output."], [ fhir:v "The transform operation takes input content, applies a structure map transform, and then returns the output."] ;
  fhir:jurisdiction ( [
     fhir:coding ( [
       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
       fhir:code [ fhir:v "001" ] ;
       fhir:display [ fhir:v "World" ]
     ] )
  ] [
     fhir:coding ( [
       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
       fhir:code [ fhir:v "001" ] ;
       fhir:display [ fhir:v "World" ]
     ] )
  ] ) ;
  fhir:kind [ fhir:v "operation"] ;
  fhir:affectsState [ fhir:v "false"] ;
  fhir:code [ fhir:v "transform"] ;
  fhir:comment [ fhir:v "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"] ;
  fhir:resource ( [ fhir:v "StructureMap"] ) ;
  fhir:system [ fhir:v "false"] ;
  fhir:type [ fhir:v "true"] ;
  fhir:instance [ fhir:v "true"] ;
  fhir:parameter ( [
     fhir:name [ fhir:v "source" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:scope ( [ fhir:v "type" ] ) ;
     fhir:min [ fhir:v "0" ] ;
     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "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" ] ;
     fhir:type [ fhir:v "uri" ]
  ] [
     fhir:name [ fhir:v "sourceMap" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "0" ] ;
     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "The structure map to apply. This is only needed when the operation is invoked at the resource level and no URI has been provided." ] ;
     fhir:type [ fhir:v "StructureMap" ]
  ] [
     fhir:name [ fhir:v "supportingMap" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "0" ] ;
     fhir:max [ fhir:v "*" ] ;
     fhir:documentation [ fhir:v "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)." ] ;
     fhir:type [ fhir:v "StructureMap" ]
  ] [
     fhir:name [ fhir:v "srcMap" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "0" ] ;
     fhir:max [ fhir:v "*" ] ;
     fhir:documentation [ fhir:v "The same as structureMap, but the resource is provided in the mapping language rather than as a structureMap." ] ;
     fhir:type [ fhir:v "string" ]
  ] [
     fhir:name [ fhir:v "content" ] ;
     fhir:use [ fhir:v "in" ] ;
     fhir:min [ fhir:v "1" ] ;
     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "The logical content to transform" ] ;
     fhir:type [ fhir:v "Resource" ]
  ] [
     fhir:name [ fhir:v "return" ] ;
     fhir:use [ fhir:v "out" ] ;
     fhir:min [ fhir:v "1" ] ;
     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "The result of the transform" ] ;
     fhir:type [ fhir:v "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.