StructureMap
A Map of relationships between 2 structures that can be used to transform data.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 13 of 15 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlRequiredΣ | 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 |
nameRequiredΣ | 1..1 | string | Name for this structure map (computer friendly) |
titleΣ | 0..1 | string | Name for this structure map (human friendly) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
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)Binding (extensible): jurisdiction |
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 |
urlRequiredΣ | 1..1 | canonical(StructureDefinition) | Canonical reference to structure definition |
modeRequiredΣ | 1..1 | code | source | queried | target | producedBinding (required): map-model-mode |
aliasΣ | 0..1 | string | Name for type in this map |
documentation | 0..1 | string | Documentation on use of structure |
importΣ | 0..* | canonical(StructureMap) | Other maps used by this map (canonical URLs) |
groupRequiredΣ | 1..* | BackboneElement | Named sections for reader convenience |
nameRequiredΣ | 1..1 | id | Human-readable label |
extendsΣ | 0..1 | id | Another group that this group adds rules to |
typeModeRequiredΣ | 1..1 | code | none | types | type-and-typesBinding (required): map-group-type-mode |
documentationΣ | 0..1 | string | Additional description/explanation for group |
inputRequiredΣ | 1..* | BackboneElement | Named instance provided when invoking the map |
nameRequiredΣ | 1..1 | id | Name for this instance of data |
typeΣ | 0..1 | string | Type for this instance of data |
modeRequiredΣ | 1..1 | code | source | targetBinding (required): map-input-mode |
documentation | 0..1 | string | Documentation for this instance of data |
ruleRequiredΣ | 1..* | BackboneElement | Transform Rule from source to target |
nameRequiredΣ | 1..1 | id | Name of the rule for internal references |
sourceRequiredΣ | 1..* | BackboneElement | Source inputs to the mapping |
contextRequiredΣ | 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_oneBinding (required): map-source-list-mode |
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 |
contextΣ | 0..1 | id | Type or variable this rule applies to |
contextTypeΣ | 0..1 | code | type | variableBinding (required): map-context-type |
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 | collateBinding (required): map-target-list-mode |
listRuleIdΣ | 0..1 | id | Internal rule reference for shared list items |
transformΣ | 0..1 | code | create | copy +Binding (required): map-transform |
parameterΣ | 0..* | BackboneElement | Parameters to the transform |
value[x]RequiredΣ | 1..1 | id | string | boolean | integer | decimal | Parameter value - variable or literal |
ruleΣ | 0..* | Same as StructureMap.group.rule | Rules contained in this rule |
dependentΣ | 0..* | BackboneElement | Which other rules to apply in the context of this rule |
nameRequiredΣ | 1..1 | id | Name of a rule or group to apply |
variableRequiredΣ | 1..* | string | Variable to pass to the rule or group |
documentation | 0..1 | string | Documentation for this instance of data |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/StructureMap?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
context | token | A use context assigned to the structure map (StructureMap.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the structure map (StructureMap.useContext.value.ofType(Quantity)) | (StructureMap.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the structure map StructureMap.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the structure map StructureMap.useContext | ||
context-type-value | composite | A use context type and value assigned to the structure map StructureMap.useContext | ||
date | date | The structure map publication date StructureMap.date | ||
description | string | The description of the structure map StructureMap.description | ||
identifier | token | External identifier for the structure map StructureMap.identifier | ||
jurisdiction | token | Intended jurisdiction for the structure map StructureMap.jurisdiction | ||
name | string | Computationally friendly name of the structure map StructureMap.name | ||
publisher | string | Name of the publisher of the structure map StructureMap.publisher | ||
status | token | The current status of the structure map StructureMap.status | ||
title | string | The human-friendly name of the structure map StructureMap.title | ||
url | uri | The uri that identifies the structure map StructureMap.url | ||
version | token | The business version of the structure map StructureMap.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken