StructureMap
FoundationA Map of relationships between 2 structures that can be used to transform data.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| StructureMap | 0..* | — | A Map of relationships between 2 structures that can be used to transform data |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 1..1 | uri | Canonical identifier for this structure map, represented as a URI (globally unique) |
| .identifierΣ | 0..* | Identifier | Additional identifier for the structure map |
| .versionΣ | 0..1 | string | Business version of the structure map |
| .nameΣ | 1..1 | string | Name for this structure map (computer friendly) |
| .titleΣ | 0..1 | string | Name for this structure map (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 0..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .description | 0..1 | markdown | Natural language description of the structure map |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for structure map (if applicable) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this structure map is defined |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .structureΣ | 0..* | BackboneElement | Structure Definition used by this map |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .urlΣ | 1..1 | canonical | Canonical reference to structure definition |
| .modeΣ | 1..1 | code | source | queried | target | produced Bindingmap-model-mode(required) |
| .aliasΣ | 0..1 | string | Name for type in this map |
| .documentation | 0..1 | string | Documentation on use of structure |
| .importΣ | 0..* | canonical | Other maps used by this map (canonical URLs) |
| .groupΣ | 1..* | BackboneElement | Named sections for reader convenience |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .nameΣ | 1..1 | id | Human-readable label |
| .extendsΣ | 0..1 | id | Another group that this group adds rules to |
| .typeModeΣ | 1..1 | code | none | types | type-and-types Bindingmap-group-type-mode(required) |
| .documentationΣ | 0..1 | string | Additional description/explanation for group |
| .inputΣ | 1..* | BackboneElement | Named instance provided when invoking the map |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .nameΣ | 1..1 | id | Name for this instance of data |
| .typeΣ | 0..1 | string | Type for this instance of data |
| .modeΣ | 1..1 | code | source | target Bindingmap-input-mode(required) |
| .documentation | 0..1 | string | Documentation for this instance of data |
| .ruleΣ | 1..* | BackboneElement | Transform Rule from source to target |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .nameΣ | 1..1 | id | Name of the rule for internal references |
| .sourceΣ | 1..* | BackboneElement | Source inputs to the mapping |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .contextΣ | 1..1 | id | Type or variable this rule applies to |
| .minΣ | 0..1 | integer | Specified minimum cardinality |
| .maxΣ | 0..1 | string | Specified maximum cardinality (number or *) |
| .typeΣ | 0..1 | string | Rule only applies if source has this type |
| .defaultValue[x]Σ | 0..1 | base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | time | unsignedInt | uri | url | uuid | Address | Age | Annotation | Attachment | CodeableConcept | Coding | ContactPoint | Count | Distance | Duration | HumanName | Identifier | Money | Period | Quantity | Range | Ratio | Reference | SampledData | Signature | Timing | ContactDetail | Contributor | DataRequirement | Expression | ParameterDefinition | RelatedArtifact | TriggerDefinition | UsageContext | Dosage | Meta | Default value if no value exists |
| .elementΣ | 0..1 | string | Optional field for this source |
| .listModeΣ | 0..1 | code | first | not_first | last | not_last | only_one Bindingmap-source-list-mode(required) |
| .variableΣ | 0..1 | id | Named context for field, if a field is specified |
| .conditionΣ | 0..1 | string | FHIRPath expression - must be true or the rule does not apply |
| .checkΣ | 0..1 | string | FHIRPath expression - must be true or the mapping engine throws an error instead of completing |
| .logMessageΣ | 0..1 | string | Message to put in log if source exists (FHIRPath) |
| .targetΣ | 0..* | BackboneElement | Content to create because of this mapping rule |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .contextΣ | 0..1 | id | Type or variable this rule applies to |
| .contextTypeΣ | 0..1 | code | type | variable Bindingmap-context-type(required) |
| .elementΣ | 0..1 | string | Field to create in the context |
| .variableΣ | 0..1 | id | Named context for field, if desired, and a field is specified |
| .listModeΣ | 0..* | code | first | share | last | collate Bindingmap-target-list-mode(required) |
| .listRuleIdΣ | 0..1 | id | Internal rule reference for shared list items |
| .transformΣ | 0..1 | code | create | copy + Bindingmap-transform(required) |
| .parameterΣ | 0..* | BackboneElement | Parameters to the transform |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .value[x]Σ | 1..1 | id | string | boolean | integer | decimal | Parameter value - variable or literal |
| .ruleΣ | 0..* | — | Rules contained in this rule |
| .dependentΣ | 0..* | BackboneElement | Which other rules to apply in the context of this rule |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .nameΣ | 1..1 | id | Name of a rule or group to apply |
| .variableΣ | 1..* | string | Variable to pass to the rule or group |
| .documentation | 0..1 | string | Documentation for this instance of data |