STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

5.5.7 Resource StructureMap - Detailed Descriptions

Detailed Descriptions for the elements in the StructureMap resource.

StructureMap
Definition

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

Control1..1
Alternate NamesTemplate; Profile
StructureMap.url
Definition

An absolute URL that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published.

Control1..1
Typeuri
Alternate Namesurl; authoritative-url; destination; identity
Summarytrue
StructureMap.identifier
Definition

Formal identifier that is used to identify this StructureMap when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
StructureMap.version
Definition

The identifier that is used to identify this version of the StructureMap when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureMap author manually.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

There may be multiple resource versions of the StructureMap that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.

StructureMap.name
Definition

A free text natural language name identifying the StructureMap.

Control1..1
Typestring
Summarytrue
To DoNot expected to be globally unique.
StructureMap.status
Definition

The status of the StructureMap.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of StructureMaps that are appropriate for use vs. not.

StructureMap.experimental
Definition

This StructureMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Summarytrue
Comments

Allows filtering of StructureMaps that are appropriate for use vs. not.

StructureMap.publisher
Definition

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

Control0..1
Typestring
Summarytrue
Comments

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

To DoUsually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
StructureMap.contact
Definition

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

Control0..*
Summarytrue
To DoMay be a web site, an email address, a telephone number (tel:), etc.
StructureMap.contact.name
Definition

The name of an individual to contact regarding the structure map.

Control0..1
Typestring
Summarytrue
To DoIf there is no named individual, the telecom is for the organization as a whole.
StructureMap.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher.

Control0..*
TypeContactPoint
Summarytrue
StructureMap.date
Definition

The date this version of the structure map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.

Control0..1
TypedateTime
Summarytrue
To DoAdditional specific dates may be added as extensions.
StructureMap.description
Definition

A free text natural language description of the StructureMap and its use.

Control0..1
Typemarkdown
Summarytrue
To DoThis field can be used for things such as why the StructureMap was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the StructureMap as conveyed in StructureMap.text. This item SHOULD be populated unless the information is available from context.
StructureMap.useContext
Definition

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 of structure maps.

Control0..*
BindingContext of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible)
TypeCodeableConcept
Summarytrue
Comments

Assist in searching for appropriate content.

StructureMap.requirements
Definition

Explains why this structure map is needed and why it's been designed as it has.

Control0..1
Typemarkdown
To DoThis element does not describe the usage of the structure map (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.
StructureMap.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 details of the constraints and mappings.

Control0..1
Typestring
Alternate NamesLicense; Restrictions
StructureMap.structure
Definition

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

Control0..*
Summarytrue
Comments

It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict it's usefulness.

StructureMap.structure.url
Definition

The canonical URL that identifies the structure.

Control1..1
Typeuri
Summarytrue
StructureMap.structure.mode
Definition

How the referenced structure is used in this mapping.

Control1..1
BindingStructureMapModelMode: How the referenced structure is used in this mapping (Required)
Typecode
Summarytrue
StructureMap.structure.documentation
Definition

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

Control0..1
Typestring
StructureMap.import
Definition

Other maps used by this map (canonical URLs).

Control0..*
Typeuri
Summarytrue
StructureMap.group
Definition

Named sections for reader convenience.

Control1..*
Summarytrue
StructureMap.group.name
Definition

Descriptive name for a user.

Control1..1
Typeid
Summarytrue
StructureMap.group.extends
Definition

Another group that this group adds rules to.

Control0..1
Typeid
Summarytrue
StructureMap.group.documentation
Definition

Documentation for this group.

Control0..1
Typestring
Summarytrue
StructureMap.group.input
Definition

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

Control1..*
Summarytrue
Comments

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

StructureMap.group.input.name
Definition

Name for this instance of data.

Control1..1
Typeid
Summarytrue
StructureMap.group.input.type
Definition

Type for this instance of data.

Control0..1
Typestring
Summarytrue
StructureMap.group.input.mode
Definition

Mode for this instance of data.

Control1..1
BindingStructureMapInputMode: Mode for this instance of data (Required)
Typecode
Summarytrue
StructureMap.group.input.documentation
Definition

Documentation for this instance of data.

Control0..1
Typestring
StructureMap.group.rule
Definition

Transform Rule from source to target.

Control1..*
Summarytrue
StructureMap.group.rule.name
Definition

Name of the rule for internal references.

Control1..1
Typeid
Summarytrue
StructureMap.group.rule.source
Definition

Source inputs to the mapping.

Control1..*
Summarytrue
StructureMap.group.rule.source.required
Definition

Whether this rule applies if the source isn't found.

Control1..1
Typeboolean
Summarytrue
StructureMap.group.rule.source.context
Definition

Type or variable this rule applies to.

Control1..1
Typeid
Summarytrue
StructureMap.group.rule.source.contextType
Definition

How to interpret the context.

Control1..1
BindingStructureMapContextType: How to interpret the context (Required)
Typecode
Summarytrue
StructureMap.group.rule.source.element
Definition

Optional field for this source.

Control0..1
Typestring
Summarytrue
StructureMap.group.rule.source.listMode
Definition

How to handle the list mode for this element.

Control0..1
BindingStructureMapListMode: If field is a list, how to manage the list (Required)
Typecode
Summarytrue
StructureMap.group.rule.source.variable
Definition

Named context for field, if a field is specified.

Control0..1
Typeid
Summarytrue
StructureMap.group.rule.source.condition
Definition

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

Control0..1
Typestring
Summarytrue
StructureMap.group.rule.source.check
Definition

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

Control0..1
Typestring
Summarytrue
StructureMap.group.rule.target
Definition

Content to create because of this mapping rule.

Control0..*
Summarytrue
StructureMap.group.rule.target.context
Definition

Type or variable this rule applies to.

Control1..1
Typeid
Summarytrue
StructureMap.group.rule.target.contextType
Definition

How to interpret the context.

Control1..1
BindingStructureMapContextType: How to interpret the context (Required)
Typecode
Summarytrue
StructureMap.group.rule.target.element
Definition

Field to create in the context.

Control0..1
Typestring
Summarytrue
StructureMap.group.rule.target.variable
Definition

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

Control0..1
Typeid
Summarytrue
StructureMap.group.rule.target.listMode
Definition

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

Control0..*
BindingStructureMapListMode: If field is a list, how to manage the list (Required)
Typecode
Summarytrue
StructureMap.group.rule.target.listRuleId
Definition

Internal rule reference for shared list items.

Control0..1
Typeid
Summarytrue
StructureMap.group.rule.target.transform
Definition

How the data is copied / created.

Control0..1
BindingStructureMapTransform: How data is copied / created (Required)
Typecode
Summarytrue
StructureMap.group.rule.target.parameter
Definition

Parameters to the transform.

Control0..*
Summarytrue
StructureMap.group.rule.target.parameter.value[x]
Definition

Parameter value - variable or literal.

Control1..1
Typeid|string|boolean|integer|decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
StructureMap.group.rule.rule
Definition

Rules contained in this rule.

Control0..*
TypeSee StructureMap.group.rule
Summarytrue
StructureMap.group.rule.dependent
Definition

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

Control0..*
Summarytrue
StructureMap.group.rule.dependent.name
Definition

Name of a rule or group to apply.

Control1..1
Typeid
Summarytrue
StructureMap.group.rule.dependent.variable
Definition

Names of variables to pass to the rule or group.

Control1..*
Typestring
Summarytrue
StructureMap.group.rule.documentation
Definition

Documentation for this instance of data.

Control0..1
Typestring