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
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. |
Control | 1..1 |
Alternate Names | Template; 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. |
Control | 1..1 |
Type | uri |
Alternate Names | url; authoritative-url; destination; identity |
Summary | true |
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). |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
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. |
Control | 1..1 |
Type | string |
Summary | true |
To Do | Not expected to be globally unique. |
StructureMap.status | |
Definition | The status of the StructureMap. |
Control | 1..1 |
Binding | ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required) |
Type | code |
Is Modifier | true |
Summary | true |
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. |
Control | 0..1 |
Type | boolean |
Summary | true |
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. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | Helps establish the "authority/credibility" of the structure map. May also allow for contact. |
To Do | Usually 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. |
Control | 0..* |
Summary | true |
To Do | May 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. |
Control | 0..1 |
Type | string |
Summary | true |
To Do | If 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. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
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. |
Control | 0..1 |
Type | dateTime |
Summary | true |
To Do | Additional specific dates may be added as extensions. |
StructureMap.description | |
Definition | A free text natural language description of the StructureMap and its use. |
Control | 0..1 |
Type | markdown |
Summary | true |
To Do | This 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. |
Control | 0..* |
Binding | Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible) |
Type | CodeableConcept |
Summary | true |
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. |
Control | 0..1 |
Type | markdown |
To Do | This 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. |
Control | 0..1 |
Type | string |
Alternate Names | License; 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. |
Control | 0..* |
Summary | true |
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. |
Control | 1..1 |
Type | uri |
Summary | true |
StructureMap.structure.mode | |
Definition | How the referenced structure is used in this mapping. |
Control | 1..1 |
Binding | StructureMapModelMode: How the referenced structure is used in this mapping (Required) |
Type | code |
Summary | true |
StructureMap.structure.documentation | |
Definition | Documentation that describes how the structure is used in the mapping. |
Control | 0..1 |
Type | string |
StructureMap.import | |
Definition | Other maps used by this map (canonical URLs). |
Control | 0..* |
Type | uri |
Summary | true |
StructureMap.group | |
Definition | Named sections for reader convenience. |
Control | 1..* |
Summary | true |
StructureMap.group.name | |
Definition | Descriptive name for a user. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.extends | |
Definition | Another group that this group adds rules to. |
Control | 0..1 |
Type | id |
Summary | true |
StructureMap.group.documentation | |
Definition | Documentation for this group. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.input | |
Definition | A name assigned to an instance of data. The instance must be provided when the mapping is invoked. |
Control | 1..* |
Summary | true |
Comments | If no inputs are named, then the entry mappings are type based. |
StructureMap.group.input.name | |
Definition | Name for this instance of data. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.input.type | |
Definition | Type for this instance of data. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.input.mode | |
Definition | Mode for this instance of data. |
Control | 1..1 |
Binding | StructureMapInputMode: Mode for this instance of data (Required) |
Type | code |
Summary | true |
StructureMap.group.input.documentation | |
Definition | Documentation for this instance of data. |
Control | 0..1 |
Type | string |
StructureMap.group.rule | |
Definition | Transform Rule from source to target. |
Control | 1..* |
Summary | true |
StructureMap.group.rule.name | |
Definition | Name of the rule for internal references. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.rule.source | |
Definition | Source inputs to the mapping. |
Control | 1..* |
Summary | true |
StructureMap.group.rule.source.required | |
Definition | Whether this rule applies if the source isn't found. |
Control | 1..1 |
Type | boolean |
Summary | true |
StructureMap.group.rule.source.context | |
Definition | Type or variable this rule applies to. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.rule.source.contextType | |
Definition | How to interpret the context. |
Control | 1..1 |
Binding | StructureMapContextType: How to interpret the context (Required) |
Type | code |
Summary | true |
StructureMap.group.rule.source.element | |
Definition | Optional field for this source. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.rule.source.listMode | |
Definition | How to handle the list mode for this element. |
Control | 0..1 |
Binding | StructureMapListMode: If field is a list, how to manage the list (Required) |
Type | code |
Summary | true |
StructureMap.group.rule.source.variable | |
Definition | Named context for field, if a field is specified. |
Control | 0..1 |
Type | id |
Summary | true |
StructureMap.group.rule.source.condition | |
Definition | FluentPath expression - must be true or the rule does not apply. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.rule.source.check | |
Definition | FluentPath expression - must be true or the mapping engine throws an error instead of completing. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.rule.target | |
Definition | Content to create because of this mapping rule. |
Control | 0..* |
Summary | true |
StructureMap.group.rule.target.context | |
Definition | Type or variable this rule applies to. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.rule.target.contextType | |
Definition | How to interpret the context. |
Control | 1..1 |
Binding | StructureMapContextType: How to interpret the context (Required) |
Type | code |
Summary | true |
StructureMap.group.rule.target.element | |
Definition | Field to create in the context. |
Control | 0..1 |
Type | string |
Summary | true |
StructureMap.group.rule.target.variable | |
Definition | Named context for field, if desired, and a field is specified. |
Control | 0..1 |
Type | id |
Summary | true |
StructureMap.group.rule.target.listMode | |
Definition | If field is a list, how to manage the list. |
Control | 0..* |
Binding | StructureMapListMode: If field is a list, how to manage the list (Required) |
Type | code |
Summary | true |
StructureMap.group.rule.target.listRuleId | |
Definition | Internal rule reference for shared list items. |
Control | 0..1 |
Type | id |
Summary | true |
StructureMap.group.rule.target.transform | |
Definition | How the data is copied / created. |
Control | 0..1 |
Binding | StructureMapTransform: How data is copied / created (Required) |
Type | code |
Summary | true |
StructureMap.group.rule.target.parameter | |
Definition | Parameters to the transform. |
Control | 0..* |
Summary | true |
StructureMap.group.rule.target.parameter.value[x] | |
Definition | Parameter value - variable or literal. |
Control | 1..1 |
Type | id|string|boolean|integer|decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
StructureMap.group.rule.rule | |
Definition | Rules contained in this rule. |
Control | 0..* |
Type | See StructureMap.group.rule |
Summary | true |
StructureMap.group.rule.dependent | |
Definition | Which other rules to apply in the context of this rule. |
Control | 0..* |
Summary | true |
StructureMap.group.rule.dependent.name | |
Definition | Name of a rule or group to apply. |
Control | 1..1 |
Type | id |
Summary | true |
StructureMap.group.rule.dependent.variable | |
Definition | Names of variables to pass to the rule or group. |
Control | 1..* |
Type | string |
Summary | true |
StructureMap.group.rule.documentation | |
Definition | Documentation for this instance of data. |
Control | 0..1 |
Type | string |