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

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.

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

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.

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.

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

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.

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.

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

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.

Support human navigation and code generation.

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.

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

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

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

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

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.

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

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

The date (and optionally time) when the structure map was published. 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.

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.

The name of the organization or individual that published the structure map.

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

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.

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

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

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

This description can be used to capture details such as why the structure map was built, 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).

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure map instances.

Assist in searching for appropriate content.

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

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

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

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

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.

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.

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

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

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

The canonical URL that identifies the structure.

How the referenced structure is used in this mapping.

The name used for this type in the map.

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

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

Other maps used by this map (canonical URLs).

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

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

Another group that this group adds rules to.

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

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

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

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

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

Name for this instance of data.

Type for this instance of data.

Mode for this instance of data.

Documentation for this instance of data.

Transform Rule from source to target.

Name of the rule for internal references.

Source inputs to the mapping.

Type or variable this rule applies to.

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

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

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

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

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

Optional field for this source.

How to handle the list mode for this element.

Named context for field, if a field is specified.

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

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

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

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

Content to create because of this mapping rule.

Type or variable this rule applies to.

How to interpret the context.

Field to create in the context.

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

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

Internal rule reference for shared list items.

How the data is copied / created.

Parameters to the transform.

Parameter value - variable or literal.

Rules contained in this rule.

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

Name of a rule or group to apply.

Variable to pass to the rule or group.

Documentation for this instance of data.