FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

7.9 Resource StructureMap - Content

FHIR Infrastructure icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

A Map of relationships between 2 structures that can be used to transform data.

The StructureMap resource defines a detailed set of rules that describe how one Structure is related to another and provides sufficient detail to allow for automated conversion of instances.

The intention of the structure map resource is to allow a specialist in formats and interoperability to specify the full relationships between two structures (e.g. a CDA document and a set of FHIR resources), and then many different systems - both testing and production clinical systems - can leverage that to automatically transform from one format to the other.

Maps are unidirectional: they map from the source structure to the target structure, and no reverse map is implied. Even if the mapping is simple, and loss-less, it cannot be assumed that there are no conditions that might additionally apply in the reverse direction.

The mapping language, along with a concrete syntax, is defined in detail in the FHIR Mapping Language. The StructureMap resource represents the abstract syntax, and the concrete syntax is the recommended narrative representation for a StructureMap. See also the Tutorial.

Note that many mappings between models only establish conceptual equivalence between the structures. These models are useful because they quickly convey how the structures are related to humans, whereas more maps with sufficient detail to support instance transformation are necessarily full of fine detail that can obscure the conceptual relationships. The ConceptMap resource is suitable for representing high level relationships between models, while this StructureMap resource is intended to describe the full details that need to be known in order to transform an instance of data from one structure to another.

The StructureMap resource assumes that both the source and the target models are fully defined using StructureDefinition resources - either resources, or logical models, and is described accordingly. However, there is no direct relationship between the mapping language contained in the StructureMap resource, and the existence of the appropriate structure definitions, so that this mapping language could be used to define a map from an HL7 V2 message to a CDA document. Note, that various implementation contexts may introduce a direct relationship (e.g. see [op to defined]).

It's possible to apply the mapping language to structures that do not even have (or cannot have) formally defined types, although the type-related parts of the mapping language cannot be used in these cases.

The Mapping Language and the StructureMap resource are built on top of FHIRPath, and a FHIRPath implementation is required in order to execute a StructureMap.

Each structure map contains, in addition to the standard metadata that all conformance resources contain, the following information:

  • A list of the structure definitions referenced by the map
  • A list of other structure maps that the map uses
  • One or more groups of rules that describe how content in the source is transformed to content in the target

Each group of rules defines a set of input and output variables that must be passed when the group is invoked in a particular context. When a group is invoked, all the rules in the group are checked to see whether they apply.

Each rule may have some or all of the following properties:

  • A name - used as the identity in internal references, and traces
  • Contexts in both source and target models that define where the rule applies
  • A set of source elements that provide data to be mapped
  • Conditions that specify if the rule is to apply
  • A set of target elements that will be created
  • Transform rules that describe how raw data is converted from the source format to the target format (e.g. string manipulation)
  • Flags for how instances that can repeat are handled
  • Additional rules that apply to the newly created elements (e.g. new contexts)

The mapping language is entirely declarative; there is no imperative or procedural aspects to the definitions.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. StructureMap TUDomainResourceA Map of relationships between 2 structures that can be used to transform data
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC1..1uriCanonical identifier for this structure map, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the structure map

... version Σ0..1stringBusiness version of the structure map
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this structure map (computer friendly)
... title ΣT0..1stringName for this structure map (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the structure map
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for structure map (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this structure map is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... structure Σ0..*BackboneElementStructure Definition used by this map

.... url Σ1..1canonical(StructureDefinition)Canonical reference to structure definition
.... mode Σ1..1codesource | queried | target | produced
Binding: Structure Map Model Mode (Required)
.... alias Σ0..1stringName for type in this map
.... documentation 0..1stringDocumentation on use of structure
... import Σ0..*canonical(StructureMap)Other maps used by this map (canonical URLs)

... const Σ0..*BackboneElementDefinition of the constant value used in the map rules

.... name Σ0..1idConstant name
.... value Σ0..1stringFHIRPath exression - value of the constant
... group Σ1..*BackboneElementNamed sections for reader convenience

.... name Σ1..1idHuman-readable label
.... extends Σ0..1idAnother group that this group adds rules to
.... typeMode Σ0..1codetypes | type-and-types
Binding: Structure Map Group Type Mode (Required)
.... documentation Σ0..1stringAdditional description/explanation for group
.... input Σ1..*BackboneElementNamed instance provided when invoking the map

..... name Σ1..1idName for this instance of data
..... type Σ0..1stringType for this instance of data
..... mode Σ1..1codesource | target
Binding: Structure Map Input Mode (Required)
..... documentation 0..1stringDocumentation for this instance of data
.... rule Σ0..*BackboneElementTransform Rule from source to target

..... name Σ0..1idName of the rule for internal references
..... source Σ1..*BackboneElementSource inputs to the mapping

...... context Σ1..1idType or variable this rule applies to
...... min Σ0..1integerSpecified minimum cardinality
...... max Σ0..1stringSpecified maximum cardinality (number or *)
...... type Σ0..1stringRule only applies if source has this type
...... defaultValue Σ0..1stringDefault value if no value exists
...... element Σ0..1stringOptional field for this source
...... listMode Σ0..1codefirst | not_first | last | not_last | only_one
Binding: Structure Map Source List Mode (Required)
...... variable Σ0..1idNamed context for field, if a field is specified
...... condition Σ0..1stringFHIRPath expression - must be true or the rule does not apply
...... check Σ0..1stringFHIRPath expression - must be true or the mapping engine throws an error instead of completing
...... logMessage Σ0..1stringMessage to put in log if source exists (FHIRPath)
..... target ΣC0..*BackboneElementContent to create because of this mapping rule
+ Rule: Can only have an element if you have a context

...... context ΣC0..1stringVariable this rule applies to
...... element ΣC0..1stringField to create in the context
...... variable Σ0..1idNamed context for field, if desired, and a field is specified
...... listMode Σ0..*codefirst | share | last | single
Binding: Structure Map Target List Mode (Required)

...... listRuleId Σ0..1idInternal rule reference for shared list items
...... transform Σ0..1codecreate | copy +
Binding: Structure Map Transform (Required)
...... parameter Σ0..*BackboneElementParameters to the transform

....... value[x] Σ1..1Parameter value - variable or literal
........ valueIdid
........ valueStringstring
........ valueBooleanboolean
........ valueIntegerinteger
........ valueDecimaldecimal
........ valueDatedate
........ valueTimetime
........ valueDateTimedateTime
..... rule Σ0..*see ruleRules contained in this rule

..... dependent Σ0..*BackboneElementWhich other rules to apply in the context of this rule

...... name Σ1..1idName of a rule or group to apply
...... parameter Σ1..*see parameterParameter to pass to the rule or group

..... documentation 0..1stringDocumentation for this instance of data

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

StructureMap (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different serversurl : uri [1..1]A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the structure maptitle : string [0..1]The status of this structure map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the structure map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the structure mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the structure map from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instancesuseContext : UsageContext [0..*]A legal or geographic region in which the structure map is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this structure map is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure mapcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]Other maps used by this map (canonical URLs)import : canonical [0..*] « StructureMap »StructureThe canonical reference to the structureurl : canonical [1..1] « StructureDefinition »How the referenced structure is used in this mappingmode : code [1..1] « null (Strength=Required)StructureMapModelMode! »The name used for this type in the mapalias : string [0..1]Documentation that describes how the structure is used in the mappingdocumentation : string [0..1]ConstOther maps used by this map (canonical URLs)name : id [0..1]A FHIRPath expression that is the value of this variablevalue : string [0..1]GroupA unique name for the group for the convenience of human readersname : id [1..1]Another group that this group adds rules toextends : id [0..1]If this is the default rule set to apply for the source type or this combination of typestypeMode : code [0..1] « null (Strength=Required)StructureMapGroupTypeMode! »Additional supporting documentation that explains the purpose of the group and the types of mappings within itdocumentation : string [0..1]InputName for this instance of dataname : id [1..1]Type for this instance of datatype : string [0..1]Mode for this instance of datamode : code [1..1] « null (Strength=Required)StructureMapInputMode! »Documentation for this instance of datadocumentation : string [0..1]RuleName of the rule for internal referencesname : id [0..1]Documentation for this instance of datadocumentation : string [0..1]SourceType or variable this rule applies tocontext : id [1..1]Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input contentmin : integer [0..1]Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value)max : string [0..1]Specified type for the element. This works as a condition on the mapping - use for polymorphic elementstype : string [0..1]A value to use if there is no existing value in the source objectdefaultValue : string [0..1]Optional field for this sourceelement : string [0..1]How to handle the list mode for this elementlistMode : code [0..1] « null (Strength=Required)StructureMapSourceListMode! »Named context for field, if a field is specifiedvariable : id [0..1]FHIRPath expression - must be true or the rule does not applycondition : string [0..1]FHIRPath expression - must be true or the mapping engine throws an error instead of completingcheck : string [0..1]A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is foundlogMessage : string [0..1]TargetVariable this rule applies tocontext : string [0..1] « This element has or is affected by some invariantsC »Field to create in the contextelement : string [0..1] « This element has or is affected by some invariantsC »Named context for field, if desired, and a field is specifiedvariable : id [0..1]If field is a list, how to manage the listlistMode : code [0..*] « null (Strength=Required)StructureMapTargetListMode! »Internal rule reference for shared list itemslistRuleId : id [0..1]How the data is copied / createdtransform : code [0..1] « null (Strength=Required)StructureMapTransform! »ParameterParameter value - variable or literalvalue[x] : PrimitiveType [1..1] « id|string|boolean|integer|decimal| date|time|dateTime »DependentName of a rule or group to applyname : id [1..1]A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are producedstructure[0..*]Definition of a constant value used in the map rulesconst[0..*]A name assigned to an instance of data. The instance must be provided when the mapping is invokedinput[1..*]Source inputs to the mappingsource[1..*]Parameters to the transformparameter[0..*]Content to create because of this mapping ruletarget[0..*]Rules contained in this rulerule[0..*]Parameter to pass to the rule or groupparameter[1..*]Which other rules to apply in the context of this ruledependent[0..*]Transform Rule from source to targetrule[0..*]Organizes the mapping into managable chunks for human review/ease of maintenancegroup[1..*]

XML Template

<StructureMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Canonical identifier for this structure map, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the structure map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the structure map -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this structure map (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this structure map (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the structure map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for structure map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this structure map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <structure>  <!-- 0..* Structure Definition used by this map -->
  <url><!-- 1..1 canonical(StructureDefinition) Canonical reference to structure definition --></url>
  <mode value="[code]"/><!-- 1..1 source | queried | target | produced -->
  <alias value="[string]"/><!-- 0..1 Name for type in this map -->
  <documentation value="[string]"/><!-- 0..1 Documentation on use of structure -->
 </structure>
 <import><!-- 0..* canonical(StructureMap) Other maps used by this map (canonical URLs) --></import>
 <const>  <!-- 0..* Definition of the constant value used in the map rules -->
  <name value="[id]"/><!-- 0..1 Constant name -->
  <value value="[string]"/><!-- 0..1 FHIRPath exression - value of the constant -->
 </const>
 <group>  <!-- 1..* Named sections for reader convenience -->
  <name value="[id]"/><!-- 1..1 Human-readable label -->
  <extends value="[id]"/><!-- 0..1 Another group that this group adds rules to -->
  <typeMode value="[code]"/><!-- 0..1 types | type-and-types -->
  <documentation value="[string]"/><!-- 0..1 Additional description/explanation for group -->
  <input>  <!-- 1..* Named instance provided when invoking the map -->
   <name value="[id]"/><!-- 1..1 Name for this instance of data -->
   <type value="[string]"/><!-- 0..1 Type for this instance of data -->
   <mode value="[code]"/><!-- 1..1 source | target -->
   <documentation value="[string]"/><!-- 0..1 Documentation for this instance of data -->
  </input>
  <rule>  <!-- 0..* Transform Rule from source to target -->
   <name value="[id]"/><!-- 0..1 Name of the rule for internal references -->
   <source>  <!-- 1..* Source inputs to the mapping -->
    <context value="[id]"/><!-- 1..1 Type or variable this rule applies to -->
    <min value="[integer]"/><!-- 0..1 Specified minimum cardinality -->
    <max value="[string]"/><!-- 0..1 Specified maximum cardinality (number or *) -->
    <type value="[string]"/><!-- 0..1 Rule only applies if source has this type -->
    <defaultValue value="[string]"/><!-- 0..1 Default value if no value exists -->
    <element value="[string]"/><!-- 0..1 Optional field for this source -->
    <listMode value="[code]"/><!-- 0..1 first | not_first | last | not_last | only_one -->
    <variable value="[id]"/><!-- 0..1 Named context for field, if a field is specified -->
    <condition value="[string]"/><!-- 0..1 FHIRPath expression  - must be true or the rule does not apply -->
    <check value="[string]"/><!-- 0..1 FHIRPath expression  - must be true or the mapping engine throws an error instead of completing -->
    <logMessage value="[string]"/><!-- 0..1 Message to put in log if source exists (FHIRPath) -->
   </source>
   <target>  <!-- 0..* Content to create because of this mapping rule -->
    <context value="[string]"/><!-- I 0..1 Variable this rule applies to -->
    <element value="[string]"/><!-- I 0..1 Field to create in the context -->
    <variable value="[id]"/><!-- 0..1 Named context for field, if desired, and a field is specified -->
    <listMode value="[code]"/><!-- 0..* first | share | last | single -->
    <listRuleId value="[id]"/><!-- 0..1 Internal rule reference for shared list items -->
    <transform value="[code]"/><!-- 0..1 create | copy + -->
    <parameter>  <!-- 0..* Parameters to the transform -->
     <value[x]><!-- 1..1 id|string|boolean|integer|decimal|date|time|dateTime Parameter value - variable or literal --></value[x]>
    </parameter>
   </target>
   <rule><!-- 0..* Content as for StructureMap.group.rule Rules contained in this rule --></rule>
   <dependent>  <!-- 0..* Which other rules to apply in the context of this rule -->
    <name value="[id]"/><!-- 1..1 Name of a rule or group to apply -->
    <parameter><!-- 1..* Content as for StructureMap.group.rule.target.parameter Parameter to pass to the rule or group --></parameter>
   </dependent>
   <documentation value="[string]"/><!-- 0..1 Documentation for this instance of data -->
  </rule>
 </group>
</StructureMap>

JSON Template

{doco
  "resourceType" : "StructureMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Canonical identifier for this structure map, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the structure map
  "version" : "<string>", // Business version of the structure map
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this structure map (computer friendly)
  "title" : "<string>", // Name for this structure map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the structure map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for structure map (if applicable)
  "purpose" : "<markdown>", // Why this structure map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "structure" : [{ // Structure Definition used by this map
    "url" : "<canonical(StructureDefinition)>", // R!  Canonical reference to structure definition
    "mode" : "<code>", // R!  source | queried | target | produced
    "alias" : "<string>", // Name for type in this map
    "documentation" : "<string>" // Documentation on use of structure
  }],
  "import" : ["<canonical(StructureMap)>"], // Other maps used by this map (canonical URLs)
  "const" : [{ // Definition of the constant value used in the map rules
    "name" : "<id>", // Constant name
    "value" : "<string>" // FHIRPath exression - value of the constant
  }],
  "group" : [{ // R!  Named sections for reader convenience
    "name" : "<id>", // R!  Human-readable label
    "extends" : "<id>", // Another group that this group adds rules to
    "typeMode" : "<code>", // types | type-and-types
    "documentation" : "<string>", // Additional description/explanation for group
    "input" : [{ // R!  Named instance provided when invoking the map
      "name" : "<id>", // R!  Name for this instance of data
      "type" : "<string>", // Type for this instance of data
      "mode" : "<code>", // R!  source | target
      "documentation" : "<string>" // Documentation for this instance of data
    }],
    "rule" : [{ // Transform Rule from source to target
      "name" : "<id>", // Name of the rule for internal references
      "source" : [{ // R!  Source inputs to the mapping
        "context" : "<id>", // R!  Type or variable this rule applies to
        "min" : <integer>, // Specified minimum cardinality
        "max" : "<string>", // Specified maximum cardinality (number or *)
        "type" : "<string>", // Rule only applies if source has this type
        "defaultValue" : "<string>", // Default value if no value exists
        "element" : "<string>", // Optional field for this source
        "listMode" : "<code>", // first | not_first | last | not_last | only_one
        "variable" : "<id>", // Named context for field, if a field is specified
        "condition" : "<string>", // FHIRPath expression  - must be true or the rule does not apply
        "check" : "<string>", // FHIRPath expression  - must be true or the mapping engine throws an error instead of completing
        "logMessage" : "<string>" // Message to put in log if source exists (FHIRPath)
      }],
      "target" : [{ // Content to create because of this mapping rule
        "context" : "<string>", // I Variable this rule applies to
        "element" : "<string>", // I Field to create in the context
        "variable" : "<id>", // Named context for field, if desired, and a field is specified
        "listMode" : ["<code>"], // first | share | last | single
        "listRuleId" : "<id>", // Internal rule reference for shared list items
        "transform" : "<code>", // create | copy +
        "parameter" : [{ // Parameters to the transform
          // value[x]: Parameter value - variable or literal. One of these 8:
          "valueId" : "<id>",
          "valueString" : "<string>",
          "valueBoolean" : <boolean>,
          "valueInteger" : <integer>,
          "valueDecimal" : <decimal>,
          "valueDate" : "<date>",
          "valueTime" : "<time>",
          "valueDateTime" : "<dateTime>"
        }]
      }],
      "rule" : [{ Content as for StructureMap.group.rule }], // Rules contained in this rule
      "dependent" : [{ // Which other rules to apply in the context of this rule
        "name" : "<id>", // R!  Name of a rule or group to apply
        "parameter" : [{ Content as for StructureMap.group.rule.target.parameter }] // R!  Parameter to pass to the rule or group
      }],
      "documentation" : "<string>" // Documentation for this instance of data
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:StructureMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 1..1 Canonical identifier for this structure map, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the structure map
  fhir:version [ string ] ; # 0..1 Business version of the structure map
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this structure map (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this structure map (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the structure map
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for structure map (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this structure map is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:structure ( [ # 0..* Structure Definition used by this map
    fhir:url [ canonical(StructureDefinition) ] ; # 1..1 Canonical reference to structure definition
    fhir:mode [ code ] ; # 1..1 source | queried | target | produced
    fhir:alias [ string ] ; # 0..1 Name for type in this map
    fhir:documentation [ string ] ; # 0..1 Documentation on use of structure
  ] ... ) ;
  fhir:import  ( [ canonical(StructureMap) ] ... ) ; # 0..* Other maps used by this map (canonical URLs)
  fhir:const ( [ # 0..* Definition of the constant value used in the map rules
    fhir:name [ id ] ; # 0..1 Constant name
    fhir:value [ string ] ; # 0..1 FHIRPath exression - value of the constant
  ] ... ) ;
  fhir:group ( [ # 1..* Named sections for reader convenience
    fhir:name [ id ] ; # 1..1 Human-readable label
    fhir:extends [ id ] ; # 0..1 Another group that this group adds rules to
    fhir:typeMode [ code ] ; # 0..1 types | type-and-types
    fhir:documentation [ string ] ; # 0..1 Additional description/explanation for group
    fhir:input ( [ # 1..* Named instance provided when invoking the map
      fhir:name [ id ] ; # 1..1 Name for this instance of data
      fhir:type [ string ] ; # 0..1 Type for this instance of data
      fhir:mode [ code ] ; # 1..1 source | target
      fhir:documentation [ string ] ; # 0..1 Documentation for this instance of data
    ] ... ) ;
    fhir:rule ( [ # 0..* Transform Rule from source to target
      fhir:name [ id ] ; # 0..1 Name of the rule for internal references
      fhir:source ( [ # 1..* Source inputs to the mapping
        fhir:context [ id ] ; # 1..1 Type or variable this rule applies to
        fhir:min [ integer ] ; # 0..1 Specified minimum cardinality
        fhir:max [ string ] ; # 0..1 Specified maximum cardinality (number or *)
        fhir:type [ string ] ; # 0..1 Rule only applies if source has this type
        fhir:defaultValue [ string ] ; # 0..1 Default value if no value exists
        fhir:element [ string ] ; # 0..1 Optional field for this source
        fhir:listMode [ code ] ; # 0..1 first | not_first | last | not_last | only_one
        fhir:variable [ id ] ; # 0..1 Named context for field, if a field is specified
        fhir:condition [ string ] ; # 0..1 FHIRPath expression  - must be true or the rule does not apply
        fhir:check [ string ] ; # 0..1 FHIRPath expression  - must be true or the mapping engine throws an error instead of completing
        fhir:logMessage [ string ] ; # 0..1 Message to put in log if source exists (FHIRPath)
      ] ... ) ;
      fhir:target ( [ # 0..* Content to create because of this mapping rule
        fhir:context [ string ] ; # 0..1 I Variable this rule applies to
        fhir:element [ string ] ; # 0..1 I Field to create in the context
        fhir:variable [ id ] ; # 0..1 Named context for field, if desired, and a field is specified
        fhir:listMode  ( [ code ] ... ) ; # 0..* first | share | last | single
        fhir:listRuleId [ id ] ; # 0..1 Internal rule reference for shared list items
        fhir:transform [ code ] ; # 0..1 create | copy +
        fhir:parameter ( [ # 0..* Parameters to the transform
          # value[x] : 1..1 Parameter value - variable or literal. One of these 8
            fhir:value [  a fhir:id ; id ]
            fhir:value [  a fhir:string ; string ]
            fhir:value [  a fhir:boolean ; boolean ]
            fhir:value [  a fhir:integer ; integer ]
            fhir:value [  a fhir:decimal ; decimal ]
            fhir:value [  a fhir:date ; date ]
            fhir:value [  a fhir:time ; time ]
            fhir:value [  a fhir:dateTime ; dateTime ]
        ] ... ) ;
      ] ... ) ;
      fhir:rule  ( [ See StructureMap.group.rule ] ... ) ; # 0..* Rules contained in this rule
      fhir:dependent ( [ # 0..* Which other rules to apply in the context of this rule
        fhir:name [ id ] ; # 1..1 Name of a rule or group to apply
        fhir:parameter  ( [ See StructureMap.group.rule.target.parameter ] ... ) ; # 1..* Parameter to pass to the rule or group
      ] ... ) ;
      fhir:documentation [ string ] ; # 0..1 Documentation for this instance of data
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

StructureMap
StructureMap.versionAlgorithm[x]
  • Added Element
StructureMap.copyrightLabel
  • Added Element
StructureMap.const
  • Added Element
StructureMap.const.name
  • Added Element
StructureMap.const.value
  • Added Element
StructureMap.group.typeMode
  • Min Cardinality changed from 1 to 0
  • Remove code none
StructureMap.group.rule
  • Min Cardinality changed from 1 to 0
StructureMap.group.rule.name
  • Min Cardinality changed from 1 to 0
StructureMap.group.rule.source.defaultValue
  • Renamed from defaultValue[x] to defaultValue
  • Remove Types base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
StructureMap.group.rule.target.context
  • Type changed from id to string
StructureMap.group.rule.target.listMode
  • Remove code collate
  • Add code single
StructureMap.group.rule.target.parameter.value[x]
  • Add Types date, time, dateTime
StructureMap.group.rule.dependent.parameter
  • Renamed from variable to parameter
  • Remove Type string
StructureMap.group.rule.target.contextType
  • Deleted (now implied by context)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. StructureMap TUDomainResourceA Map of relationships between 2 structures that can be used to transform data
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC1..1uriCanonical identifier for this structure map, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the structure map

... version Σ0..1stringBusiness version of the structure map
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this structure map (computer friendly)
... title ΣT0..1stringName for this structure map (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the structure map
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for structure map (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this structure map is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... structure Σ0..*BackboneElementStructure Definition used by this map

.... url Σ1..1canonical(StructureDefinition)Canonical reference to structure definition
.... mode Σ1..1codesource | queried | target | produced
Binding: Structure Map Model Mode (Required)
.... alias Σ0..1stringName for type in this map
.... documentation 0..1stringDocumentation on use of structure
... import Σ0..*canonical(StructureMap)Other maps used by this map (canonical URLs)

... const Σ0..*BackboneElementDefinition of the constant value used in the map rules

.... name Σ0..1idConstant name
.... value Σ0..1stringFHIRPath exression - value of the constant
... group Σ1..*BackboneElementNamed sections for reader convenience

.... name Σ1..1idHuman-readable label
.... extends Σ0..1idAnother group that this group adds rules to
.... typeMode Σ0..1codetypes | type-and-types
Binding: Structure Map Group Type Mode (Required)
.... documentation Σ0..1stringAdditional description/explanation for group
.... input Σ1..*BackboneElementNamed instance provided when invoking the map

..... name Σ1..1idName for this instance of data
..... type Σ0..1stringType for this instance of data
..... mode Σ1..1codesource | target
Binding: Structure Map Input Mode (Required)
..... documentation 0..1stringDocumentation for this instance of data
.... rule Σ0..*BackboneElementTransform Rule from source to target

..... name Σ0..1idName of the rule for internal references
..... source Σ1..*BackboneElementSource inputs to the mapping

...... context Σ1..1idType or variable this rule applies to
...... min Σ0..1integerSpecified minimum cardinality
...... max Σ0..1stringSpecified maximum cardinality (number or *)
...... type Σ0..1stringRule only applies if source has this type
...... defaultValue Σ0..1stringDefault value if no value exists
...... element Σ0..1stringOptional field for this source
...... listMode Σ0..1codefirst | not_first | last | not_last | only_one
Binding: Structure Map Source List Mode (Required)
...... variable Σ0..1idNamed context for field, if a field is specified
...... condition Σ0..1stringFHIRPath expression - must be true or the rule does not apply
...... check Σ0..1stringFHIRPath expression - must be true or the mapping engine throws an error instead of completing
...... logMessage Σ0..1stringMessage to put in log if source exists (FHIRPath)
..... target ΣC0..*BackboneElementContent to create because of this mapping rule
+ Rule: Can only have an element if you have a context

...... context ΣC0..1stringVariable this rule applies to
...... element ΣC0..1stringField to create in the context
...... variable Σ0..1idNamed context for field, if desired, and a field is specified
...... listMode Σ0..*codefirst | share | last | single
Binding: Structure Map Target List Mode (Required)

...... listRuleId Σ0..1idInternal rule reference for shared list items
...... transform Σ0..1codecreate | copy +
Binding: Structure Map Transform (Required)
...... parameter Σ0..*BackboneElementParameters to the transform

....... value[x] Σ1..1Parameter value - variable or literal
........ valueIdid
........ valueStringstring
........ valueBooleanboolean
........ valueIntegerinteger
........ valueDecimaldecimal
........ valueDatedate
........ valueTimetime
........ valueDateTimedateTime
..... rule Σ0..*see ruleRules contained in this rule

..... dependent Σ0..*BackboneElementWhich other rules to apply in the context of this rule

...... name Σ1..1idName of a rule or group to apply
...... parameter Σ1..*see parameterParameter to pass to the rule or group

..... documentation 0..1stringDocumentation for this instance of data

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

StructureMap (DomainResource) +CanonicalResourceAn absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different serversurl : uri [1..1]A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the structure maptitle : string [0..1]The status of this structure map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the structure map was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the structure mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the structure map from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instancesuseContext : UsageContext [0..*]A legal or geographic region in which the structure map is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this structure map is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure mapcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]Other maps used by this map (canonical URLs)import : canonical [0..*] « StructureMap »StructureThe canonical reference to the structureurl : canonical [1..1] « StructureDefinition »How the referenced structure is used in this mappingmode : code [1..1] « null (Strength=Required)StructureMapModelMode! »The name used for this type in the mapalias : string [0..1]Documentation that describes how the structure is used in the mappingdocumentation : string [0..1]ConstOther maps used by this map (canonical URLs)name : id [0..1]A FHIRPath expression that is the value of this variablevalue : string [0..1]GroupA unique name for the group for the convenience of human readersname : id [1..1]Another group that this group adds rules toextends : id [0..1]If this is the default rule set to apply for the source type or this combination of typestypeMode : code [0..1] « null (Strength=Required)StructureMapGroupTypeMode! »Additional supporting documentation that explains the purpose of the group and the types of mappings within itdocumentation : string [0..1]InputName for this instance of dataname : id [1..1]Type for this instance of datatype : string [0..1]Mode for this instance of datamode : code [1..1] « null (Strength=Required)StructureMapInputMode! »Documentation for this instance of datadocumentation : string [0..1]RuleName of the rule for internal referencesname : id [0..1]Documentation for this instance of datadocumentation : string [0..1]SourceType or variable this rule applies tocontext : id [1..1]Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input contentmin : integer [0..1]Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value)max : string [0..1]Specified type for the element. This works as a condition on the mapping - use for polymorphic elementstype : string [0..1]A value to use if there is no existing value in the source objectdefaultValue : string [0..1]Optional field for this sourceelement : string [0..1]How to handle the list mode for this elementlistMode : code [0..1] « null (Strength=Required)StructureMapSourceListMode! »Named context for field, if a field is specifiedvariable : id [0..1]FHIRPath expression - must be true or the rule does not applycondition : string [0..1]FHIRPath expression - must be true or the mapping engine throws an error instead of completingcheck : string [0..1]A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is foundlogMessage : string [0..1]TargetVariable this rule applies tocontext : string [0..1] « This element has or is affected by some invariantsC »Field to create in the contextelement : string [0..1] « This element has or is affected by some invariantsC »Named context for field, if desired, and a field is specifiedvariable : id [0..1]If field is a list, how to manage the listlistMode : code [0..*] « null (Strength=Required)StructureMapTargetListMode! »Internal rule reference for shared list itemslistRuleId : id [0..1]How the data is copied / createdtransform : code [0..1] « null (Strength=Required)StructureMapTransform! »ParameterParameter value - variable or literalvalue[x] : PrimitiveType [1..1] « id|string|boolean|integer|decimal| date|time|dateTime »DependentName of a rule or group to applyname : id [1..1]A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are producedstructure[0..*]Definition of a constant value used in the map rulesconst[0..*]A name assigned to an instance of data. The instance must be provided when the mapping is invokedinput[1..*]Source inputs to the mappingsource[1..*]Parameters to the transformparameter[0..*]Content to create because of this mapping ruletarget[0..*]Rules contained in this rulerule[0..*]Parameter to pass to the rule or groupparameter[1..*]Which other rules to apply in the context of this ruledependent[0..*]Transform Rule from source to targetrule[0..*]Organizes the mapping into managable chunks for human review/ease of maintenancegroup[1..*]

XML Template

<StructureMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Canonical identifier for this structure map, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the structure map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the structure map -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this structure map (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this structure map (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the structure map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for structure map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this structure map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <structure>  <!-- 0..* Structure Definition used by this map -->
  <url><!-- 1..1 canonical(StructureDefinition) Canonical reference to structure definition --></url>
  <mode value="[code]"/><!-- 1..1 source | queried | target | produced -->
  <alias value="[string]"/><!-- 0..1 Name for type in this map -->
  <documentation value="[string]"/><!-- 0..1 Documentation on use of structure -->
 </structure>
 <import><!-- 0..* canonical(StructureMap) Other maps used by this map (canonical URLs) --></import>
 <const>  <!-- 0..* Definition of the constant value used in the map rules -->
  <name value="[id]"/><!-- 0..1 Constant name -->
  <value value="[string]"/><!-- 0..1 FHIRPath exression - value of the constant -->
 </const>
 <group>  <!-- 1..* Named sections for reader convenience -->
  <name value="[id]"/><!-- 1..1 Human-readable label -->
  <extends value="[id]"/><!-- 0..1 Another group that this group adds rules to -->
  <typeMode value="[code]"/><!-- 0..1 types | type-and-types -->
  <documentation value="[string]"/><!-- 0..1 Additional description/explanation for group -->
  <input>  <!-- 1..* Named instance provided when invoking the map -->
   <name value="[id]"/><!-- 1..1 Name for this instance of data -->
   <type value="[string]"/><!-- 0..1 Type for this instance of data -->
   <mode value="[code]"/><!-- 1..1 source | target -->
   <documentation value="[string]"/><!-- 0..1 Documentation for this instance of data -->
  </input>
  <rule>  <!-- 0..* Transform Rule from source to target -->
   <name value="[id]"/><!-- 0..1 Name of the rule for internal references -->
   <source>  <!-- 1..* Source inputs to the mapping -->
    <context value="[id]"/><!-- 1..1 Type or variable this rule applies to -->
    <min value="[integer]"/><!-- 0..1 Specified minimum cardinality -->
    <max value="[string]"/><!-- 0..1 Specified maximum cardinality (number or *) -->
    <type value="[string]"/><!-- 0..1 Rule only applies if source has this type -->
    <defaultValue value="[string]"/><!-- 0..1 Default value if no value exists -->
    <element value="[string]"/><!-- 0..1 Optional field for this source -->
    <listMode value="[code]"/><!-- 0..1 first | not_first | last | not_last | only_one -->
    <variable value="[id]"/><!-- 0..1 Named context for field, if a field is specified -->
    <condition value="[string]"/><!-- 0..1 FHIRPath expression  - must be true or the rule does not apply -->
    <check value="[string]"/><!-- 0..1 FHIRPath expression  - must be true or the mapping engine throws an error instead of completing -->
    <logMessage value="[string]"/><!-- 0..1 Message to put in log if source exists (FHIRPath) -->
   </source>
   <target>  <!-- 0..* Content to create because of this mapping rule -->
    <context value="[string]"/><!-- I 0..1 Variable this rule applies to -->
    <element value="[string]"/><!-- I 0..1 Field to create in the context -->
    <variable value="[id]"/><!-- 0..1 Named context for field, if desired, and a field is specified -->
    <listMode value="[code]"/><!-- 0..* first | share | last | single -->
    <listRuleId value="[id]"/><!-- 0..1 Internal rule reference for shared list items -->
    <transform value="[code]"/><!-- 0..1 create | copy + -->
    <parameter>  <!-- 0..* Parameters to the transform -->
     <value[x]><!-- 1..1 id|string|boolean|integer|decimal|date|time|dateTime Parameter value - variable or literal --></value[x]>
    </parameter>
   </target>
   <rule><!-- 0..* Content as for StructureMap.group.rule Rules contained in this rule --></rule>
   <dependent>  <!-- 0..* Which other rules to apply in the context of this rule -->
    <name value="[id]"/><!-- 1..1 Name of a rule or group to apply -->
    <parameter><!-- 1..* Content as for StructureMap.group.rule.target.parameter Parameter to pass to the rule or group --></parameter>
   </dependent>
   <documentation value="[string]"/><!-- 0..1 Documentation for this instance of data -->
  </rule>
 </group>
</StructureMap>

JSON Template

{doco
  "resourceType" : "StructureMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Canonical identifier for this structure map, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the structure map
  "version" : "<string>", // Business version of the structure map
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this structure map (computer friendly)
  "title" : "<string>", // Name for this structure map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the structure map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for structure map (if applicable)
  "purpose" : "<markdown>", // Why this structure map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "structure" : [{ // Structure Definition used by this map
    "url" : "<canonical(StructureDefinition)>", // R!  Canonical reference to structure definition
    "mode" : "<code>", // R!  source | queried | target | produced
    "alias" : "<string>", // Name for type in this map
    "documentation" : "<string>" // Documentation on use of structure
  }],
  "import" : ["<canonical(StructureMap)>"], // Other maps used by this map (canonical URLs)
  "const" : [{ // Definition of the constant value used in the map rules
    "name" : "<id>", // Constant name
    "value" : "<string>" // FHIRPath exression - value of the constant
  }],
  "group" : [{ // R!  Named sections for reader convenience
    "name" : "<id>", // R!  Human-readable label
    "extends" : "<id>", // Another group that this group adds rules to
    "typeMode" : "<code>", // types | type-and-types
    "documentation" : "<string>", // Additional description/explanation for group
    "input" : [{ // R!  Named instance provided when invoking the map
      "name" : "<id>", // R!  Name for this instance of data
      "type" : "<string>", // Type for this instance of data
      "mode" : "<code>", // R!  source | target
      "documentation" : "<string>" // Documentation for this instance of data
    }],
    "rule" : [{ // Transform Rule from source to target
      "name" : "<id>", // Name of the rule for internal references
      "source" : [{ // R!  Source inputs to the mapping
        "context" : "<id>", // R!  Type or variable this rule applies to
        "min" : <integer>, // Specified minimum cardinality
        "max" : "<string>", // Specified maximum cardinality (number or *)
        "type" : "<string>", // Rule only applies if source has this type
        "defaultValue" : "<string>", // Default value if no value exists
        "element" : "<string>", // Optional field for this source
        "listMode" : "<code>", // first | not_first | last | not_last | only_one
        "variable" : "<id>", // Named context for field, if a field is specified
        "condition" : "<string>", // FHIRPath expression  - must be true or the rule does not apply
        "check" : "<string>", // FHIRPath expression  - must be true or the mapping engine throws an error instead of completing
        "logMessage" : "<string>" // Message to put in log if source exists (FHIRPath)
      }],
      "target" : [{ // Content to create because of this mapping rule
        "context" : "<string>", // I Variable this rule applies to
        "element" : "<string>", // I Field to create in the context
        "variable" : "<id>", // Named context for field, if desired, and a field is specified
        "listMode" : ["<code>"], // first | share | last | single
        "listRuleId" : "<id>", // Internal rule reference for shared list items
        "transform" : "<code>", // create | copy +
        "parameter" : [{ // Parameters to the transform
          // value[x]: Parameter value - variable or literal. One of these 8:
          "valueId" : "<id>",
          "valueString" : "<string>",
          "valueBoolean" : <boolean>,
          "valueInteger" : <integer>,
          "valueDecimal" : <decimal>,
          "valueDate" : "<date>",
          "valueTime" : "<time>",
          "valueDateTime" : "<dateTime>"
        }]
      }],
      "rule" : [{ Content as for StructureMap.group.rule }], // Rules contained in this rule
      "dependent" : [{ // Which other rules to apply in the context of this rule
        "name" : "<id>", // R!  Name of a rule or group to apply
        "parameter" : [{ Content as for StructureMap.group.rule.target.parameter }] // R!  Parameter to pass to the rule or group
      }],
      "documentation" : "<string>" // Documentation for this instance of data
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:StructureMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 1..1 Canonical identifier for this structure map, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the structure map
  fhir:version [ string ] ; # 0..1 Business version of the structure map
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this structure map (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this structure map (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the structure map
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for structure map (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this structure map is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:structure ( [ # 0..* Structure Definition used by this map
    fhir:url [ canonical(StructureDefinition) ] ; # 1..1 Canonical reference to structure definition
    fhir:mode [ code ] ; # 1..1 source | queried | target | produced
    fhir:alias [ string ] ; # 0..1 Name for type in this map
    fhir:documentation [ string ] ; # 0..1 Documentation on use of structure
  ] ... ) ;
  fhir:import  ( [ canonical(StructureMap) ] ... ) ; # 0..* Other maps used by this map (canonical URLs)
  fhir:const ( [ # 0..* Definition of the constant value used in the map rules
    fhir:name [ id ] ; # 0..1 Constant name
    fhir:value [ string ] ; # 0..1 FHIRPath exression - value of the constant
  ] ... ) ;
  fhir:group ( [ # 1..* Named sections for reader convenience
    fhir:name [ id ] ; # 1..1 Human-readable label
    fhir:extends [ id ] ; # 0..1 Another group that this group adds rules to
    fhir:typeMode [ code ] ; # 0..1 types | type-and-types
    fhir:documentation [ string ] ; # 0..1 Additional description/explanation for group
    fhir:input ( [ # 1..* Named instance provided when invoking the map
      fhir:name [ id ] ; # 1..1 Name for this instance of data
      fhir:type [ string ] ; # 0..1 Type for this instance of data
      fhir:mode [ code ] ; # 1..1 source | target
      fhir:documentation [ string ] ; # 0..1 Documentation for this instance of data
    ] ... ) ;
    fhir:rule ( [ # 0..* Transform Rule from source to target
      fhir:name [ id ] ; # 0..1 Name of the rule for internal references
      fhir:source ( [ # 1..* Source inputs to the mapping
        fhir:context [ id ] ; # 1..1 Type or variable this rule applies to
        fhir:min [ integer ] ; # 0..1 Specified minimum cardinality
        fhir:max [ string ] ; # 0..1 Specified maximum cardinality (number or *)
        fhir:type [ string ] ; # 0..1 Rule only applies if source has this type
        fhir:defaultValue [ string ] ; # 0..1 Default value if no value exists
        fhir:element [ string ] ; # 0..1 Optional field for this source
        fhir:listMode [ code ] ; # 0..1 first | not_first | last | not_last | only_one
        fhir:variable [ id ] ; # 0..1 Named context for field, if a field is specified
        fhir:condition [ string ] ; # 0..1 FHIRPath expression  - must be true or the rule does not apply
        fhir:check [ string ] ; # 0..1 FHIRPath expression  - must be true or the mapping engine throws an error instead of completing
        fhir:logMessage [ string ] ; # 0..1 Message to put in log if source exists (FHIRPath)
      ] ... ) ;
      fhir:target ( [ # 0..* Content to create because of this mapping rule
        fhir:context [ string ] ; # 0..1 I Variable this rule applies to
        fhir:element [ string ] ; # 0..1 I Field to create in the context
        fhir:variable [ id ] ; # 0..1 Named context for field, if desired, and a field is specified
        fhir:listMode  ( [ code ] ... ) ; # 0..* first | share | last | single
        fhir:listRuleId [ id ] ; # 0..1 Internal rule reference for shared list items
        fhir:transform [ code ] ; # 0..1 create | copy +
        fhir:parameter ( [ # 0..* Parameters to the transform
          # value[x] : 1..1 Parameter value - variable or literal. One of these 8
            fhir:value [  a fhir:id ; id ]
            fhir:value [  a fhir:string ; string ]
            fhir:value [  a fhir:boolean ; boolean ]
            fhir:value [  a fhir:integer ; integer ]
            fhir:value [  a fhir:decimal ; decimal ]
            fhir:value [  a fhir:date ; date ]
            fhir:value [  a fhir:time ; time ]
            fhir:value [  a fhir:dateTime ; dateTime ]
        ] ... ) ;
      ] ... ) ;
      fhir:rule  ( [ See StructureMap.group.rule ] ... ) ; # 0..* Rules contained in this rule
      fhir:dependent ( [ # 0..* Which other rules to apply in the context of this rule
        fhir:name [ id ] ; # 1..1 Name of a rule or group to apply
        fhir:parameter  ( [ See StructureMap.group.rule.target.parameter ] ... ) ; # 1..* Parameter to pass to the rule or group
      ] ... ) ;
      fhir:documentation [ string ] ; # 0..1 Documentation for this instance of data
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

StructureMap
StructureMap.versionAlgorithm[x]
  • Added Element
StructureMap.copyrightLabel
  • Added Element
StructureMap.const
  • Added Element
StructureMap.const.name
  • Added Element
StructureMap.const.value
  • Added Element
StructureMap.group.typeMode
  • Min Cardinality changed from 1 to 0
  • Remove code none
StructureMap.group.rule
  • Min Cardinality changed from 1 to 0
StructureMap.group.rule.name
  • Min Cardinality changed from 1 to 0
StructureMap.group.rule.source.defaultValue
  • Renamed from defaultValue[x] to defaultValue
  • Remove Types base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
StructureMap.group.rule.target.context
  • Type changed from id to string
StructureMap.group.rule.target.listMode
  • Remove code collate
  • Add code single
StructureMap.group.rule.target.parameter.value[x]
  • Add Types date, time, dateTime
StructureMap.group.rule.dependent.parameter
  • Renamed from variable to parameter
  • Remove Type string
StructureMap.group.rule.target.contextType
  • Deleted (now implied by context)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

PathValueSetTypeDocumentation
StructureMap.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

StructureMap.status PublicationStatus Required

The lifecycle status of an artifact.

StructureMap.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

StructureMap.structure.mode StructureMapModelMode Required

How the referenced structure is used in this mapping.

StructureMap.group.typeMode StructureMapGroupTypeMode Required

If this is the default rule set to apply for the source type, or this combination of types.

StructureMap.group.input.mode StructureMapInputMode Required

Mode for this instance of data.

StructureMap.group.rule.source.listMode StructureMapSourceListMode Required

If field is a list, how to manage the source.

StructureMap.group.rule.target.listMode StructureMapTargetListMode Required

If field is a list, how to manage the production.

StructureMap.group.rule.target.transform StructureMapTransform Required

How data is copied/created.

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning StructureMap.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img smp-1Rule StructureMap.group.rule.targetCan only have an element if you have a contextelement.exists() implies context.exists()

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the structure map(StructureMap.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the structure map(StructureMap.useContext.value.ofType(Quantity)) | (StructureMap.useContext.value.ofType(Range))30 Resources
context-typetokenA type of use context assigned to the structure mapStructureMap.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the structure mapOn StructureMap.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)
30 Resources
context-type-valuecompositeA use context type and value assigned to the structure mapOn StructureMap.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
30 Resources
datedateThe structure map publication dateStructureMap.date30 Resources
descriptionstringThe description of the structure mapStructureMap.description28 Resources
identifiertokenExternal identifier for the structure mapStructureMap.identifier35 Resources
jurisdictiontokenIntended jurisdiction for the structure mapStructureMap.jurisdiction26 Resources
namestringComputationally friendly name of the structure mapStructureMap.name27 Resources
publisherstringName of the publisher of the structure mapStructureMap.publisher30 Resources
statustokenThe current status of the structure mapStructureMap.status36 Resources
titlestringThe human-friendly name of the structure mapStructureMap.title27 Resources
urluriThe uri that identifies the structure mapStructureMap.url35 Resources
versiontokenThe business version of the structure mapStructureMap.version30 Resources