type: resource-definitionsresource: StructureMap

StructureMap Definitions

StructureMap

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

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

Aliases: Template, Profile

Cardinality: 0..*

Constraints: cnl-0 | warning | 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{1,254}$')

Mappings: rim=n/a; w5=conformance.content

StructureMap.url

Canonical identifier for this structure map, represented as a URI (globally unique)

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.

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.

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

Aliases: url, authoritative-url, destination, identity

Cardinality: 1..1

Type: uri

Summary: true

Mappings: w5=FiveWs.identifier

StructureMap.identifier

Additional identifier for the structure map

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.

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; objimpl=no-gen-base

StructureMap.version

Business version of the structure map

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.

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.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.version

StructureMap.versionAlgorithm[x]

How to compare versions

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

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.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

StructureMap.name

Name for this structure map (computer friendly)

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.

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.

Requirements: Support human navigation and code generation.

Conditions: cnl-0

Cardinality: 1..1

Type: string

Summary: true

StructureMap.title

Name for this structure map (human friendly)

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

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.status

draft | active | retired | unknown

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: w5=FiveWs.status

StructureMap.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of structure maps that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

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

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: w5=FiveWs.class

StructureMap.date

Date last changed

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.

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.

See guidance around (not) making local changes to elements here.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded

StructureMap.publisher

Name of the publisher/steward (organization or individual)

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

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.

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.witness

StructureMap.contact

Contact details for the publisher

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

StructureMap.description

Natural language description of the structure map

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

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

Cardinality: 0..1

Type: markdown

StructureMap.useContext

The context that the content is intended to support

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.

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

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

StructureMap.jurisdiction

Jurisdiction of the authority that maintains the structure map (if applicable)

Definition: A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

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.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

StructureMap.purpose

Why this structure map is defined

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

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.

Cardinality: 0..1

Type: markdown

Mappings: w5=FiveWs.why[x]; objimpl=no-gen-base

StructureMap.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the structure map and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the structure map.

Comments: ...

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

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: objimpl=no-gen-base

StructureMap.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 restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation 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.

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

Cardinality: 0..1

Type: string

StructureMap.structure

Structure Definition used by this map

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

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

StructureMap.structure.url

Canonical reference to structure definition

Definition: The canonical reference to the structure.

Cardinality: 1..1

Type: canonical

Summary: true

StructureMap.structure.mode

source | queried | target | produced

Definition: How the referenced structure is used in this mapping.

Cardinality: 1..1

Type: code

Binding: required:map-model-mode

Summary: true

StructureMap.structure.alias

Name for type in this map

Definition: The name used for this type in the map.

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.structure.documentation

Documentation on use of structure

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

Cardinality: 0..1

Type: string

StructureMap.import

Other maps used by this map (canonical URLs)

Definition: Other maps used by this map (canonical URLs).

Cardinality: 0..*

Type: canonical

Summary: true

StructureMap.const

Definition of the constant value used in the map rules

Definition: Definition of a constant value used in the map rules.

Cardinality: 0..*

Type: BackboneElement

Summary: true

StructureMap.const.name

Constant name

Definition: Other maps used by this map (canonical URLs).

Cardinality: 0..1

Type: id

Summary: true

StructureMap.const.value

FHIRPath exression - value of the constant

Definition: A FHIRPath expression that is the value of this variable.

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group

Named sections for reader convenience

Definition: Organizes the mapping into managable chunks for human review/ease of maintenance.

Cardinality: 1..*

Type: BackboneElement

Summary: true

StructureMap.group.name

Human-readable label

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

Cardinality: 1..1

Type: id

Summary: true

StructureMap.group.extends

Another group that this group adds rules to

Definition: Another group that this group adds rules to.

Cardinality: 0..1

Type: id

Summary: true

StructureMap.group.typeMode

types | type-and-types

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

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

Cardinality: 0..1

Type: code

Binding: required:map-group-type-mode

Summary: true

StructureMap.group.documentation

Additional description/explanation for group

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.input

Named instance provided when invoking the map

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

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

Cardinality: 1..*

Type: BackboneElement

Summary: true

StructureMap.group.input.name

Name for this instance of data

Definition: Name for this instance of data.

Cardinality: 1..1

Type: id

Summary: true

StructureMap.group.input.type

Type for this instance of data

Definition: Type for this instance of data.

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.input.mode

source | target

Definition: Mode for this instance of data.

Cardinality: 1..1

Type: code

Binding: required:map-input-mode

Summary: true

StructureMap.group.input.documentation

Documentation for this instance of data

Definition: Documentation for this instance of data.

Cardinality: 0..1

Type: string

StructureMap.group.rule

Transform Rule from source to target

Definition: Transform Rule from source to target.

Cardinality: 0..*

Type: BackboneElement

Summary: true

StructureMap.group.rule.name

Name of the rule for internal references

Definition: Name of the rule for internal references.

Cardinality: 0..1

Type: id

Summary: true

StructureMap.group.rule.source

Source inputs to the mapping

Definition: Source inputs to the mapping.

Cardinality: 1..*

Type: BackboneElement

Summary: true

Constraints: smp-2 | error | Min <= Max | min.empty() or max.empty() or (max = '') or iif(max != '', min <= max.toInteger())

StructureMap.group.rule.source.context

Type or variable this rule applies to

Definition: Type or variable this rule applies to.

Cardinality: 1..1

Type: id

Summary: true

StructureMap.group.rule.source.min

Specified minimum cardinality

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

Cardinality: 0..1

Type: unsignedInt

Summary: true

StructureMap.group.rule.source.max

Specified maximum cardinality (number or *)

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

Cardinality: 0..1

Type: string

Summary: true

Constraints: smp-3 | error | Max SHALL be a number or "" | empty() or ($this = '') or (toInteger() >= 0)

StructureMap.group.rule.source.type

Rule only applies if source has this type

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.source.defaultValue

Default value if no value exists

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

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.source.element

Optional field for this source

Definition: Optional field for this source.

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.source.listMode

first | not_first | last | not_last | only_one

Definition: How to handle the list mode for this element.

Cardinality: 0..1

Type: code

Binding: required:map-source-list-mode

Summary: true

StructureMap.group.rule.source.variable

Named context for field, if a field is specified

Definition: Named context for field, if a field is specified.

Cardinality: 0..1

Type: id

Summary: true

StructureMap.group.rule.source.condition

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

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.source.check

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

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.source.logMessage

Message to put in log if source exists (FHIRPath)

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

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.target

Content to create because of this mapping rule

Definition: Content to create because of this mapping rule.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Constraints: smp-1 | error | Can only have an element if you have a context | element.exists() implies context.exists()

StructureMap.group.rule.target.context

Variable this rule applies to

Definition: Variable this rule applies to.

Conditions: smp-1

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.target.element

Field to create in the context

Definition: Field to create in the context.

Conditions: smp-1

Cardinality: 0..1

Type: string

Summary: true

StructureMap.group.rule.target.variable

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

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

Cardinality: 0..1

Type: id

Summary: true

StructureMap.group.rule.target.listMode

first | share | last | single

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

Cardinality: 0..*

Type: code

Binding: required:map-target-list-mode

Summary: true

StructureMap.group.rule.target.listRuleId

Internal rule reference for shared list items

Definition: Internal rule reference for shared list items.

Cardinality: 0..1

Type: id

Summary: true

StructureMap.group.rule.target.transform

create | copy +

Definition: How the data is copied / created.

Cardinality: 0..1

Type: code

Binding: required:map-transform

Summary: true

StructureMap.group.rule.target.parameter

Parameters to the transform

Definition: Parameters to the transform.

Cardinality: 0..*

Type: BackboneElement

Summary: true

StructureMap.group.rule.target.parameter.value[x]

Parameter value - variable or literal

Definition: Parameter value - variable or literal.

Cardinality: 1..1

Type: id, string, boolean, integer, decimal, date, time, dateTime

Summary: true

StructureMap.group.rule.rule

Rules contained in this rule

Definition: Rules contained in this rule.

Cardinality: 0..*

Summary: true

StructureMap.group.rule.dependent

Which other rules to apply in the context of this rule

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

StructureMap.group.rule.dependent.name

Name of a rule or group to apply

Definition: Name of a rule or group to apply.

Cardinality: 1..1

Type: id

Summary: true

StructureMap.group.rule.dependent.parameter

Parameter to pass to the rule or group

Definition: Parameter to pass to the rule or group.

Cardinality: 1..*

Summary: true

StructureMap.group.rule.documentation

Documentation for this instance of data

Definition: Documentation for this instance of data.

Cardinality: 0..1

Type: string