FHIR CI-Build

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

FHIR Infrastructure icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the StructureMap resource.

StructureMap
Element IdStructureMap
Definition

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

Short DisplayA Map of relationships between 2 structures that can be used to transform data
Cardinality0..*
TypeCanonicalResource
Alternate NamesTemplate; Profile
Summaryfalse
Invariants
Defined on this element
cnl-0Warning 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}')
StructureMap.url
Element IdStructureMap.url
Definition

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

Short DisplayCanonical identifier for this structure map, represented as a URI (globally unique)
Cardinality1..1
Typeuri
Requirements

Allows the structure map to be referenced by a single globally unique identifier.

Alternate Namesurl; authoritative-url; destination; identity
Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
StructureMap.identifier
Element IdStructureMap.identifier
Definition

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.

Short DisplayAdditional identifier for the structure map
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.

StructureMap.version
Element IdStructureMap.version
Definition

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.

Short DisplayBusiness version of the structure map
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different structure map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

StructureMap.versionAlgorithm[x]
Element IdStructureMap.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

StructureMap.name
Element IdStructureMap.name
Definition

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.

Short DisplayName for this structure map (computer friendly)
Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning 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}')
StructureMap.title
Element IdStructureMap.title
Definition

A short, descriptive, user-friendly title for the structure map.

Short DisplayName for this structure map (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

StructureMap.status
Element IdStructureMap.status
Definition

The status of this structure map. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of structure maps that are appropriate for use versus not.

StructureMap.experimental
Element IdStructureMap.experimental
Definition

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.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.

Summarytrue
Comments

Allows filtering of structure maps that are appropriate for use versus not.

StructureMap.date
Element IdStructureMap.date
Definition

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

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

StructureMap.publisher
Element IdStructureMap.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the structure map.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the structure map. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure map. This item SHOULD be populated unless the information is available from context.

StructureMap.contact
Element IdStructureMap.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

StructureMap.description
Element IdStructureMap.description
Definition

A free text natural language description of the structure map from a consumer's perspective.

Short DisplayNatural language description of the structure map
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure map as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure map is presumed to be the predominant language in the place the structure map was created).

StructureMap.useContext
Element IdStructureMap.useContext
Definition

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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

StructureMap.jurisdiction
Element IdStructureMap.jurisdiction
Definition

A legal or geographic region in which the structure map is intended to be used.

Short DisplayIntended jurisdiction for structure map (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.

StructureMap.purpose
Element IdStructureMap.purpose
Definition

Explanation of why this structure map is needed and why it has been designed as it has.

Short DisplayWhy this structure map is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the structure map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure map.

StructureMap.copyright
Element IdStructureMap.copyright
Definition

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.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

StructureMap.copyrightLabel
Element IdStructureMap.copyrightLabel
Definition

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

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

StructureMap.structure
Element IdStructureMap.structure
Definition

A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

Short DisplayStructure Definition used by this map
Cardinality0..*
Summarytrue
Comments

It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.

StructureMap.structure.url
Element IdStructureMap.structure.url
Definition

The canonical reference to the structure.

Short DisplayCanonical reference to structure definition
Cardinality1..1
Typecanonical(StructureDefinition)
Summarytrue
StructureMap.structure.mode
Element IdStructureMap.structure.mode
Definition

How the referenced structure is used in this mapping.

Short Displaysource | queried | target | produced
Cardinality1..1
Terminology BindingStructureMapModelMode (Required)
Typecode
Summarytrue
StructureMap.structure.alias
Element IdStructureMap.structure.alias
Definition

The name used for this type in the map.

Short DisplayName for type in this map
Cardinality0..1
Typestring
Summarytrue
Comments

This is needed if both types have the same name (e.g. version conversion).

StructureMap.structure.documentation
Element IdStructureMap.structure.documentation
Definition

Documentation that describes how the structure is used in the mapping.

Short DisplayDocumentation on use of structure
Cardinality0..1
Typestring
Summaryfalse
StructureMap.import
Element IdStructureMap.import
Definition

Other maps used by this map (canonical URLs).

Short DisplayOther maps used by this map (canonical URLs)
Cardinality0..*
Typecanonical(StructureMap)
Summarytrue
StructureMap.group
Element IdStructureMap.group
Definition

Organizes the mapping into manageable chunks for human review/ease of maintenance.

Short DisplayNamed sections for reader convenience
Cardinality1..*
Summarytrue
StructureMap.group.name
Element IdStructureMap.group.name
Definition

A unique name for the group for the convenience of human readers.

Short DisplayHuman-readable label
Cardinality1..1
Typeid
Summarytrue
StructureMap.group.extends
Element IdStructureMap.group.extends
Definition

Another group that this group adds rules to.

Short DisplayAnother group that this group adds rules to
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.typeMode
Element IdStructureMap.group.typeMode
Definition

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

Short Displaytypes | type-and-types
Cardinality0..1
Terminology BindingStructureMapGroupTypeMode (Required)
Typecode
Summarytrue
Comments

Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.

StructureMap.group.documentation
Element IdStructureMap.group.documentation
Definition

Additional supporting documentation that explains the purpose of the group and the types of mappings within it.

Short DisplayAdditional description/explanation for group
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.input
Element IdStructureMap.group.input
Definition

A name assigned to an instance of data. The instance must be provided when the mapping is invoked.

Short DisplayNamed instance provided when invoking the map
Cardinality1..*
Summarytrue
Comments

If no inputs are named, then the entry mappings are type based.

StructureMap.group.input.name
Element IdStructureMap.group.input.name
Definition

Name for this instance of data.

Short DisplayName for this instance of data
Cardinality1..1
Typeid
Summarytrue
StructureMap.group.input.type
Element IdStructureMap.group.input.type
Definition

Type for this instance of data.

Short DisplayType for this instance of data
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.input.mode
Element IdStructureMap.group.input.mode
Definition

Mode for this instance of data.

Short Displaysource | target
Cardinality1..1
Terminology BindingStructureMapInputMode (Required)
Typecode
Summarytrue
StructureMap.group.input.documentation
Element IdStructureMap.group.input.documentation
Definition

Documentation for this instance of data.

Short DisplayDocumentation for this instance of data
Cardinality0..1
Typestring
Summaryfalse
StructureMap.group.rule
Element IdStructureMap.group.rule
Definition

Transform Rule from source to target.

Short DisplayTransform Rule from source to target
Cardinality0..*
Summarytrue
StructureMap.group.rule.name
Element IdStructureMap.group.rule.name
Definition

Name of the rule for internal references.

Short DisplayName of the rule for internal references
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.rule.source
Element IdStructureMap.group.rule.source
Definition

Source inputs to the mapping.

Short DisplaySource inputs to the mapping
Cardinality1..*
Summarytrue
StructureMap.group.rule.source.context
Element IdStructureMap.group.rule.source.context
Definition

Type or variable this rule applies to.

Short DisplayType or variable this rule applies to
Cardinality1..1
Typeid
Summarytrue
StructureMap.group.rule.source.min
Element IdStructureMap.group.rule.source.min
Definition

Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.

Short DisplaySpecified minimum cardinality
Cardinality0..1
Typeinteger
Summarytrue
StructureMap.group.rule.source.max
Element IdStructureMap.group.rule.source.max
Definition

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

Short DisplaySpecified maximum cardinality (number or *)
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.source.type
Element IdStructureMap.group.rule.source.type
Definition

Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.

Short DisplayRule only applies if source has this type
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.source.defaultValue
Element IdStructureMap.group.rule.source.defaultValue
Definition

A value to use if there is no existing value in the source object.

Short DisplayDefault value if no value exists
Cardinality0..1
Typestring
Summarytrue
Comments

If there's a default value on an item that can repeat, it will only be used once.

StructureMap.group.rule.source.element
Element IdStructureMap.group.rule.source.element
Definition

Optional field for this source.

Short DisplayOptional field for this source
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.source.listMode
Element IdStructureMap.group.rule.source.listMode
Definition

How to handle the list mode for this element.

Short Displayfirst | not_first | last | not_last | only_one
Cardinality0..1
Terminology BindingStructureMapSourceListMode (Required)
Typecode
Summarytrue
StructureMap.group.rule.source.variable
Element IdStructureMap.group.rule.source.variable
Definition

Named context for field, if a field is specified.

Short DisplayNamed context for field, if a field is specified
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.rule.source.condition
Element IdStructureMap.group.rule.source.condition
Definition

FHIRPath expression - must be true or the rule does not apply.

Short DisplayFHIRPath expression - must be true or the rule does not apply
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.source.check
Element IdStructureMap.group.rule.source.check
Definition

FHIRPath expression - must be true or the mapping engine throws an error instead of completing.

Short DisplayFHIRPath expression - must be true or the mapping engine throws an error instead of completing
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.source.logMessage
Element IdStructureMap.group.rule.source.logMessage
Definition

A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.

Short DisplayMessage to put in log if source exists (FHIRPath)
Cardinality0..1
Typestring
Summarytrue
Comments

This is typically used for recording that something Is not transformed to the target for some reason.

StructureMap.group.rule.target
Element IdStructureMap.group.rule.target
Definition

Content to create because of this mapping rule.

Short DisplayContent to create because of this mapping rule
Cardinality0..*
Summarytrue
Invariants
Defined on this element
smp-1Rule Can only have an element if you have a contextelement.exists() implies context.exists()
StructureMap.group.rule.target.context
Element IdStructureMap.group.rule.target.context
Definition

Variable this rule applies to.

Short DisplayVariable this rule applies to
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.rule.target.element
Element IdStructureMap.group.rule.target.element
Definition

Field to create in the context.

Short DisplayField to create in the context
Cardinality0..1
Typestring
Summarytrue
StructureMap.group.rule.target.variable
Element IdStructureMap.group.rule.target.variable
Definition

Named context for field, if desired, and a field is specified.

Short DisplayNamed context for field, if desired, and a field is specified
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.rule.target.listMode
Element IdStructureMap.group.rule.target.listMode
Definition

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

Short Displayfirst | share | last | collate
Cardinality0..*
Terminology BindingStructureMapTargetListMode (Required)
Typecode
Summarytrue
StructureMap.group.rule.target.listRuleId
Element IdStructureMap.group.rule.target.listRuleId
Definition

Internal rule reference for shared list items.

Short DisplayInternal rule reference for shared list items
Cardinality0..1
Typeid
Summarytrue
StructureMap.group.rule.target.transform
Element IdStructureMap.group.rule.target.transform
Definition

How the data is copied / created.

Short Displaycreate | copy +
Cardinality0..1
Terminology BindingStructureMapTransform (Required)
Typecode
Summarytrue
StructureMap.group.rule.target.parameter
Element IdStructureMap.group.rule.target.parameter
Definition

Parameters to the transform.

Short DisplayParameters to the transform
Cardinality0..*
Summarytrue
StructureMap.group.rule.target.parameter.value[x]
Element IdStructureMap.group.rule.target.parameter.value[x]
Definition

Parameter value - variable or literal.

Short DisplayParameter value - variable or literal
Cardinality1..1
Typeid|string|boolean|integer|decimal|date|time|dateTime
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
StructureMap.group.rule.rule
Element IdStructureMap.group.rule.rule
Definition

Rules contained in this rule.

Short DisplayRules contained in this rule
Cardinality0..*
TypeSee StructureMap.group.rule
Summarytrue
StructureMap.group.rule.dependent
Element IdStructureMap.group.rule.dependent
Definition

Which other rules to apply in the context of this rule.

Short DisplayWhich other rules to apply in the context of this rule
Cardinality0..*
Summarytrue
StructureMap.group.rule.dependent.name
Element IdStructureMap.group.rule.dependent.name
Definition

Name of a rule or group to apply.

Short DisplayName of a rule or group to apply
Cardinality1..1
Typeid
Summarytrue
StructureMap.group.rule.dependent.parameter
Element IdStructureMap.group.rule.dependent.parameter
Definition

Parameter to pass to the rule or group.

Short DisplayParameter to pass to the rule or group
Cardinality1..*
TypeSee StructureMap.group.rule.target.parameter
Summarytrue
StructureMap.group.rule.documentation
Element IdStructureMap.group.rule.documentation
Definition

Documentation for this instance of data.

Short DisplayDocumentation for this instance of data
Cardinality0..1
Typestring
Summaryfalse