http://hl7.org/fhir/StructureDefinition/StructureMap|4.0.1

A Map of relationships between 2 structures that can be used to transform data.
NameFlagsCardTypeDescription & Constraints
StructureMap
0..*A Map of relationships between 2 structures that can be used to transform data
 
url *
Σ
1..1uriCanonical identifier for this structure map, represented as a URI (globally unique)
 
identifier
Σ
0..*IdentifierAdditional identifier for the structure map
 
version
Σ
0..1stringBusiness version of the structure map
 
name *
Σ
1..1stringName for this structure map (computer friendly)
 
title
Σ
0..1stringName for this structure map (human friendly)
 
status *
?!Σ
1..1codedraft | active | retired | unknown PublicationStatus (required)
 
experimental
Σ
0..1booleanFor testing purposes, not real usage
 
date
Σ
0..1dateTimeDate last changed
 
publisher
Σ
0..1stringName of the publisher (organization or individual)
 
contact
Σ
0..*ContactDetailContact details for the publisher
 
description
0..1markdownNatural language description of the structure map
 
useContext
Σ
0..*UsageContextThe context that the content is intended to support
 
jurisdiction
Σ
0..*CodeableConceptIntended jurisdiction for structure map (if applicable) Jurisdiction (extensible)
 
purpose
0..1markdownWhy this structure map is defined
 
copyright
0..1markdownUse and/or publishing restrictions
 
structure
Σ
0..*BackboneElementStructure Definition used by this map
 
 
url *
Σ
1..1canonicalCanonical reference to structure definition
 
 
mode *
Σ
1..1codesource | queried | target | produced StructureMapModelMode (required)
 
 
alias
Σ
0..1stringName for type in this map
 
 
documentation
0..1stringDocumentation on use of structure
 
import
Σ
0..*canonicalOther maps used by this map (canonical URLs)
 
group *
Σ
1..*BackboneElementNamed sections for reader convenience
 
 
name *
Σ
1..1idHuman-readable label
 
 
extends
Σ
0..1idAnother group that this group adds rules to
 
 
typeMode *
Σ
1..1codenone | types | type-and-types StructureMapGroupTypeMode (required)
 
 
documentation
Σ
0..1stringAdditional description/explanation for group
 
 
input *
Σ
1..*BackboneElementNamed instance provided when invoking the map
 
 
 
name *
Σ
1..1idName for this instance of data
 
 
 
type
Σ
0..1stringType for this instance of data
 
 
 
mode *
Σ
1..1codesource | target StructureMapInputMode (required)
 
 
 
documentation
0..1stringDocumentation for this instance of data
 
 
rule *
Σ
1..*BackboneElementTransform Rule from source to target
 
 
 
name *
Σ
1..1idName of the rule for internal references
 
 
 
source *
Σ
1..*BackboneElementSource inputs to the mapping
 
 
 
 
context *
Σ
1..1idType or variable this rule applies to
 
 
 
 
min
Σ
0..1integerSpecified minimum cardinality
 
 
 
 
max
Σ
0..1stringSpecified maximum cardinality (number or *)
 
 
 
 
type
Σ
0..1stringRule only applies if source has this type
 
 
 
 
defaultValue[x]
Σ
0..1Default value if no value exists
 
 
 
 
 
defaultValueBase64Binary
Σ
0..1base64Binary
 
 
 
 
 
defaultValueBoolean
Σ
0..1boolean
 
 
 
 
 
defaultValueCanonical
Σ
0..1canonical
 
 
 
 
 
defaultValueCode
Σ
0..1code
 
 
 
 
 
defaultValueDate
Σ
0..1date
 
 
 
 
 
defaultValueDateTime
Σ
0..1dateTime
 
 
 
 
 
defaultValueDecimal
Σ
0..1decimal
 
 
 
 
 
defaultValueId
Σ
0..1id
 
 
 
 
 
defaultValueInstant
Σ
0..1instant
 
 
 
 
 
defaultValueInteger
Σ
0..1integer
 
 
 
 
 
defaultValueMarkdown
Σ
0..1markdown
 
 
 
 
 
defaultValueOid
Σ
0..1oid
 
 
 
 
 
defaultValuePositiveInt
Σ
0..1positiveInt
 
 
 
 
 
defaultValueString
Σ
0..1string
 
 
 
 
 
defaultValueTime
Σ
0..1time
 
 
 
 
 
defaultValueUnsignedInt
Σ
0..1unsignedInt
 
 
 
 
 
defaultValueUri
Σ
0..1uri
 
 
 
 
 
defaultValueUrl
Σ
0..1url
 
 
 
 
 
defaultValueUuid
Σ
0..1uuid
 
 
 
 
 
defaultValueAddress
Σ
0..1Address
 
 
 
 
 
defaultValueAge
Σ
0..1Age
 
 
 
 
 
defaultValueAnnotation
Σ
0..1Annotation
 
 
 
 
 
defaultValueAttachment
Σ
0..1Attachment
 
 
 
 
 
defaultValueCodeableConcept
Σ
0..1CodeableConcept
 
 
 
 
 
defaultValueCoding
Σ
0..1Coding
 
 
 
 
 
defaultValueContactPoint
Σ
0..1ContactPoint
 
 
 
 
 
defaultValueCount
Σ
0..1Count
 
 
 
 
 
defaultValueDistance
Σ
0..1Distance
 
 
 
 
 
defaultValueDuration
Σ
0..1Duration
 
 
 
 
 
defaultValueHumanName
Σ
0..1HumanName
 
 
 
 
 
defaultValueIdentifier
Σ
0..1Identifier
 
 
 
 
 
defaultValueMoney
Σ
0..1Money
 
 
 
 
 
defaultValuePeriod
Σ
0..1Period
 
 
 
 
 
defaultValueQuantity
Σ
0..1Quantity
 
 
 
 
 
defaultValueRange
Σ
0..1Range
 
 
 
 
 
defaultValueRatio
Σ
0..1Ratio
 
 
 
 
 
defaultValueReference
Σ
0..1Reference
 
 
 
 
 
defaultValueSampledData
Σ
0..1SampledData
 
 
 
 
 
defaultValueSignature
Σ
0..1Signature
 
 
 
 
 
defaultValueTiming
Σ
0..1Timing
 
 
 
 
 
defaultValueContactDetail
Σ
0..1ContactDetail
 
 
 
 
 
defaultValueContributor
Σ
0..1Contributor
 
 
 
 
 
defaultValueDataRequirement
Σ
0..1DataRequirement
 
 
 
 
 
defaultValueExpression
Σ
0..1Expression
 
 
 
 
 
defaultValueParameterDefinition
Σ
0..1ParameterDefinition
 
 
 
 
 
defaultValueRelatedArtifact
Σ
0..1RelatedArtifact
 
 
 
 
 
defaultValueTriggerDefinition
Σ
0..1TriggerDefinition
 
 
 
 
 
defaultValueUsageContext
Σ
0..1UsageContext
 
 
 
 
 
defaultValueDosage
Σ
0..1Dosage
 
 
 
 
 
defaultValueMeta
Σ
0..1Meta
 
 
 
 
element
Σ
0..1stringOptional field for this source
 
 
 
 
listMode
Σ
0..1codefirst | not_first | last | not_last | only_one StructureMapSourceListMode (required)
 
 
 
 
variable
Σ
0..1idNamed context for field, if a field is specified
 
 
 
 
condition
Σ
0..1stringFHIRPath expression - must be true or the rule does not apply
 
 
 
 
check
Σ
0..1stringFHIRPath expression - must be true or the mapping engine throws an error instead of completing
 
 
 
 
logMessage
Σ
0..1stringMessage to put in log if source exists (FHIRPath)
 
 
 
target
Σ
0..*BackboneElementContent to create because of this mapping rule
 
 
 
 
context
Σ
0..1idType or variable this rule applies to
 
 
 
 
contextType
Σ
0..1codetype | variable StructureMapContextType (required)
 
 
 
 
element
Σ
0..1stringField to create in the context
 
 
 
 
variable
Σ
0..1idNamed context for field, if desired, and a field is specified
 
 
 
 
listMode
Σ
0..*codefirst | share | last | collate StructureMapTargetListMode (required)
 
 
 
 
listRuleId
Σ
0..1idInternal rule reference for shared list items
 
 
 
 
transform
Σ
0..1codecreate | copy + StructureMapTransform (required)
 
 
 
 
parameter
Σ
0..*BackboneElementParameters to the transform
 
 
 
 
 
value[x] *
Σ
1..1Parameter value - variable or literal
 
 
 
 
 
 
valueId *
Σ
1..1id
 
 
 
 
 
 
valueString *
Σ
1..1string
 
 
 
 
 
 
valueBoolean *
Σ
1..1boolean
 
 
 
 
 
 
valueInteger *
Σ
1..1integer
 
 
 
 
 
 
valueDecimal *
Σ
1..1decimal
 
 
 
rule
Σ
0..*Rules contained in this rule
 
 
 
dependent
Σ
0..*BackboneElementWhich other rules to apply in the context of this rule
 
 
 
 
name *
Σ
1..1idName of a rule or group to apply
 
 
 
 
variable *
Σ
1..*stringVariable to pass to the rule or group
 
 
 
documentation
0..1stringDocumentation for this instance of data