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

A Map of relationships between 2 structures that can be used to transform data.

Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary

Name	Flags	Card	Type	Description & Constraints
StructureMap		0..*		A Map of relationships between 2 structures that can be used to transform data
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 PublicationStatus (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) Jurisdiction (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
url *	Σ	1..1	canonical	Canonical reference to structure definition
mode *	Σ	1..1	code	source \| queried \| target \| produced StructureMapModelMode (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
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 StructureMapGroupTypeMode (required)
documentation	Σ	0..1	string	Additional description/explanation for group
input *	Σ	1..*	BackboneElement	Named instance provided when invoking the map
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 StructureMapInputMode (required)
documentation		0..1	string	Documentation for this instance of data
rule *	Σ	1..*	BackboneElement	Transform Rule from source to target
name *	Σ	1..1	id	Name of the rule for internal references
source *	Σ	1..*	BackboneElement	Source inputs to the mapping
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		Default value if no value exists
defaultValueBase64Binary	Σ	0..1	base64Binary
defaultValueBoolean	Σ	0..1	boolean
defaultValueCanonical	Σ	0..1	canonical
defaultValueCode	Σ	0..1	code
defaultValueDate	Σ	0..1	date
defaultValueDateTime	Σ	0..1	dateTime
defaultValueDecimal	Σ	0..1	decimal
defaultValueId	Σ	0..1	id
defaultValueInstant	Σ	0..1	instant
defaultValueInteger	Σ	0..1	integer
defaultValueMarkdown	Σ	0..1	markdown
defaultValueOid	Σ	0..1	oid
defaultValuePositiveInt	Σ	0..1	positiveInt
defaultValueString	Σ	0..1	string
defaultValueTime	Σ	0..1	time
defaultValueUnsignedInt	Σ	0..1	unsignedInt
defaultValueUri	Σ	0..1	uri
defaultValueUrl	Σ	0..1	url
defaultValueUuid	Σ	0..1	uuid
defaultValueAddress	Σ	0..1	Address
defaultValueAge	Σ	0..1	Age
defaultValueAnnotation	Σ	0..1	Annotation
defaultValueAttachment	Σ	0..1	Attachment
defaultValueCodeableConcept	Σ	0..1	CodeableConcept
defaultValueCoding	Σ	0..1	Coding
defaultValueContactPoint	Σ	0..1	ContactPoint
defaultValueCount	Σ	0..1	Count
defaultValueDistance	Σ	0..1	Distance
defaultValueDuration	Σ	0..1	Duration
defaultValueHumanName	Σ	0..1	HumanName
defaultValueIdentifier	Σ	0..1	Identifier
defaultValueMoney	Σ	0..1	Money
defaultValuePeriod	Σ	0..1	Period
defaultValueQuantity	Σ	0..1	Quantity
defaultValueRange	Σ	0..1	Range
defaultValueRatio	Σ	0..1	Ratio
defaultValueReference	Σ	0..1	Reference
defaultValueSampledData	Σ	0..1	SampledData
defaultValueSignature	Σ	0..1	Signature
defaultValueTiming	Σ	0..1	Timing
defaultValueContactDetail	Σ	0..1	ContactDetail
defaultValueContributor	Σ	0..1	Contributor
defaultValueDataRequirement	Σ	0..1	DataRequirement
defaultValueExpression	Σ	0..1	Expression
defaultValueParameterDefinition	Σ	0..1	ParameterDefinition
defaultValueRelatedArtifact	Σ	0..1	RelatedArtifact
defaultValueTriggerDefinition	Σ	0..1	TriggerDefinition
defaultValueUsageContext	Σ	0..1	UsageContext
defaultValueDosage	Σ	0..1	Dosage
defaultValueMeta	Σ	0..1	Meta
element	Σ	0..1	string	Optional field for this source
listMode	Σ	0..1	code	first \| not_first \| last \| not_last \| only_one StructureMapSourceListMode (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
context	Σ	0..1	id	Type or variable this rule applies to
contextType	Σ	0..1	code	type \| variable StructureMapContextType (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 StructureMapTargetListMode (required)
listRuleId	Σ	0..1	id	Internal rule reference for shared list items
transform	Σ	0..1	code	create \| copy + StructureMapTransform (required)
parameter	Σ	0..*	BackboneElement	Parameters to the transform
value[x] *	Σ	1..1		Parameter value - variable or literal
valueId *	Σ	1..1	id
valueString *	Σ	1..1	string
valueBoolean *	Σ	1..1	boolean
valueInteger *	Σ	1..1	integer
valueDecimal *	Σ	1..1	decimal
rule	Σ	0..*		Rules contained in this rule
dependent	Σ	0..*	BackboneElement	Which other rules to apply in the context of this rule
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