STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

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. The URL SHOULD include the major version of the structure map. For more information see Technical and Business Versions.

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

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

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or useable 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 data type - e.g. to identify this structure map outside of FHIR, where the logical URL is not possible to use.

StructureMap.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 are orderable.

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

There may be multiple different instances of a structure map that have the same identifier but different versions.

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

Control1..1
Typestring
Requirements

Support human navigation & code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.

StructureMap.title
Definition

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

Control0..1
Typestring
Summarytrue
StructureMap.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of structure map that are appropriate for use vs. not.

StructureMap.experimental
Definition

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

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level structure map would.

Summarytrue
Comments

Allows filtering of structure map 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
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
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

StructureMap.date
Definition

The date (and optionally time) when 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
Comments

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.

StructureMap.description
Definition

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

Control0..1
Typemarkdown
Comments

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 module as conveyed in the text field of the resource itself. 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 code system definitions.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

StructureMap.jurisdiction
Definition

A jurisdiction in which the structure map is intended to be used.

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
StructureMap.purpose
Definition

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

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the structure map (See, e.g, the comments element, or relatedArtifacts), rather it's for 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
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.

Control0..1
Typemarkdown
Requirements

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

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
Terminology BindingStructureMapModelMode (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
Terminology BindingStructureMapInputMode (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
Terminology BindingStructureMapContextType (Required)
Typecode
Summarytrue
StructureMap.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.

Control0..1
Typeinteger
Summarytrue
StructureMap.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).

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

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

Control0..1
Typestring
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
Terminology BindingStructureMapListMode (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
InvariantsDefined on this element
smp-1: Can only have a element if you have a context (expression : element.exists() implies context.exists(), xpath: not(f:/element)) or (f:/context))
smp-2: Must have a contextType if you have a context (expression : context.exists() implies contextType.exists(), xpath: not(f:/context)) or (f:/contextType))
StructureMap.group.rule.target.context
Definition

Type or variable this rule applies to.

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

How to interpret the context.

Control0..1
Terminology BindingStructureMapContextType (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..*
Terminology BindingStructureMapListMode (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
Terminology BindingStructureMapTransform (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