Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Resource Profile: Profile_R3_StructureMap_R4B

This cross-version profile allows STU3 StructureMap content to be represented via FHIR R4B StructureMap resources.

Usages:

• Refer to this Profile: STU3: transform additional types and STU3: transform additional types

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap	C	0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data Constraints: smp-0
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
url	Σ	1..1	uri	Canonical identifier for this structure map, represented as a URI (globally unique)
name	Σ	1..1	string	Name for this structure map (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
group	Σ	1..*	BackboneElement	Named sections for reader convenience
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Human-readable label
typeMode	Σ	1..1	code	none | types | type-and-types Binding: StructureMapGroupTypeMode (required): If this is the default rule set to apply for the source type, or this combination of types.
input	Σ	1..*	BackboneElement	Named instance provided when invoking the map
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Name for this instance of data
mode	Σ	1..1	code	source | target Binding: StructureMapInputMode (required): Mode for this instance of data.
rule	Σ	1..*	BackboneElement	Transform Rule from source to target
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Name of the rule for internal references
source	Σ	1..*	BackboneElement	Source inputs to the mapping
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
context	Σ	1..1	id	Type or variable this rule applies to
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
StructureMap.status	Base	required	PublicationStatus	📍4.3.0	FHIR Std.
StructureMap.group.typeMode	Base	required	StructureMapGroupTypeMode	📍4.3.0	FHIR Std.
StructureMap.group.input.​mode	Base	required	StructureMapInputMode	📍4.3.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	StructureMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	StructureMap	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	StructureMap	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	StructureMap.implicitRules, StructureMap.modifierExtension, StructureMap.url, StructureMap.name, StructureMap.status, StructureMap.group, StructureMap.group.modifierExtension, StructureMap.group.name, StructureMap.group.typeMode, StructureMap.group.input, StructureMap.group.input.modifierExtension, StructureMap.group.input.name, StructureMap.group.input.mode, StructureMap.group.rule, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.name, StructureMap.group.rule.source, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.source.context	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	StructureMap.modifierExtension, StructureMap.group.modifierExtension, StructureMap.group.input.modifierExtension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
smp-0	warning	StructureMap	Name should be usable as an identifier for the module by machine processing applications such as code generation	name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from StructureMap

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap		0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data
meta
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:meta		0..1	(Complex)	STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta
text
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:text		0..1	(Complex)	STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text
identifier
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	Identifier	STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contact		0..*	ContactDetail	STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact
useContext
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:useContext		0..*	UsageContext	STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext
group
rule
source
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap	C	0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data Constraints: smp-0
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:meta		0..1	(Complex)	STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta Constraints: ext-1
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:text		0..1	(Complex)	STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text Constraints: ext-1
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required)
div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..*	Identifier	STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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 Binding: PublicationStatus (required): The lifecycle status of an artifact.
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:contact		0..*	ContactDetail	STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact Constraints: ext-1
name	Σ	0..1	string	Name of an individual to contact
telecom	Σ	0..*	ContactPoint	Contact details for individual or organization
description		0..1	markdown	Natural language description of the structure map
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:useContext		0..*	UsageContext	STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext Constraints: ext-1
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible)
value[x]	Σ	1..1		Value that defines the context Binding: Context of Use ValueSet (example)
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for structure map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
url	Σ	1..1	canonical(StructureDefinition)	Canonical reference to structure definition
mode	Σ	1..1	code	source | queried | target | produced Binding: StructureMapModelMode (required): How the referenced structure is used in this mapping.
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)
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Binding: StructureMapGroupTypeMode (required): If this is the default rule set to apply for the source type, or this combination of types.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Binding: StructureMapInputMode (required): Mode for this instance of data.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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			base64Binary
defaultValueBoolean			boolean
defaultValueCanonical			canonical(Any)
defaultValueCode			code
defaultValueDate			date
defaultValueDateTime			dateTime
defaultValueDecimal			decimal
defaultValueId			id
defaultValueInstant			instant
defaultValueInteger			integer
defaultValueMarkdown			markdown
defaultValueOid			oid
defaultValuePositiveInt			positiveInt
defaultValueString			string
defaultValueTime			time
defaultValueUnsignedInt			unsignedInt
defaultValueUri			uri
defaultValueUrl			url
defaultValueUuid			uuid
defaultValueAddress			Address
defaultValueAge			Age
defaultValueAnnotation			Annotation
defaultValueAttachment			Attachment
defaultValueCodeableConcept			CodeableConcept
defaultValueCoding			Coding
defaultValueContactPoint			ContactPoint
defaultValueCount			Count
defaultValueDistance			Distance
defaultValueDuration			Duration
defaultValueHumanName			HumanName
defaultValueIdentifier			Identifier
defaultValueMoney			Money
defaultValuePeriod			Period
defaultValueQuantity			Quantity
defaultValueRange			Range
defaultValueRatio			Ratio
defaultValueReference			Reference(Any)
defaultValueSampledData			SampledData
defaultValueSignature			Signature
defaultValueTiming			Timing
defaultValueContactDetail			ContactDetail
defaultValueContributor			Contributor
defaultValueDataRequirement			DataRequirement
defaultValueExpression			Expression
defaultValueParameterDefinition			ParameterDefinition
defaultValueRelatedArtifact			RelatedArtifact
defaultValueTriggerDefinition			TriggerDefinition
defaultValueUsageContext			UsageContext
defaultValueDosage			Dosage
defaultValueMeta			Meta
element	Σ	0..1	string	Optional field for this source
listMode	Σ	0..1	code	first | not_first | last | not_last | only_one Binding: StructureMapSourceListMode (required): If field is a list, how to manage the source.
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	ΣC	0..*	BackboneElement	Content to create because of this mapping rule Constraints: smp-1, smp-2
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
context	Σ	0..1	id	Type or variable this rule applies to
contextType	Σ	0..1	code	type | variable Binding: StructureMapContextType (required): How to interpret the context.
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 Binding: StructureMapTargetListMode (required): If field is a list, how to manage the production.
listRuleId	Σ	0..1	id	Internal rule reference for shared list items
transform	Σ	0..1	code	create | copy + Binding: StructureMapTransform (required): How data is copied/created.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
value[x]	Σ	1..1		Parameter value - variable or literal
valueId			id
valueString			string
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
rule	Σ	0..*	See rule (StructureMap)	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
StructureMap.meta.security	Base	extensible	SecurityLabels	📍4.3.0	FHIR Std.
StructureMap.meta.tag	Base	example	Common Tags	📍4.3.0	FHIR Std.
StructureMap.language	Base	preferred	Common Languages	📍4.3.0	FHIR Std.
StructureMap.text.status	Base	required	NarrativeStatus	📍4.3.0	FHIR Std.
StructureMap.identifier.​use	Base	required	IdentifierUse	📍4.3.0	FHIR Std.
StructureMap.identifier.​type	Base	extensible	IdentifierType	📍4.3.0	FHIR Std.
StructureMap.status	Base	required	PublicationStatus	📍4.3.0	FHIR Std.
StructureMap.useContext.​code	Base	extensible	UsageContextType	📍4.3.0	FHIR Std.
StructureMap.useContext.​value[x]	Base	example	ConformanceUseContext	📍4.3.0	FHIR Std.
StructureMap.jurisdiction	Base	extensible	Jurisdiction	📍4.3.0	FHIR Std.
StructureMap.structure.​mode	Base	required	StructureMapModelMode	📍4.3.0	FHIR Std.
StructureMap.group.typeMode	Base	required	StructureMapGroupTypeMode	📍4.3.0	FHIR Std.
StructureMap.group.input.​mode	Base	required	StructureMapInputMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​source.listMode	Base	required	StructureMapSourceListMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.contextType	Base	required	StructureMapContextType	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.listMode	Base	required	StructureMapTargetListMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.transform	Base	required	StructureMapTransform	📍4.3.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	StructureMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	StructureMap	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	StructureMap	A resource should have narrative for robust management	text.`div`.exists()
dom-r4b	warning	StructureMap.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	StructureMap.meta, StructureMap.meta.extension, StructureMap.meta.extension:meta, StructureMap.meta.versionId, StructureMap.meta.lastUpdated, StructureMap.meta.source, StructureMap.meta.profile, StructureMap.meta.security, StructureMap.meta.tag, StructureMap.implicitRules, StructureMap.language, StructureMap.text, StructureMap.text.extension, StructureMap.text.extension:text, StructureMap.text.status, StructureMap.text.div, StructureMap.extension, StructureMap.modifierExtension, StructureMap.url, StructureMap.identifier, StructureMap.identifier.extension, StructureMap.identifier.extension:identifier, StructureMap.identifier.use, StructureMap.identifier.type, StructureMap.identifier.system, StructureMap.identifier.value, StructureMap.identifier.period, StructureMap.identifier.assigner, StructureMap.version, StructureMap.name, StructureMap.title, StructureMap.status, StructureMap.experimental, StructureMap.date, StructureMap.publisher, StructureMap.contact, StructureMap.contact.extension, StructureMap.contact.extension:contact, StructureMap.contact.name, StructureMap.contact.telecom, StructureMap.description, StructureMap.useContext, StructureMap.useContext.extension, StructureMap.useContext.extension:useContext, StructureMap.useContext.code, StructureMap.useContext.value[x], StructureMap.jurisdiction, StructureMap.purpose, StructureMap.copyright, StructureMap.structure, StructureMap.structure.extension, StructureMap.structure.modifierExtension, StructureMap.structure.url, StructureMap.structure.mode, StructureMap.structure.alias, StructureMap.structure.documentation, StructureMap.import, StructureMap.group, StructureMap.group.extension, StructureMap.group.modifierExtension, StructureMap.group.name, StructureMap.group.extends, StructureMap.group.typeMode, StructureMap.group.documentation, StructureMap.group.input, StructureMap.group.input.extension, StructureMap.group.input.modifierExtension, StructureMap.group.input.name, StructureMap.group.input.type, StructureMap.group.input.mode, StructureMap.group.input.documentation, StructureMap.group.rule, StructureMap.group.rule.extension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.name, StructureMap.group.rule.source, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.source.context, StructureMap.group.rule.source.min, StructureMap.group.rule.source.max, StructureMap.group.rule.source.type, StructureMap.group.rule.source.defaultValue[x], StructureMap.group.rule.source.element, StructureMap.group.rule.source.listMode, StructureMap.group.rule.source.variable, StructureMap.group.rule.source.condition, StructureMap.group.rule.source.check, StructureMap.group.rule.source.logMessage, StructureMap.group.rule.target, StructureMap.group.rule.target.extension, StructureMap.group.rule.target.modifierExtension, StructureMap.group.rule.target.context, StructureMap.group.rule.target.contextType, StructureMap.group.rule.target.element, StructureMap.group.rule.target.variable, StructureMap.group.rule.target.listMode, StructureMap.group.rule.target.listRuleId, StructureMap.group.rule.target.transform, StructureMap.group.rule.target.parameter, StructureMap.group.rule.target.parameter.extension, StructureMap.group.rule.target.parameter.modifierExtension, StructureMap.group.rule.target.parameter.value[x], StructureMap.group.rule.rule, StructureMap.group.rule.dependent, StructureMap.group.rule.dependent.extension, StructureMap.group.rule.dependent.modifierExtension, StructureMap.group.rule.dependent.name, StructureMap.group.rule.dependent.variable, StructureMap.group.rule.documentation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	StructureMap.meta.extension, StructureMap.meta.extension:meta, StructureMap.text.extension, StructureMap.text.extension:text, StructureMap.extension, StructureMap.modifierExtension, StructureMap.identifier.extension, StructureMap.identifier.extension:identifier, StructureMap.contact.extension, StructureMap.contact.extension:contact, StructureMap.useContext.extension, StructureMap.useContext.extension:useContext, StructureMap.structure.extension, StructureMap.structure.modifierExtension, StructureMap.group.extension, StructureMap.group.modifierExtension, StructureMap.group.input.extension, StructureMap.group.input.modifierExtension, StructureMap.group.rule.extension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.target.extension, StructureMap.group.rule.target.modifierExtension, StructureMap.group.rule.target.parameter.extension, StructureMap.group.rule.target.parameter.modifierExtension, StructureMap.group.rule.dependent.extension, StructureMap.group.rule.dependent.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
smp-0	warning	StructureMap	Name should be usable as an identifier for the module by machine processing applications such as code generation	name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
smp-1	error	StructureMap.group.rule.target	Can only have an element if you have a context	element.exists() implies context.exists()
smp-2	error	StructureMap.group.rule.target	Must have a contextType if you have a context	context.exists() implies contextType.exists()
txt-1	error	StructureMap.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	StructureMap.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from StructureMap

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue|0.1.0

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap	C	0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data Constraints: smp-0
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
url	Σ	1..1	uri	Canonical identifier for this structure map, represented as a URI (globally unique)
name	Σ	1..1	string	Name for this structure map (computer friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
group	Σ	1..*	BackboneElement	Named sections for reader convenience
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Human-readable label
typeMode	Σ	1..1	code	none | types | type-and-types Binding: StructureMapGroupTypeMode (required): If this is the default rule set to apply for the source type, or this combination of types.
input	Σ	1..*	BackboneElement	Named instance provided when invoking the map
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Name for this instance of data
mode	Σ	1..1	code	source | target Binding: StructureMapInputMode (required): Mode for this instance of data.
rule	Σ	1..*	BackboneElement	Transform Rule from source to target
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
name	Σ	1..1	id	Name of the rule for internal references
source	Σ	1..*	BackboneElement	Source inputs to the mapping
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
context	Σ	1..1	id	Type or variable this rule applies to
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
StructureMap.status	Base	required	PublicationStatus	📍4.3.0	FHIR Std.
StructureMap.group.typeMode	Base	required	StructureMapGroupTypeMode	📍4.3.0	FHIR Std.
StructureMap.group.input.​mode	Base	required	StructureMapInputMode	📍4.3.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	StructureMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	StructureMap	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	StructureMap	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	StructureMap.implicitRules, StructureMap.modifierExtension, StructureMap.url, StructureMap.name, StructureMap.status, StructureMap.group, StructureMap.group.modifierExtension, StructureMap.group.name, StructureMap.group.typeMode, StructureMap.group.input, StructureMap.group.input.modifierExtension, StructureMap.group.input.name, StructureMap.group.input.mode, StructureMap.group.rule, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.name, StructureMap.group.rule.source, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.source.context	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	StructureMap.modifierExtension, StructureMap.group.modifierExtension, StructureMap.group.input.modifierExtension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
smp-0	warning	StructureMap	Name should be usable as an identifier for the module by machine processing applications such as code generation	name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Differential View

This structure is derived from StructureMap

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap		0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data
meta
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:meta		0..1	(Complex)	STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta
text
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:text		0..1	(Complex)	STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text
identifier
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier		0..*	Identifier	STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contact		0..*	ContactDetail	STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact
useContext
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:useContext		0..*	UsageContext	STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext
group
rule
source
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
StructureMap	C	0..*	StructureMap(4.3.0)	A Map of relationships between 2 structures that can be used to transform data Constraints: smp-0
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:meta		0..1	(Complex)	STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta Constraints: ext-1
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:text		0..1	(Complex)	STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text Constraints: ext-1
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required)
div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:identifier		0..*	Identifier	STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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 Binding: PublicationStatus (required): The lifecycle status of an artifact.
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
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:contact		0..*	ContactDetail	STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact Constraints: ext-1
name	Σ	0..1	string	Name of an individual to contact
telecom	Σ	0..*	ContactPoint	Contact details for individual or organization
description		0..1	markdown	Natural language description of the structure map
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
id		0..1	id	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:useContext		0..*	UsageContext	STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext Constraints: ext-1
code	Σ	1..1	Coding	Type of context being specified Binding: UsageContextType (extensible)
value[x]	Σ	1..1		Value that defines the context Binding: Context of Use ValueSet (example)
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for structure map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
url	Σ	1..1	canonical(StructureDefinition)	Canonical reference to structure definition
mode	Σ	1..1	code	source | queried | target | produced Binding: StructureMapModelMode (required): How the referenced structure is used in this mapping.
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)
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Binding: StructureMapGroupTypeMode (required): If this is the default rule set to apply for the source type, or this combination of types.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Binding: StructureMapInputMode (required): Mode for this instance of data.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:defaultValue		0..1	Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing	STU3: defaultValue additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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			base64Binary
defaultValueBoolean			boolean
defaultValueCanonical			canonical(Any)
defaultValueCode			code
defaultValueDate			date
defaultValueDateTime			dateTime
defaultValueDecimal			decimal
defaultValueId			id
defaultValueInstant			instant
defaultValueInteger			integer
defaultValueMarkdown			markdown
defaultValueOid			oid
defaultValuePositiveInt			positiveInt
defaultValueString			string
defaultValueTime			time
defaultValueUnsignedInt			unsignedInt
defaultValueUri			uri
defaultValueUrl			url
defaultValueUuid			uuid
defaultValueAddress			Address
defaultValueAge			Age
defaultValueAnnotation			Annotation
defaultValueAttachment			Attachment
defaultValueCodeableConcept			CodeableConcept
defaultValueCoding			Coding
defaultValueContactPoint			ContactPoint
defaultValueCount			Count
defaultValueDistance			Distance
defaultValueDuration			Duration
defaultValueHumanName			HumanName
defaultValueIdentifier			Identifier
defaultValueMoney			Money
defaultValuePeriod			Period
defaultValueQuantity			Quantity
defaultValueRange			Range
defaultValueRatio			Ratio
defaultValueReference			Reference(Any)
defaultValueSampledData			SampledData
defaultValueSignature			Signature
defaultValueTiming			Timing
defaultValueContactDetail			ContactDetail
defaultValueContributor			Contributor
defaultValueDataRequirement			DataRequirement
defaultValueExpression			Expression
defaultValueParameterDefinition			ParameterDefinition
defaultValueRelatedArtifact			RelatedArtifact
defaultValueTriggerDefinition			TriggerDefinition
defaultValueUsageContext			UsageContext
defaultValueDosage			Dosage
defaultValueMeta			Meta
element	Σ	0..1	string	Optional field for this source
listMode	Σ	0..1	code	first | not_first | last | not_last | only_one Binding: StructureMapSourceListMode (required): If field is a list, how to manage the source.
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	ΣC	0..*	BackboneElement	Content to create because of this mapping rule Constraints: smp-1, smp-2
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
context	Σ	0..1	id	Type or variable this rule applies to
contextType	Σ	0..1	code	type | variable Binding: StructureMapContextType (required): How to interpret the context.
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 Binding: StructureMapTargetListMode (required): If field is a list, how to manage the production.
listRuleId	Σ	0..1	id	Internal rule reference for shared list items
transform	Σ	0..1	code	create | copy + Binding: StructureMapTransform (required): How data is copied/created.
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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
value[x]	Σ	1..1		Parameter value - variable or literal
valueId			id
valueString			string
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
rule	Σ	0..*	See rule (StructureMap)	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 Constraints: ext-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
StructureMap.meta.security	Base	extensible	SecurityLabels	📍4.3.0	FHIR Std.
StructureMap.meta.tag	Base	example	Common Tags	📍4.3.0	FHIR Std.
StructureMap.language	Base	preferred	Common Languages	📍4.3.0	FHIR Std.
StructureMap.text.status	Base	required	NarrativeStatus	📍4.3.0	FHIR Std.
StructureMap.identifier.​use	Base	required	IdentifierUse	📍4.3.0	FHIR Std.
StructureMap.identifier.​type	Base	extensible	IdentifierType	📍4.3.0	FHIR Std.
StructureMap.status	Base	required	PublicationStatus	📍4.3.0	FHIR Std.
StructureMap.useContext.​code	Base	extensible	UsageContextType	📍4.3.0	FHIR Std.
StructureMap.useContext.​value[x]	Base	example	ConformanceUseContext	📍4.3.0	FHIR Std.
StructureMap.jurisdiction	Base	extensible	Jurisdiction	📍4.3.0	FHIR Std.
StructureMap.structure.​mode	Base	required	StructureMapModelMode	📍4.3.0	FHIR Std.
StructureMap.group.typeMode	Base	required	StructureMapGroupTypeMode	📍4.3.0	FHIR Std.
StructureMap.group.input.​mode	Base	required	StructureMapInputMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​source.listMode	Base	required	StructureMapSourceListMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.contextType	Base	required	StructureMapContextType	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.listMode	Base	required	StructureMapTargetListMode	📍4.3.0	FHIR Std.
StructureMap.group.rule.​target.transform	Base	required	StructureMapTransform	📍4.3.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	StructureMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	StructureMap	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	StructureMap	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	StructureMap	A resource should have narrative for robust management	text.`div`.exists()
dom-r4b	warning	StructureMap.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	StructureMap.meta, StructureMap.meta.extension, StructureMap.meta.extension:meta, StructureMap.meta.versionId, StructureMap.meta.lastUpdated, StructureMap.meta.source, StructureMap.meta.profile, StructureMap.meta.security, StructureMap.meta.tag, StructureMap.implicitRules, StructureMap.language, StructureMap.text, StructureMap.text.extension, StructureMap.text.extension:text, StructureMap.text.status, StructureMap.text.div, StructureMap.extension, StructureMap.modifierExtension, StructureMap.url, StructureMap.identifier, StructureMap.identifier.extension, StructureMap.identifier.extension:identifier, StructureMap.identifier.use, StructureMap.identifier.type, StructureMap.identifier.system, StructureMap.identifier.value, StructureMap.identifier.period, StructureMap.identifier.assigner, StructureMap.version, StructureMap.name, StructureMap.title, StructureMap.status, StructureMap.experimental, StructureMap.date, StructureMap.publisher, StructureMap.contact, StructureMap.contact.extension, StructureMap.contact.extension:contact, StructureMap.contact.name, StructureMap.contact.telecom, StructureMap.description, StructureMap.useContext, StructureMap.useContext.extension, StructureMap.useContext.extension:useContext, StructureMap.useContext.code, StructureMap.useContext.value[x], StructureMap.jurisdiction, StructureMap.purpose, StructureMap.copyright, StructureMap.structure, StructureMap.structure.extension, StructureMap.structure.modifierExtension, StructureMap.structure.url, StructureMap.structure.mode, StructureMap.structure.alias, StructureMap.structure.documentation, StructureMap.import, StructureMap.group, StructureMap.group.extension, StructureMap.group.modifierExtension, StructureMap.group.name, StructureMap.group.extends, StructureMap.group.typeMode, StructureMap.group.documentation, StructureMap.group.input, StructureMap.group.input.extension, StructureMap.group.input.modifierExtension, StructureMap.group.input.name, StructureMap.group.input.type, StructureMap.group.input.mode, StructureMap.group.input.documentation, StructureMap.group.rule, StructureMap.group.rule.extension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.name, StructureMap.group.rule.source, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.source.context, StructureMap.group.rule.source.min, StructureMap.group.rule.source.max, StructureMap.group.rule.source.type, StructureMap.group.rule.source.defaultValue[x], StructureMap.group.rule.source.element, StructureMap.group.rule.source.listMode, StructureMap.group.rule.source.variable, StructureMap.group.rule.source.condition, StructureMap.group.rule.source.check, StructureMap.group.rule.source.logMessage, StructureMap.group.rule.target, StructureMap.group.rule.target.extension, StructureMap.group.rule.target.modifierExtension, StructureMap.group.rule.target.context, StructureMap.group.rule.target.contextType, StructureMap.group.rule.target.element, StructureMap.group.rule.target.variable, StructureMap.group.rule.target.listMode, StructureMap.group.rule.target.listRuleId, StructureMap.group.rule.target.transform, StructureMap.group.rule.target.parameter, StructureMap.group.rule.target.parameter.extension, StructureMap.group.rule.target.parameter.modifierExtension, StructureMap.group.rule.target.parameter.value[x], StructureMap.group.rule.rule, StructureMap.group.rule.dependent, StructureMap.group.rule.dependent.extension, StructureMap.group.rule.dependent.modifierExtension, StructureMap.group.rule.dependent.name, StructureMap.group.rule.dependent.variable, StructureMap.group.rule.documentation	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	StructureMap.meta.extension, StructureMap.meta.extension:meta, StructureMap.text.extension, StructureMap.text.extension:text, StructureMap.extension, StructureMap.modifierExtension, StructureMap.identifier.extension, StructureMap.identifier.extension:identifier, StructureMap.contact.extension, StructureMap.contact.extension:contact, StructureMap.useContext.extension, StructureMap.useContext.extension:useContext, StructureMap.structure.extension, StructureMap.structure.modifierExtension, StructureMap.group.extension, StructureMap.group.modifierExtension, StructureMap.group.input.extension, StructureMap.group.input.modifierExtension, StructureMap.group.rule.extension, StructureMap.group.rule.modifierExtension, StructureMap.group.rule.source.extension, StructureMap.group.rule.source.extension:defaultValue, StructureMap.group.rule.source.modifierExtension, StructureMap.group.rule.target.extension, StructureMap.group.rule.target.modifierExtension, StructureMap.group.rule.target.parameter.extension, StructureMap.group.rule.target.parameter.modifierExtension, StructureMap.group.rule.dependent.extension, StructureMap.group.rule.dependent.modifierExtension	Must have either extensions or value[x], not both	extension.exists() != value.exists()
smp-0	warning	StructureMap	Name should be usable as an identifier for the module by machine processing applications such as code generation	name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
smp-1	error	StructureMap.group.rule.target	Can only have an element if you have a context	element.exists() implies context.exists()
smp-2	error	StructureMap.group.rule.target	Must have a contextType if you have a context	context.exists() implies contextType.exists()
txt-1	error	StructureMap.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	StructureMap.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from StructureMap

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.meta|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.text|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.identifier|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.contact|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.useContext|0.1.0
• http://hl7.org/fhir/3.0/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue|0.1.0

Maturity: 0