Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
A Map of relationships between 2 structures that can be used to transform data.
StructureMap
Path
StructureMap
Id
StructureMap
Cardinality
0 - *
Definition
A Map of relationships between 2 structures that can be used to transform data.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
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
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
smp-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
Path
StructureMap.url
Id
StructureMap.url
Type
Cardinality
1 - 1
Definition
An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.
Comment
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.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the structure map to be referenced by a single globally unique identifier.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier
Id
StructureMap.identifier
Type
Cardinality
0 - *
Definition
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.
Comment
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.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
StructureMap.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
StructureMap.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-1
Path
StructureMap.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
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.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
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](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.version
Id
StructureMap.version
Type
Cardinality
0 - 1
Definition
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.
Comment
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 reference to a particular business version of the structure map with the format [url]|[version].
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.name
Id
StructureMap.name
Type
Cardinality
1 - 1
Definition
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.
Comment
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Requirements
Support human navigation and code generation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.title
Id
StructureMap.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the structure map.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.status
Id
StructureMap.status
Type
Cardinality
1 - 1
Definition
The status of this structure map. Enables tracking the life-cycle of the content.
Comment
Allows filtering of structure maps that are appropriate for use versus not.
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.experimental
Id
StructureMap.experimental
Type
Cardinality
0 - 1
Definition
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.
Comment
Allows filtering of structure maps that are appropriate for use versus not.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.date
Id
StructureMap.date
Type
Cardinality
0 - 1
Definition
The date (and optionally time) when the structure map was published. The date must change 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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.publisher
Id
StructureMap.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual that published the structure map.
Comment
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.
Requirements
Helps establish the "authority/credibility" of the structure map. May also allow for contact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact
Id
StructureMap.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
StructureMap.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
StructureMap.description
Id
StructureMap.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the structure map from a consumer's perspective.
Comment
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 structure map is presumed to be the predominant language in the place the structure map was created).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext
Id
StructureMap.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.
Comment
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction
Id
StructureMap.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the structure map is intended to be used.
Comment
It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.purpose
Id
StructureMap.purpose
Type
Cardinality
0 - 1
Definition
Explanation of why this structure map is needed and why it has been designed as it has.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.copyright
Id
StructureMap.copyright
Type
Cardinality
0 - 1
Definition
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.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.structure
Id
StructureMap.structure
Type
Cardinality
0 - *
Definition
A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
Comment
It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.structure.url
Id
StructureMap.structure.url
Type
Cardinality
1 - 1
Definition
The canonical reference to the structure.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.structure.mode
Id
StructureMap.structure.mode
Type
Cardinality
1 - 1
Definition
How the referenced structure is used in this mapping.
Comment
Binding
Strength
required
Description
How the referenced structure is used in this mapping.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.structure.alias
Id
StructureMap.structure.alias
Type
Cardinality
0 - 1
Definition
The name used for this type in the map.
Comment
This is needed if both types have the same name (e.g. version conversion).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.structure.documentation
Id
StructureMap.structure.documentation
Type
Cardinality
0 - 1
Definition
Documentation that describes how the structure is used in the mapping.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.import
Id
StructureMap.import
Type
Cardinality
0 - *
Definition
Other maps used by this map (canonical URLs).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group
Id
StructureMap.group
Type
Cardinality
1 - *
Definition
Organizes the mapping into manageable chunks for human review/ease of maintenance.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.name
Id
StructureMap.group.name
Type
Cardinality
1 - 1
Definition
A unique name for the group for the convenience of human readers.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.extends
Id
StructureMap.group.extends
Type
Cardinality
0 - 1
Definition
Another group that this group adds rules to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.typeMode
Id
StructureMap.group.typeMode
Type
Cardinality
1 - 1
Definition
If this is the default rule set to apply for the source type or this combination of types.
Comment
Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.
Binding
Strength
required
Description
If this is the default rule set to apply for the source type, or this combination of types.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.documentation
Id
StructureMap.group.documentation
Type
Cardinality
0 - 1
Definition
Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.input
Id
StructureMap.group.input
Type
Cardinality
1 - *
Definition
A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
Comment
If no inputs are named, then the entry mappings are type based.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.input.name
Id
StructureMap.group.input.name
Type
Cardinality
1 - 1
Definition
Name for this instance of data.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.input.type
Id
StructureMap.group.input.type
Type
Cardinality
0 - 1
Definition
Type for this instance of data.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.input.mode
Id
StructureMap.group.input.mode
Type
Cardinality
1 - 1
Definition
Mode for this instance of data.
Comment
Binding
Strength
required
Description
Mode for this instance of data.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.input.documentation
Id
StructureMap.group.input.documentation
Type
Cardinality
0 - 1
Definition
Documentation for this instance of data.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule
Id
StructureMap.group.rule
Type
Cardinality
1 - *
Definition
Transform Rule from source to target.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.rule.name
Id
StructureMap.group.rule.name
Type
Cardinality
1 - 1
Definition
Name of the rule for internal references.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source
Id
StructureMap.group.rule.source
Type
Cardinality
1 - *
Definition
Source inputs to the mapping.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.rule.source.context
Id
StructureMap.group.rule.source.context
Type
Cardinality
1 - 1
Definition
Type or variable this rule applies to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.min
Id
StructureMap.group.rule.source.min
Type
Cardinality
0 - 1
Definition
Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.max
Id
StructureMap.group.rule.source.max
Type
Cardinality
0 - 1
Definition
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).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.type
Id
StructureMap.group.rule.source.type
Type
Cardinality
0 - 1
Definition
Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.defaultValue[x]
Id
StructureMap.group.rule.source.defaultValue[x]
Type
Cardinality
0 - 1
Definition
A value to use if there is no existing value in the source object.
Comment
If there's a default value on an item that can repeat, it will only be used once.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.element
Id
StructureMap.group.rule.source.element
Type
Cardinality
0 - 1
Definition
Optional field for this source.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.listMode
Id
StructureMap.group.rule.source.listMode
Type
Cardinality
0 - 1
Definition
How to handle the list mode for this element.
Comment
Binding
Strength
required
Description
If field is a list, how to manage the source.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.variable
Id
StructureMap.group.rule.source.variable
Type
Cardinality
0 - 1
Definition
Named context for field, if a field is specified.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.condition
Id
StructureMap.group.rule.source.condition
Type
Cardinality
0 - 1
Definition
FHIRPath expression - must be true or the rule does not apply.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
check
FHIRPath expression - must be true or the mapping engine throws an error instead of completing
Path
StructureMap.group.rule.source.check
Id
StructureMap.group.rule.source.check
Type
Cardinality
0 - 1
Definition
FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.source.logMessage
Id
StructureMap.group.rule.source.logMessage
Type
Cardinality
0 - 1
Definition
A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.
Comment
This is typically used for recording that something Is not transformed to the target for some reason.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target
Id
StructureMap.group.rule.target
Type
Cardinality
0 - *
Definition
Content to create because of this mapping rule.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
smp-1 [error]
Can only have an element if you have a context
smp-2 [error]
Must have a contextType if you have a context
Path
StructureMap.group.rule.target.context
Id
StructureMap.group.rule.target.context
Type
Cardinality
0 - 1
Definition
Type or variable this rule applies to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.contextType
Id
StructureMap.group.rule.target.contextType
Type
Cardinality
0 - 1
Definition
How to interpret the context.
Comment
Binding
Strength
required
Description
How to interpret the context.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.element
Id
StructureMap.group.rule.target.element
Type
Cardinality
0 - 1
Definition
Field to create in the context.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.variable
Id
StructureMap.group.rule.target.variable
Type
Cardinality
0 - 1
Definition
Named context for field, if desired, and a field is specified.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.listMode
Id
StructureMap.group.rule.target.listMode
Type
Cardinality
0 - *
Definition
If field is a list, how to manage the list.
Comment
Binding
Strength
required
Description
If field is a list, how to manage the production.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.listRuleId
Id
StructureMap.group.rule.target.listRuleId
Type
Cardinality
0 - 1
Definition
Internal rule reference for shared list items.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.transform
Id
StructureMap.group.rule.target.transform
Type
Cardinality
0 - 1
Definition
How the data is copied / created.
Comment
Binding
Strength
required
Description
How data is copied/created.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.target.parameter
Id
StructureMap.group.rule.target.parameter
Type
Cardinality
0 - *
Definition
Parameters to the transform.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.rule.target.parameter.value[x]
Id
StructureMap.group.rule.target.parameter.value[x]
Type
Cardinality
1 - 1
Definition
Parameter value - variable or literal.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.rule
Id
StructureMap.group.rule.rule
Type
Cardinality
0 - *
Definition
Rules contained in this rule.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.dependent
Id
StructureMap.group.rule.dependent
Type
Cardinality
0 - *
Definition
Which other rules to apply in the context of this rule.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
StructureMap.group.rule.dependent.name
Id
StructureMap.group.rule.dependent.name
Type
Cardinality
1 - 1
Definition
Name of a rule or group to apply.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.dependent.variable
Id
StructureMap.group.rule.dependent.variable
Type
Cardinality
1 - *
Definition
Variable to pass to the rule or group.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
StructureMap.group.rule.documentation
Id
StructureMap.group.rule.documentation
Type
Cardinality
0 - 1
Definition
Documentation for this instance of data.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children