Generated Narrative: StructureDefinition profile-StructureMap Name Flags Card. Type Description & Constraints StructureMap 1..1 StructureMap A Map of relationships between 2 structures that can be used to transform data #xD; meta #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:meta 0..1 Meta R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.meta #xD; text #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:text 0..1 (Complex) R4B: text additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.text #xD; identifier #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:identifier 0..* Identifier R4B: identifier additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.identifier #xD; contact #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:contact 0..* (Complex) R4B: contact additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.contact #xD; useContext #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.useContext #xD; group #xD; rule #xD; source #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:defaultValue 0..1 uri, Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta R4B: defaultValue additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.group.rule.source.defaultValue #xD; extension:logMessage 0..1 string R4B: Message to put in log if source exists (FHIRPath) (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-StructureMap.group.rule.source.logMessage #xD; Documentation for this format
Cross-version Profile for R4B.StructureMap for use in FHIR STU3
This cross-version profile allows R4B StructureMap content to be represented via FHIR STU3 StructureMap resources.
A Map of relationships between 2 structures that can be used to transform data
A Map of relationships between 2 structures that can be used to transform data.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
R4B: `StructureMap.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)
Element `StructureMap.meta` is mapped to FHIR STU3 element `StructureMap.meta` as `SourceIsBroaderThanTarget`. The mappings for `StructureMap.meta` do not cover the following types: Meta. The mappings for `StructureMap.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.
The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
R4B: `StructureMap.text` additional types (Narrative) additional types from child elements (div, status)
Element `StructureMap.text` is mapped to FHIR STU3 element `StructureMap.text` as `SourceIsBroaderThanTarget`. The mappings for `StructureMap.text` do not cover the following types: Narrative. The mappings for `StructureMap.text` do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
generated | extensions | additional | empty
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
The actual narrative content, a stripped down version of XHTML.
The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.
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, elements (either name or href), images and internally contained style attributes
not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
The narrative SHALL have some non-whitespace content
descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Logical URI to reference this structure map (globally unique)
An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](http://hl7.org/fhir/STU3/resource.html#versions).
Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.
Allows the structure map to be referenced by a single globally unique identifier.
Additional identifier for the structure map
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this structure map outside of FHIR, where it is not possible to use the logical URI.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
R4B: `StructureMap.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)
Element `StructureMap.identifier` is mapped to FHIR STU3 element `StructureMap.identifier` as `SourceIsBroaderThanTarget`. The mappings for `StructureMap.identifier` do not cover the following types: Identifier. The mappings for `StructureMap.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.
usual | official | temp | secondary (If known)
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
There may be different structure map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the structure map with the format [url]|[version].
Name for this structure map (computer friendly)
A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.
Support human navigation and code generation.
Name for this structure map (human friendly)
A short, descriptive, user-friendly title for the structure map.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this structure map. Enables tracking the life-cycle of the content.
Allows filtering of structure maps that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired structure map without due consideration.
The lifecycle status of a Value Set or Concept Map.
A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Allows filtering of structure map that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental structure map in production.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.
The date (and optionally time) when the structure map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the individual or organization that published the structure map.
Usually an organization, but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure map. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the structure map. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
R4B: `StructureMap.contact` additional types (ContactDetail) additional types from child elements (name, telecom)
Element `StructureMap.contact` is mapped to FHIR STU3 element `StructureMap.contact` as `SourceIsBroaderThanTarget`. The mappings for `StructureMap.contact` do not cover the following types: ContactDetail. The mappings for `StructureMap.contact` do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.
If there is no named individual, the telecom information is for the organization as a whole.
Contact details for individual or organization
The contact details for the individual (if a name was provided) or the organization.
Natural language description of the structure map
A free text natural language description of the structure map from a consumer's perspective.
This description can be used to capture details such as why the structure map was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure map as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).
Context the content is intended to support
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure map instances.
When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
Assist in searching for appropriate content.
R4B: The context that the content is intended to support additional types
R4B: `StructureMap.useContext` additional types (UsageContext) additional types from child elements (code, value[x])
Element `StructureMap.useContext` is mapped to FHIR STU3 element `StructureMap.useContext` as `SourceIsBroaderThanTarget`. The mappings for `StructureMap.useContext` do not cover the following types: UsageContext. The mappings for `StructureMap.useContext` do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
A code that identifies the type of context being specified by this usage context.
A code that specifies a type of context being specified by a usage context
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
A code that defines the specific value for the context being specified
Intended jurisdiction for structure map (if applicable)
A legal or geographic region in which the structure map is intended to be used.
It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use
Explaination of why this structure map is needed and why it has been designed as it has.
This element does not describe the usage of the structure map Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure map.
A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.
A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
It is not necessary for a structure map to identify any dependent structures, though not losting them may restrict its usefulness.
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
The canonical URL that identifies the structure.
How the referenced structure is used in this mapping.
How the referenced structure is used in this mapping
This is needed if both types have the same name (e.g. version conversion).
Documentation that describes how the structure is used in the mapping.
Other maps used by this map (canonical URLs)
Other maps used by this map (canonical URLs).
Organizes the mapping into managable chunks for human review/ease of maintenance.
A unique name for the group for the convenience of human readers.
Another group that this group adds rules to
Another group that this group adds rules to.
If this is the default rule set to apply for thie source type, or this combination of types.
Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.
If this is the default rule set to apply for the source type, or this combination of types
Additional description/explaination for group
Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
Named instance provided when invoking the map
A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
If no inputs are named, then the entry mappings are type based.
Documentation for this instance of data.
Name of the rule for internal references
Name of the rule for internal references.
R4B: `StructureMap.group.rule.source.defaultValue[x]` additional types (uuid, Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta)
Element `StructureMap.group.rule.source.defaultValue[x]` is mapped to FHIR STU3 element `StructureMap.group.rule.source.defaultValue[x]` as `RelatedTo`. The mappings for `StructureMap.group.rule.source.defaultValue[x]` do not cover the following types: Address, Annotation, Attachment, ContactDetail, ContactPoint, Contributor, DataRequirement, Dosage, Expression, HumanName, Identifier, Meta, ParameterDefinition, Period, Range, Ratio, RelatedArtifact, SampledData, Signature, Timing, TriggerDefinition, UsageContext, uuid. The target context `StructureMap.group.rule.source.defaultValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `StructureMap.group.rule.source`. If there's a default value on an item that can repeat, it will only be used once.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R4B: Message to put in log if source exists (FHIRPath) (new)
R4B: `StructureMap.group.rule.source.logMessage` (new:string)
Element `StructureMap.group.rule.source.logMessage` has a context of StructureMap.group.rule.source based on following the parent source element upwards and mapping to `StructureMap`. Element `StructureMap.group.rule.source.logMessage` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This is typically used for recording that something Is not transformed to the target for some reason.
Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
Specified maximum cardinality (number or *)
Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).
Rule only applies if source has this type
Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
A value to use if there is no existing value in the source object.
If there's a default value on an item that can repeat, it will only be used once.
first | not_first | last | not_last | only_one
How to handle the list mode for this element.
If field is a list, how to manage the source
Named context for field, if a field is specified
Named context for field, if a field is specified.
FHIRPath expression - must be true or the rule does not apply
FHIRPath expression - must be true or the rule does not apply.
FHIRPath expression - must be true or the mapping engine throws an error instead of completing
FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
Content to create because of this mapping rule
Content to create because of this mapping rule.
Must have a contextType if you have a context
context.exists() implies contextType.exists()
Can only have a element if you have a context
element.exists() implies context.exists()
Named context for field, if desired, and a field is specified
Named context for field, if desired, and a field is specified.
If field is a list, how to manage the list.
If field is a list, how to manage the production
Internal rule reference for shared list items
Internal rule reference for shared list items.
Which other rules to apply in the context of this rule
Which other rules to apply in the context of this rule.