Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3

7.8 7.9 Resource StructureMap - Content

FHIR Infrastructure icon Work Group Maturity Level : 2 4   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

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

7.8.1 7.9.1 Scope and Usage

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 .

7.8.2 7.9.2 Boundaries and Relationships

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 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.

7.8.3 7.9.3 Background and Context

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.

7.8.4 7.9.4 References to this Resource

This resource is referenced by

7.8.5 7.9.5 Resource Content

Structure

Another group that this group adds rules to typeMode defaultValueInstant defaultValueInteger integer defaultValueString defaultValueUnsignedInt defaultValueAge defaultValueAnnotation Annotation defaultValueContactPoint defaultValueIdentifier defaultValueMoney Money defaultValueRatio defaultValueReference Reference () defaultValueContactDetail defaultValueContributor Contributor defaultValueRelatedArtifact defaultValueDosage defaultValueMeta Meta context Σ 0..1 id Type or variable this rule applies to string Variable
Name Flags Card. Type Description & Constraints doco
. . StructureMap TU DomainResource A 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 Σ C 1..1 uri Canonical 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..* Identifier Additional identifier for the structure map

. . . version Σ 0..1 string Business version of the structure map
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Name for this structure map (computer friendly) Coding
. . . title name Σ C 0..1 1..1 string Name for this structure map (human (computer friendly)
. . . status title Σ T 0..1 string Name for this structure map (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the structure map
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
Binding: Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this structure map is defined
. . . copyright T 0..1 markdown Use and/or publishing restrictions
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . structure Σ 0..* BackboneElement Structure Definition used by this map

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

. . . group const Σ 1..* 0..* BackboneElement Named sections for reader convenience Definition of the constant value used in the map rules

. . . . name Σ 1..1 id Human-readable label extends Σ 0..1 id Σ 1..1 code none | types | type-and-types Constant name
StructureMapGroupTypeMode ( Required )
. . . . documentation value Σ 0..1 string Additional description/explanation for group FHIRPath exression - value of the constant
. . . input group Σ 1..* BackboneElement Named instance provided when invoking the map sections for reader convenience

. . . . name Σ 1..1 id Name for this instance of data Human-readable label
. . . . type extends Σ 0..1 string id Type for Another group that this instance of data group adds rules to
. . . . mode typeMode Σ 1..1 0..1 code source types | target type-and-types
StructureMapInputMode Binding: Structure Map Group Type Mode ( Required ) documentation 0..1 string Documentation for this instance of data rule Σ 1..* BackboneElement Transform Rule from source to target
. . . . name documentation Σ 1..1 0..1 id string Name of the rule Additional description/explanation for internal references group
. . . . source input Σ 1..* BackboneElement Source inputs to Named instance provided when invoking the mapping map

. . . . . context name Σ 1..1 id Type or variable Name for this rule applies to min Σ 0..1 integer Specified minimum cardinality max Σ 0..1 string instance of data
Specified maximum cardinality (number or *)
. . . . . type Σ 0..1 string Rule only applies if source has Type for this type defaultValue[x] Σ 0..1 Default value if no value exists defaultValueBase64Binary base64Binary instance of data
. . . . . defaultValueBoolean mode boolean defaultValueCanonical canonical Σ () defaultValueCode 1..1 code defaultValueDate date source | target
Binding: Structure Map Input Mode defaultValueDateTime dateTime ( Required )
. . . . . defaultValueDecimal decimal documentation defaultValueId id 0..1 instant string Documentation for this instance of data
. . defaultValueMarkdown . markdown . rule defaultValueOid oid defaultValuePositiveInt positiveInt Σ string 0..* defaultValueTime time BackboneElement Transform Rule from source to target
unsignedInt
. . . . . defaultValueUri uri defaultValueUrl url name defaultValueUuid uuid defaultValueAddress Address Σ 0..1 Age id Name of the rule for internal references
. . . defaultValueAttachment . Attachment . source defaultValueCodeableConcept CodeableConcept defaultValueCoding Coding Σ 1..* ContactPoint BackboneElement Source inputs to the mapping
defaultValueCount Count
. . . . . defaultValueDistance Distance . context defaultValueDuration Duration defaultValueHumanName HumanName Σ 1..1 Identifier id Type or variable this rule applies to
. . . . . defaultValuePeriod Period . min defaultValueQuantity Quantity defaultValueRange Range Σ 0..1 Ratio integer Specified minimum cardinality
. . . . . defaultValueSampledData SampledData . max defaultValueSignature Signature defaultValueTiming Timing Σ 0..1 ContactDetail string Specified maximum cardinality (number or *)
. . . . . defaultValueDataRequirement DataRequirement . type defaultValueExpression Expression defaultValueParameterDefinition ParameterDefinition Σ 0..1 RelatedArtifact string Rule only applies if source has this type
. . . . . defaultValueTriggerDefinition . defaultValue TriggerDefinition defaultValueUsageContext UsageContext Σ 0..1 Dosage string Default value if no value exists
. . . . . . element Σ 0..1 string Optional field for this source
. . . . . . listMode Σ 0..1 code first | not_first | last | not_last | only_one
Binding: StructureMapSourceListMode Structure Map Source List Mode ( Required )
. . . . . . variable Σ 0..1 id Named context for field, if a field is specified
. . . . . . condition Σ 0..1 string FHIRPath expression - must be true or the rule does not apply
. . . . . . check Σ 0..1 string FHIRPath expression - must be true or the mapping engine throws an error instead of completing
. . . . . . logMessage Σ 0..1 string Message to put in log if source exists (FHIRPath)
. . . . . target Σ I C 0..* BackboneElement Content to create because of this mapping rule
+ Rule: Can only have an element if you have a context
+ Rule: Must have a contextType if you have a context
. . . . . . contextType context Σ C 0..1 code string type | variable Variable this rule applies to
StructureMapContextType ( Required )
. . . . . . element Σ C 0..1 string Field to create in the context
. . . . . . variable Σ 0..1 id Named context for field, if desired, and a field is specified
. . . . . . listMode Σ 0..* code first | share | last | collate single
Binding: StructureMapTargetListMode Structure Map Target List Mode ( Required )

. . . . . . listRuleId Σ 0..1 id Internal rule reference for shared list items
. . . . . . transform Σ 0..1 code create | copy +
Binding: StructureMapTransform Structure Map Transform ( Required )
. . . . . . parameter Σ 0..* BackboneElement Parameters to the transform

. . . . . . . value[x] Σ 1..1 Parameter value - variable or literal
. . . . . . . . valueId id
. . . . . . . . valueString string
. . . . . . . . valueBoolean boolean
. . . . . . . . valueInteger integer
. . . . . . . . valueDecimal decimal
. . . . . . . . valueDate date
........ valueTime time
. . . . . . . . valueDateTime dateTime
. . . . . rule Σ 0..* see rule Rules contained in this rule

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

. . . . . . name Σ 1..1 id Name of a rule or group to apply
. . . . . variable . parameter Σ 1..* see parameter Parameter to pass to the rule or group

. . . . . documentation 0..1 string Documentation for this instance of data

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

StructureMap ( DomainResource ) + CanonicalResource An 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 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 servers url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[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 generation name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the structure map title : 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 usage experimental : boolean [0..1] The date (and optionally time) when the structure map was published. 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 changes date : dateTime [0..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the structure map publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the structure map from a consumer's perspective description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the structure map is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this structure map is needed and why it has been designed as it has purpose : 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 map copyright : 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 » Structure The canonical reference to the structure url : canonical [1..1] « StructureDefinition » How the referenced structure is used in this mapping mode : code [1..1] « null (Strength=Required) StructureMapModelMode ! » The name used for this type in the map alias : string [0..1] Documentation that describes how the structure is used in the mapping documentation : string [0..1] Const Other maps used by this map (canonical URLs) name : id [0..1] A FHIRPath expression that is the value of this variable value : string [0..1] Group A unique name for the group for the convenience of human readers name : id [1..1] Another group that this group adds rules to extends : id [0..1] If this is the default rule set to apply for the source type or this combination of types typeMode : code [1..1] [0..1] « null (Strength=Required) StructureMapGroupTypeMode ! » Additional supporting documentation that explains the purpose of the group and the types of mappings within it documentation : string [0..1] Input Name for this instance of data name : id [1..1] Type for this instance of data type : string [0..1] Mode for this instance of data mode : code [1..1] « null (Strength=Required) StructureMapInputMode ! » Documentation for this instance of data documentation : string [0..1] Rule Name of the rule for internal references name : id [1..1] [0..1] Documentation for this instance of data documentation : string [0..1] Source Type or variable this rule applies to context : id [1..1] Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content min : 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 elements type : string [0..1] A value to use if there is no existing value in the source object defaultValue[x] defaultValue : Element [0..1] « base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | 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 | Meta » [0..1] Optional field for this source element : string [0..1] How to handle the list mode for this element listMode : code [0..1] « null (Strength=Required) StructureMapSourceListMode ! » Named context for field, if a field is specified variable : id [0..1] FHIRPath expression - must be true or the rule does not apply condition : string [0..1] FHIRPath expression - must be true or the mapping engine throws an error instead of completing check : string [0..1] A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found logMessage : string [0..1] Target Type or variable Variable this rule applies to context : id [0..1] How to interpret the context contextType : code string [0..1] « null (Strength=Required) This element has or is affected by some invariants StructureMapContextType ! C » Field to create in the context element : string [0..1] « This element has or is affected by some invariants C » Named context for field, if desired, and a field is specified variable : id [0..1] If field is a list, how to manage the list listMode : code [0..*] « null (Strength=Required) StructureMapTargetListMode ! » Internal rule reference for shared list items listRuleId : id [0..1] How the data is copied / created transform : code [0..1] « null (Strength=Required) StructureMapTransform ! » Parameter Parameter value - variable or literal value[x] : Element PrimitiveType [1..1] « id | string | boolean | integer | decimal | date | time | dateTime » Dependent Name of a rule or group to apply name : id [1..1] Variable to pass to the rule or group variable : string [1..*] A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced structure [0..*] Definition of a constant value used in the map rules const [0..*] A name assigned to an instance of data. The instance must be provided when the mapping is invoked input [1..*] Source inputs to the mapping source [1..*] Parameters to the transform parameter [0..*] Content to create because of this mapping rule target [0..*] Rules contained in this rule rule [0..*] Parameter to pass to the rule or group parameter [1..*] Which other rules to apply in the context of this rule dependent [0..*] Transform Rule from source to target rule [1..*] [0..*] Organizes the mapping into manageable managable chunks for human review/ease of maintenance group [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[x]>

    <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]>

     <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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
      fhir:
      fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        # . One of these 50
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
      ], ...;
      fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
          # . One of these 5
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
        ], ...;
      ], ...;
      fhir:
      fhir:
        fhir:
        fhir:
      ], ...;
      fhir:
    ], ...;
  ], ...;

  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 since 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.rule.source.defaultValue[x] 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 Meta 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 . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) See Conversions Summary .)

Structure

Another group that this group adds rules to typeMode defaultValueInstant defaultValueInteger integer defaultValueString defaultValueAge defaultValueAnnotation Annotation defaultValueContactPoint defaultValueIdentifier defaultValueMoney Money defaultValueRatio defaultValueReference Reference () defaultValueContactDetail defaultValueContributor Contributor defaultValueRelatedArtifact defaultValueDosage defaultValueMeta Meta context Σ 0..1 id Type or variable this rule applies to string Variable
Name Flags Card. Type Description & Constraints doco
. . StructureMap TU DomainResource A 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 Σ C 1..1 uri Canonical 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..* Identifier Additional identifier for the structure map

. . . version Σ 0..1 string Business version of the structure map
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Name for this structure map (computer friendly) Coding
. . . title name Σ C 0..1 1..1 string Name for this structure map (human (computer friendly)
. . . status title Σ T 0..1 string Name for this structure map (human friendly)
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the structure map
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
Binding: Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this structure map is defined
. . . copyright T 0..1 markdown Use and/or publishing restrictions
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . structure Σ 0..* BackboneElement Structure Definition used by this map

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

. . . group const Σ 1..* 0..* BackboneElement Named sections for reader convenience Definition of the constant value used in the map rules

. . . . name Σ 1..1 id Human-readable label extends Σ 0..1 id Σ 1..1 code none | types | type-and-types Constant name
StructureMapGroupTypeMode ( Required )
. . . . documentation value Σ 0..1 string Additional description/explanation for group FHIRPath exression - value of the constant
. . . input group Σ 1..* BackboneElement Named instance provided when invoking the map sections for reader convenience

. . . . name Σ 1..1 id Name for this instance of data Human-readable label
. . . . type extends Σ 0..1 string id Type for Another group that this instance of data group adds rules to
. . . . mode typeMode Σ 1..1 0..1 code source types | target type-and-types
StructureMapInputMode Binding: Structure Map Group Type Mode ( Required ) documentation 0..1 string Documentation for this instance of data rule Σ 1..* BackboneElement Transform Rule from source to target
. . . . name documentation Σ 1..1 0..1 id string Name of the rule Additional description/explanation for internal references group
. . . . source input Σ 1..* BackboneElement Source inputs to Named instance provided when invoking the mapping map

. . . . . context name Σ 1..1 id Type or variable Name for this rule applies to min Σ 0..1 integer Specified minimum cardinality max Σ 0..1 string instance of data
Specified maximum cardinality (number or *)
. . . . . type Σ 0..1 string Rule only applies if source has Type for this type defaultValue[x] Σ 0..1 Default value if no value exists defaultValueBase64Binary base64Binary instance of data
. . . . . defaultValueBoolean mode boolean defaultValueCanonical canonical Σ () defaultValueCode 1..1 code defaultValueDate date source | target
Binding: Structure Map Input Mode defaultValueDateTime dateTime ( Required )
. . . . . defaultValueDecimal decimal documentation defaultValueId id 0..1 instant string Documentation for this instance of data
. . defaultValueMarkdown . markdown . rule defaultValueOid oid defaultValuePositiveInt positiveInt Σ 0..* string BackboneElement Transform Rule from source to target
defaultValueTime time defaultValueUnsignedInt unsignedInt
. . . . . defaultValueUri uri defaultValueUrl url name defaultValueUuid uuid defaultValueAddress Address Σ 0..1 Age id Name of the rule for internal references
. . . defaultValueAttachment . Attachment . source defaultValueCodeableConcept CodeableConcept defaultValueCoding Coding Σ 1..* ContactPoint BackboneElement Source inputs to the mapping
defaultValueCount Count
. . . . . defaultValueDistance Distance . context defaultValueDuration Duration defaultValueHumanName HumanName Σ 1..1 Identifier id Type or variable this rule applies to
. . . . . defaultValuePeriod Period . min defaultValueQuantity Quantity defaultValueRange Range Σ 0..1 Ratio integer Specified minimum cardinality
. . . . . defaultValueSampledData SampledData . max defaultValueSignature Signature defaultValueTiming Timing Σ 0..1 ContactDetail string Specified maximum cardinality (number or *)
. . . . . defaultValueDataRequirement DataRequirement . type defaultValueExpression Expression defaultValueParameterDefinition ParameterDefinition Σ 0..1 RelatedArtifact string Rule only applies if source has this type
. . . . . defaultValueTriggerDefinition . defaultValue TriggerDefinition defaultValueUsageContext UsageContext Σ 0..1 Dosage string Default value if no value exists
. . . . . . element Σ 0..1 string Optional field for this source
. . . . . . listMode Σ 0..1 code first | not_first | last | not_last | only_one
Binding: StructureMapSourceListMode Structure Map Source List Mode ( Required )
. . . . . . variable Σ 0..1 id Named context for field, if a field is specified
. . . . . . condition Σ 0..1 string FHIRPath expression - must be true or the rule does not apply
. . . . . . check Σ 0..1 string FHIRPath expression - must be true or the mapping engine throws an error instead of completing
. . . . . . logMessage Σ 0..1 string Message to put in log if source exists (FHIRPath)
. . . . . target Σ I C 0..* BackboneElement Content to create because of this mapping rule
+ Rule: Can only have an element if you have a context
+ Rule: Must have a contextType if you have a context
. . . . . . contextType context Σ C 0..1 code string type | variable Variable this rule applies to
StructureMapContextType ( Required )
. . . . . . element Σ C 0..1 string Field to create in the context
. . . . . . variable Σ 0..1 id Named context for field, if desired, and a field is specified
. . . . . . listMode Σ 0..* code first | share | last | collate single
Binding: StructureMapTargetListMode Structure Map Target List Mode ( Required )

. . . . . . listRuleId Σ 0..1 id Internal rule reference for shared list items
. . . . . . transform Σ 0..1 code create | copy +
Binding: StructureMapTransform Structure Map Transform ( Required )
. . . . . . parameter Σ 0..* BackboneElement Parameters to the transform

. . . . . . . value[x] Σ 1..1 Parameter value - variable or literal
. . . . . . . . valueId id
. . . . . . . . valueString string
. . . . . . . . valueBoolean boolean
. . . . . . . . valueInteger integer
. . . . . . . . valueDecimal decimal
. . . . . . . . valueDate date
........ valueTime time
. . . . . . . . valueDateTime dateTime
. . . . . rule Σ 0..* see rule Rules contained in this rule

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

. . . . . . name Σ 1..1 id Name of a rule or group to apply
. . . . . variable . parameter Σ 1..* see parameter Parameter to pass to the rule or group

. . . . . documentation 0..1 string Documentation for this instance of data

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

StructureMap ( DomainResource ) + CanonicalResource An 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 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 servers url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[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 generation name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the structure map title : 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 usage experimental : boolean [0..1] The date (and optionally time) when the structure map was published. 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 changes date : dateTime [0..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the structure map publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the structure map from a consumer's perspective description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the structure map is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this structure map is needed and why it has been designed as it has purpose : 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 map copyright : 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 » Structure The canonical reference to the structure url : canonical [1..1] « StructureDefinition » How the referenced structure is used in this mapping mode : code [1..1] « null (Strength=Required) StructureMapModelMode ! » The name used for this type in the map alias : string [0..1] Documentation that describes how the structure is used in the mapping documentation : string [0..1] Const Other maps used by this map (canonical URLs) name : id [0..1] A FHIRPath expression that is the value of this variable value : string [0..1] Group A unique name for the group for the convenience of human readers name : id [1..1] Another group that this group adds rules to extends : id [0..1] If this is the default rule set to apply for the source type or this combination of types typeMode : code [1..1] [0..1] « null (Strength=Required) StructureMapGroupTypeMode ! » Additional supporting documentation that explains the purpose of the group and the types of mappings within it documentation : string [0..1] Input Name for this instance of data name : id [1..1] Type for this instance of data type : string [0..1] Mode for this instance of data mode : code [1..1] « null (Strength=Required) StructureMapInputMode ! » Documentation for this instance of data documentation : string [0..1] Rule Name of the rule for internal references name : id [1..1] [0..1] Documentation for this instance of data documentation : string [0..1] Source Type or variable this rule applies to context : id [1..1] Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content min : 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 elements type : string [0..1] A value to use if there is no existing value in the source object defaultValue[x] defaultValue : Element [0..1] « base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | 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 | Meta » [0..1] Optional field for this source element : string [0..1] How to handle the list mode for this element listMode : code [0..1] « null (Strength=Required) StructureMapSourceListMode ! » Named context for field, if a field is specified variable : id [0..1] FHIRPath expression - must be true or the rule does not apply condition : string [0..1] FHIRPath expression - must be true or the mapping engine throws an error instead of completing check : string [0..1] A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found logMessage : string [0..1] Target Type or variable Variable this rule applies to context : id [0..1] How to interpret the context contextType : code string [0..1] « null (Strength=Required) This element has or is affected by some invariants StructureMapContextType ! C » Field to create in the context element : string [0..1] « This element has or is affected by some invariants C » Named context for field, if desired, and a field is specified variable : id [0..1] If field is a list, how to manage the list listMode : code [0..*] « null (Strength=Required) StructureMapTargetListMode ! » Internal rule reference for shared list items listRuleId : id [0..1] How the data is copied / created transform : code [0..1] « null (Strength=Required) StructureMapTransform ! » Parameter Parameter value - variable or literal value[x] : Element PrimitiveType [1..1] « id | string | boolean | integer | decimal | date | time | dateTime » Dependent Name of a rule or group to apply name : id [1..1] Variable to pass to the rule or group variable : string [1..*] A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced structure [0..*] Definition of a constant value used in the map rules const [0..*] A name assigned to an instance of data. The instance must be provided when the mapping is invoked input [1..*] Source inputs to the mapping source [1..*] Parameters to the transform parameter [0..*] Content to create because of this mapping rule target [0..*] Rules contained in this rule rule [0..*] Parameter to pass to the rule or group parameter [1..*] Which other rules to apply in the context of this rule dependent [0..*] Transform Rule from source to target rule [1..*] [0..*] Organizes the mapping into manageable managable chunks for human review/ease of maintenance group [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[x]>

    <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]>

     <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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
      fhir:
      fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        # . One of these 50
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
          fhir: ]
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
      ], ...;
      fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
        fhir:
          # . One of these 5
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
            fhir: ]
        ], ...;
      ], ...;
      fhir:
      fhir:
        fhir:
        fhir:
      ], ...;
      fhir:
    ], ...;
  ], ...;

  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 since Release 4 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.rule.source.defaultValue[x] 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 Meta 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 . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) See Conversions Summary .)

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

7.8.5.1 7.9.5.1 Terminology Bindings

StructureMap.status StructureMap.jurisdiction StructureMap.structure.mode StructureMap.group.typeMode StructureMap.group.input.mode StructureMap.group.rule.source.listMode StructureMap.group.rule.target.contextType
Path Definition ValueSet Type Reference Documentation
StructureMap.versionAlgorithm[x] VersionAlgorithm Required Extensible PublicationStatus

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

StructureMap.status PublicationStatus Extensible Required Jurisdiction ValueSet

The lifecycle status of an artifact.

StructureMap.jurisdiction JurisdictionValueSet Required Extensible StructureMapModelMode

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 StructureMapGroupTypeMode

How the referenced structure is used in this mapping.

StructureMap.group.typeMode StructureMapGroupTypeMode Required StructureMapInputMode

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

StructureMap.group.input.mode StructureMapInputMode Required StructureMapSourceListMode

Mode for this instance of data.

StructureMap.group.rule.source.listMode StructureMapSourceListMode Required StructureMapContextType

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

StructureMap.group.rule.target.listMode StructureMapTargetListMode Required StructureMapTargetListMode

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

StructureMap.group.rule.target.transform StructureMapTransform Required StructureMapTransform

How data is copied/created.

7.8.5.2 7.9.5.2 Constraints

id UniqueKey Level Location Description Expression
smp-0 img  cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
smp-1 img  cnl-1 Rule Warning StructureMap.group.rule.target StructureMap.url Can only have an element if you have a context URL should not contain | or # - these characters make processing canonical references problematic element.exists() exists() implies context.exists() matches('^[^|# ]+$')
smp-2 img  smp-1 Rule StructureMap.group.rule.target Must Can only have a contextType an element if you have a context context.exists() element.exists() implies contextType.exists() context.exists()

7.8.6 7.9.6 Search Parameters

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.

Name Type Description Expression In Common
context token A use context assigned to the structure map (StructureMap.useContext.value as CodeableConcept) (StructureMap.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the structure map (StructureMap.useContext.value as Quantity) (StructureMap.useContext.value.ofType(Quantity)) | (StructureMap.useContext.value as Range) (StructureMap.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the structure map StructureMap.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the structure map On StructureMap.useContext:
  context-type: code
  context-quantity: value.as(Quantity) value.ofType(Quantity) | value.as(Range) value.ofType(Range) 		30 Resources
context-type-value composite A use context type and value assigned to the structure map On StructureMap.useContext:
  context-type: code
  context: value.as(CodeableConcept) value.ofType(CodeableConcept) 		30 Resources
date date The structure map publication date StructureMap.date 30 Resources
description string The description of the structure map StructureMap.description 28 Resources
identifier token External identifier for the structure map StructureMap.identifier 34 Resources
jurisdiction token Intended jurisdiction for the structure map StructureMap.jurisdiction 26 Resources
name string Computationally friendly name of the structure map StructureMap.name 26 Resources
publisher string Name of the publisher of the structure map StructureMap.publisher 30 Resources
status token The current status of the structure map StructureMap.status 35 Resources
title string The human-friendly name of the structure map StructureMap.title 27 Resources
url uri The uri that identifies the structure map StructureMap.url 34 Resources
version token The business version of the structure map StructureMap.version 30 Resources