Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable StructureMap

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuremap Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMIPublishableStructureMap
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.73

Supports declaration of the StructureMap metadata required by HL7 and other organizations that share and publish structure maps with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap C 1..1 StructureMap 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
... Slices for extension Content/Rules for all slices
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Additional identifier for the structure map
... name ΣC 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.
... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this structure map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... group Σ 1..* BackboneElement Named sections for reader convenience
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... 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
..... name Σ 1..1 id Name of the rule for internal references
..... source Σ 1..* BackboneElement Source inputs to the mapping
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... context Σ 1..1 id Type or variable this rule applies to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
StructureMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
StructureMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
StructureMap.group.typeModerequiredStructureMapGroupTypeMode
http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1
From the FHIR Standard
StructureMap.group.input.moderequiredStructureMapInputMode
http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorStructureMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorStructureMapIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorStructureMapIf 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-5errorStructureMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceStructureMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
smp-0warningStructureMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from StructureMap

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap 1..1 StructureMap A Map of relationships between 2 structures that can be used to transform data
... Slices for extension Content/Rules for all slices
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... identifier S 0..* Identifier Additional identifier for the structure map
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
... purpose S 0..1 markdown Why this structure map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap C 1..1 StructureMap 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... 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 SΣ 0..* Identifier Additional identifier for the structure map
... version Σ 0..1 string Business version of the structure map
... name ΣC 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the structure map
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this structure map is defined
... copyright S 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(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
.... 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
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
..... 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
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
..... 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 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
...... 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
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
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... 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
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
StructureMap.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
StructureMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
StructureMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
StructureMap.structure.moderequiredStructureMapModelMode
http://hl7.org/fhir/ValueSet/map-model-mode|4.0.1
From the FHIR Standard
StructureMap.group.typeModerequiredStructureMapGroupTypeMode
http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1
From the FHIR Standard
StructureMap.group.input.moderequiredStructureMapInputMode
http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.source.listModerequiredStructureMapSourceListMode
http://hl7.org/fhir/ValueSet/map-source-list-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.contextTyperequiredStructureMapContextType
http://hl7.org/fhir/ValueSet/map-context-type|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.listModerequiredStructureMapTargetListMode
http://hl7.org/fhir/ValueSet/map-target-list-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.transformrequiredStructureMapTransform
http://hl7.org/fhir/ValueSet/map-transform|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorStructureMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorStructureMapIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorStructureMapIf 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-5errorStructureMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceStructureMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
smp-0warningStructureMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
smp-1errorStructureMap.group.rule.targetCan only have an element if you have a context
: element.exists() implies context.exists()
smp-2errorStructureMap.group.rule.targetMust have a contextType if you have a context
: context.exists() implies contextType.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap C 1..1 StructureMap 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
... Slices for extension Content/Rules for all slices
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Additional identifier for the structure map
... name ΣC 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.
... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this structure map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... group Σ 1..* BackboneElement Named sections for reader convenience
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... 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
..... name Σ 1..1 id Name of the rule for internal references
..... source Σ 1..* BackboneElement Source inputs to the mapping
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... context Σ 1..1 id Type or variable this rule applies to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
StructureMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
StructureMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
StructureMap.group.typeModerequiredStructureMapGroupTypeMode
http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1
From the FHIR Standard
StructureMap.group.input.moderequiredStructureMapInputMode
http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorStructureMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorStructureMapIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorStructureMapIf 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-5errorStructureMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceStructureMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
smp-0warningStructureMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Differential View

This structure is derived from StructureMap

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap 1..1 StructureMap A Map of relationships between 2 structures that can be used to transform data
... Slices for extension Content/Rules for all slices
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... identifier S 0..* Identifier Additional identifier for the structure map
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
... purpose S 0..1 markdown Why this structure map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. StructureMap C 1..1 StructureMap 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... 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 SΣ 0..* Identifier Additional identifier for the structure map
... version Σ 0..1 string Business version of the structure map
... name ΣC 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the structure map
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this structure map is defined
... copyright S 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(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
.... 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
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
..... 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
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
..... 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 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
...... 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
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
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... 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
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
StructureMap.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
StructureMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
StructureMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
StructureMap.structure.moderequiredStructureMapModelMode
http://hl7.org/fhir/ValueSet/map-model-mode|4.0.1
From the FHIR Standard
StructureMap.group.typeModerequiredStructureMapGroupTypeMode
http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1
From the FHIR Standard
StructureMap.group.input.moderequiredStructureMapInputMode
http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.source.listModerequiredStructureMapSourceListMode
http://hl7.org/fhir/ValueSet/map-source-list-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.contextTyperequiredStructureMapContextType
http://hl7.org/fhir/ValueSet/map-context-type|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.listModerequiredStructureMapTargetListMode
http://hl7.org/fhir/ValueSet/map-target-list-mode|4.0.1
From the FHIR Standard
StructureMap.group.rule.target.transformrequiredStructureMapTransform
http://hl7.org/fhir/ValueSet/map-transform|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorStructureMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorStructureMapIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorStructureMapIf 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-5errorStructureMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceStructureMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
smp-0warningStructureMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
smp-1errorStructureMap.group.rule.targetCan only have an element if you have a context
: element.exists() implies context.exists()
smp-2errorStructureMap.group.rule.targetMust have a contextType if you have a context
: context.exists() implies contextType.exists()

 

Other representations of profile: CSV, Excel, Schematron