Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Terminology Infrastructure icon Work Group Maturity Level: 0Trial Use Use Context: Any

Definitions for the publishableconceptmap Profile.

ConceptMap
Element IdConceptMap
Definition

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

Short DisplayA map from one set of concepts to one or more other concepts
Cardinality1..1
Invariants
Inherited by this element
cnl-0WarningName should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ConceptMap.id
Element IdConceptMap.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short DisplayLogical id of this artifact
Cardinality0..1
Typeid
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

ConceptMap.meta
Element IdConceptMap.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short DisplayMetadata about the resource
Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.implicitRules
Element IdConceptMap.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short DisplayA set of rules under which this content was created
Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
Comments

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.language
Element IdConceptMap.language
Definition

The base language in which the resource is written.

Short DisplayLanguage of the resource content
Cardinality0..1
Terminology BindingIETF language tag for a human language
The codes SHALL be taken from All Languages
Typecode
Comments

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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.text
Element IdConceptMap.text
Definition

A human-readable narrative that contains a summary of the resource and can 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.

Short DisplayText summary of the resource, for human interpretation
Cardinality0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.contained
Element IdConceptMap.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Short DisplayContained, inline Resources
Cardinality0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

ConceptMap.extension
Element IdConceptMap.extension
Definition

An Extension

Short DisplayExtension
Cardinality0..*
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
ConceptMap.extension(knowledgeRepresentationLevel)
Element IdConceptMap.extension:knowledgeRepresentationLevel
Definition

Defines a knowledge representation level provided by this knowledge artifact.

Short Displaynarrative | semi-structured | structured | executable
Cardinality0..*
TypeExtension(KnowledgeRepresentationLevel)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.modifierExtension
Element IdConceptMap.modifierExtension
Definition

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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.url
Element IdConceptMap.url
Definition

An absolute URI that is used to identify this concept 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 an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.

Short DisplayCanonical identifier for this concept map, represented as a URI (globally unique)
Cardinality1..1
Typeuri
Must Supporttrue
Requirements

Allows the concept map to be referenced by a single globally unique identifier.

Comments

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.

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 element to indicate where the current master source of the resource can be found.

Invariants
Inherited by this element
cnl-1WarningURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.identifier
Element IdConceptMap.identifier
Definition

A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short DisplayAdditional identifier for the concept map
Cardinality0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.version
Element IdConceptMap.version
Definition

The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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.

Short DisplayBusiness version of the concept map
Cardinality1..1
Typestring
Must Supporttrue
Comments

There may be different concept 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 concept map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.versionAlgorithm[x]
Element IdConceptMap.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which ConceptMap is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology Bindingnull
The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable
TypeChoice of: string, Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Must Supporttrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.name
Element IdConceptMap.name
Definition

A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short DisplayName for this concept map (computer friendly)
Cardinality0..1 This element is affected by the following invariants: cnl-0
Typestring
Must Supporttrue
Requirements

Support human navigation and code generation.

Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.title
Element IdConceptMap.title
Definition

A short, descriptive, user-friendly title for the concept map.

Short DisplayName for this concept map (human friendly)
Cardinality1..1
Typestring
Must Supporttrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.status
Element IdConceptMap.status
Definition

The status of this concept map. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1 This element is affected by the following invariants: cmd-1
Terminology BindingThe lifecycle status of an artifact.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Must Supporttrue
Comments

Allows filtering of concept maps that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.experimental
Element IdConceptMap.experimental
Definition

A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality1..1
Typeboolean
Must Supporttrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.

Comments

Allows filtering of concept maps that are appropriate for use versus not.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.date
Element IdConceptMap.date
Definition

The date (and optionally time) when the concept map was last significantly changed. 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 concept map changes.

Short DisplayDate last changed
Cardinality1..1
TypedateTime
Must Supporttrue
Alternate NamesRevision Date
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.publisher
Element IdConceptMap.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the concept map.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Must Supporttrue
Requirements

Helps establish the "authority/credibility" of the concept map. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept 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 concept map. This item SHOULD be populated unless the information is available from context.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.contact
Element IdConceptMap.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Must Supporttrue
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.description
Element IdConceptMap.description
Definition

A free text natural language description of the concept map from a consumer's perspective.

Short DisplayNatural language description of the concept map
Cardinality1..1
Typemarkdown
Must Supporttrue
Comments

The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.useContext
Element IdConceptMap.useContext
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 concept map instances.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Must Supporttrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.jurisdiction
Element IdConceptMap.jurisdiction
Definition

A legal or geographic region in which the concept map is intended to be used.

Short DisplayIntended jurisdiction for concept map (if applicable)
Cardinality0..*
Terminology BindingCountries and regions within which this artifact is targeted for use.
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Comments

It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.purpose
Element IdConceptMap.purpose
Definition

Explanation of why this concept map is needed and why it has been designed as it has.

Short DisplayWhy this concept map is defined
Cardinality0..1
Typemarkdown
Must Supporttrue
Comments

This element does not describe the usage of the concept 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 concept map.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.copyright
Element IdConceptMap.copyright
Definition

A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Must Supporttrue
Requirements

Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.

Alternate NamesLicense, Restrictions
Comments

Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.copyrightLabel
Element IdConceptMap.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Must Supporttrue
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.approvalDate
Element IdConceptMap.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the ConceptMap was approved by publisher
Cardinality0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.lastReviewDate
Element IdConceptMap.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the ConceptMap was last reviewed by the publisher
Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.effectivePeriod
Element IdConceptMap.effectivePeriod
Definition

The period during which the ConceptMap content was or is planned to be in active use.

Short DisplayWhen the ConceptMap is expected to be used
Cardinality0..1
TypePeriod
Must Supporttrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ConceptMap are or are expected to be used instead.

Comments

The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.topic
Element IdConceptMap.topic
Definition

Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching.

Short DisplayE.g. Education, Treatment, Assessment, etc
Cardinality0..*
Terminology Bindingnull
For example codes, see Definition Topic
TypeCodeableConcept
Must Supporttrue
Requirements

Repositories must be able to determine how to categorize the ConceptMap so that it can be found by topical and keyword searches.

Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.author
Element IdConceptMap.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.

Short DisplayWho authored the ConceptMap
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.editor
Element IdConceptMap.editor
Definition

An individual or organization primarily responsible for internal coherence of the ConceptMap.

Short DisplayWho edited the ConceptMap
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.reviewer
Element IdConceptMap.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap.

Short DisplayWho reviewed the ConceptMap
Cardinality0..*
TypeContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.endorser
Element IdConceptMap.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting.

Short DisplayWho endorsed the ConceptMap
Cardinality0..*
TypeContactDetail
Comments

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.relatedArtifact
Element IdConceptMap.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Short DisplayAdditional documentation, citations, etc
Cardinality0..*
TypeRelatedArtifact
Requirements

A ConceptMap must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.property
Element IdConceptMap.property
Definition

A property defines a slot through which additional information can be provided about a map from source -> target.

Short DisplayAdditional properties of the mapping
Cardinality0..*
TypeBackboneElement
Comments

Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
cmd-11RuleIf the property type is code, a system SHALL be specifiedtype = 'code' implies system.exists()
ConceptMap.property.id
Element IdConceptMap.property.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.property.extension
Element IdConceptMap.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.property.modifierExtension
Element IdConceptMap.property.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.property.code
Element IdConceptMap.property.code
Definition

A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.

Short DisplayIdentifies the property on the mappings, and when referred to in the $translate operation
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.property.uri
Element IdConceptMap.property.uri
Definition

Reference to the formal meaning of the property.

Short DisplayFormal identifier for the property
Cardinality0..1
Typeuri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.property.description
Element IdConceptMap.property.description
Definition

A description of the property - why it is defined, and how its value might be used.

Short DisplayWhy the property is defined, and/or what it conveys
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.property.type
Element IdConceptMap.property.type
Definition

The type of the property value.

Short DisplayCoding | string | integer | boolean | dateTime | decimal | code
Cardinality1..1 This element is affected by the following invariants: cmd-11
Terminology BindingThe type of a property value.
The codes SHALL be taken from ConceptMap Property Type
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.property.system
Element IdConceptMap.property.system
Definition

The CodeSystem that defines the codes from which values of type code in property values.

Short DisplayThe CodeSystem from which code values come
Cardinality0..1 This element is affected by the following invariants: cmd-11
Typecanonical(CodeSystem)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.additionalAttribute
Element IdConceptMap.additionalAttribute
Definition

An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).

Short DisplayDefinition of an additional attribute to act as a data source or target
Cardinality0..*
TypeBackboneElement
Comments

Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.additionalAttribute.id
Element IdConceptMap.additionalAttribute.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.additionalAttribute.extension
Element IdConceptMap.additionalAttribute.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.additionalAttribute.modifierExtension
Element IdConceptMap.additionalAttribute.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.additionalAttribute.code
Element IdConceptMap.additionalAttribute.code
Definition

A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.

Short DisplayIdentifies this additional attribute through this resource
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.additionalAttribute.uri
Element IdConceptMap.additionalAttribute.uri
Definition

Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.

Short DisplayFormal identifier for the data element referred to in this attribte
Cardinality0..1
Typeuri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.additionalAttribute.description
Element IdConceptMap.additionalAttribute.description
Definition

A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.

Short DisplayWhy the additional attribute is defined, and/or what the data element it refers to is
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.additionalAttribute.type
Element IdConceptMap.additionalAttribute.type
Definition

The type of the source data contained in this concept map for this data element.

Short Displaycode | Coding | string | boolean | Quantity
Cardinality1..1
Terminology BindingThe type of a mapping attribute value.
The codes SHALL be taken from ConceptMap Attribute Type
Typecode
Comments

When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.sourceScope[x]
Element IdConceptMap.sourceScope[x]
Definition

Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.

Short DisplayThe source value set that contains the concepts that are being mapped
Cardinality0..1
TypeChoice of: uri, canonical(ValueSet)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Comments

Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.targetScope[x]
Element IdConceptMap.targetScope[x]
Definition

Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.

Short DisplayThe target value set which provides context for the mappings
Cardinality0..1
TypeChoice of: uri, canonical(ValueSet)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Comments

Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group
Element IdConceptMap.group
Definition

A group of mappings that all have the same source and target system.

Short DisplaySame source and target systems
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.id
Element IdConceptMap.group.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.extension
Element IdConceptMap.group.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.modifierExtension
Element IdConceptMap.group.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.source
Element IdConceptMap.group.source
Definition

An absolute URI that identifies the source system where the concepts to be mapped are defined.

Short DisplaySource system where concepts to be mapped are defined
Cardinality0..1
Typecanonical(CodeSystem)
Comments

This is not needed if the source value set is specified and it contains concepts from only a single system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.target
Element IdConceptMap.group.target
Definition

An absolute URI that identifies the target system that the concepts will be mapped to.

Short DisplayTarget system that the concepts are to be mapped to
Cardinality0..1
Typecanonical(CodeSystem)
Comments

This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element
Element IdConceptMap.group.element
Definition

Mappings for an individual concept in the source to one or more concepts in the target.

Short DisplayMappings for a concept from the source set
Cardinality1..*
TypeBackboneElement
Alternate Namescode, concept, item
Comments

Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
cmd-4RuleIf noMap is present, target SHALL NOT be present(noMap.exists() and noMap=true) implies target.empty()
cmd-5RuleEither code or valueSet SHALL be present but not both.(code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
ConceptMap.group.element.id
Element IdConceptMap.group.element.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.element.extension
Element IdConceptMap.group.element.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.modifierExtension
Element IdConceptMap.group.element.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.code
Element IdConceptMap.group.element.code
Definition

Identity (code or path) or the element/item being mapped.

Short DisplayIdentifies element being mapped
Cardinality0..1 This element is affected by the following invariants: cmd-5
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.display
Element IdConceptMap.group.element.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Short DisplayDisplay for the code
Cardinality0..1
Typestring
Comments

The display is ignored when processing the map.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.valueSet
Element IdConceptMap.group.element.valueSet
Definition

The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule.

Short DisplayIdentifies the set of concepts being mapped
Cardinality0..1 This element is affected by the following invariants: cmd-5
Typecanonical(ValueSet)
Comments

If the value set expansion is empty then there are no source concepts to map in this rule.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.noMap
Element IdConceptMap.group.element.noMap
Definition

If noMap = true this indicates that no mapping to a target concept exists for this source concept.

Short DisplayNo mapping to a target concept for this source concept
Cardinality0..1 This element is affected by the following invariants: cmd-4
Typeboolean
Comments

If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target
Element IdConceptMap.group.element.target
Definition

A concept from the target value set that this concept maps to.

Short DisplayConcept in target system for element
Cardinality0..* This element is affected by the following invariants: cmd-4
TypeBackboneElement
Comments

Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.

Invariants
Inherited by this element
cmd-1RuleIf the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft'comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to'))
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
cmd-7RuleEither code or valueSet SHALL be present but not both.(code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
ConceptMap.group.element.target.id
Element IdConceptMap.group.element.target.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.element.target.extension
Element IdConceptMap.group.element.target.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.modifierExtension
Element IdConceptMap.group.element.target.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.code
Element IdConceptMap.group.element.target.code
Definition

Identity (code or path) or the element/item that the map refers to.

Short DisplayCode that identifies the target element
Cardinality0..1 This element is affected by the following invariants: cmd-7
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.display
Element IdConceptMap.group.element.target.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Short DisplayDisplay for the code
Cardinality0..1
Typestring
Comments

The display is ignored when processing the map.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.valueSet
Element IdConceptMap.group.element.target.valueSet
Definition

The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.

Short DisplayIdentifies the set of target concepts
Cardinality0..1 This element is affected by the following invariants: cmd-7
Typecanonical(ValueSet)
Comments

If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.relationship
Element IdConceptMap.group.element.target.relationship
Definition

The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).

Short Displayrelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Cardinality1..1 This element is affected by the following invariants: cmd-1
Terminology BindingThe relationship between concepts.
The codes SHALL be taken from ConceptMapRelationship
Typecode
Is Modifiertrue (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between)
Comments

This element is labeled as a modifier because it may indicate that there is no mapping.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.comment
Element IdConceptMap.group.element.target.comment
Definition

A description of status/issues in mapping that conveys additional information not represented in the structured data.

Short DisplayDescription of status/issues in mapping
Cardinality0..1 This element is affected by the following invariants: cmd-1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.property
Element IdConceptMap.group.element.target.property
Definition

A property value for this source -> target mapping.

Short DisplayProperty value for the source -> target mapping
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.property.id
Element IdConceptMap.group.element.target.property.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.element.target.property.extension
Element IdConceptMap.group.element.target.property.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.property.modifierExtension
Element IdConceptMap.group.element.target.property.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.property.code
Element IdConceptMap.group.element.target.property.code
Definition

A reference to a mapping property defined in ConceptMap.property.

Short DisplayReference to ConceptMap.property.code
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.property.value[x]
Element IdConceptMap.group.element.target.property.value[x]
Definition

The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

Short DisplayValue of the property for this concept
Cardinality1..1
TypeChoice of: Coding, string, integer, boolean, dateTime, decimal, code
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn
Element IdConceptMap.group.element.target.dependsOn
Definition

A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.

Short DisplayOther properties required for this mapping
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
cmd-6RuleOne of value[x] or valueSet must exist, but not both.(value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())
ConceptMap.group.element.target.dependsOn.id
Element IdConceptMap.group.element.target.dependsOn.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.element.target.dependsOn.extension
Element IdConceptMap.group.element.target.dependsOn.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.dependsOn.modifierExtension
Element IdConceptMap.group.element.target.dependsOn.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.element.target.dependsOn.attribute
Element IdConceptMap.group.element.target.dependsOn.attribute
Definition

A reference to the additional attribute that holds a value the map depends on.

Short DisplayA reference to a mapping attribute defined in ConceptMap.additionalAttribute
Cardinality1..1
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.value[x]
Element IdConceptMap.group.element.target.dependsOn.value[x]
Definition

Data element value that the map depends on / produces.

Short DisplayValue of the referenced data element
Cardinality0..1 This element is affected by the following invariants: cmd-6
TypeChoice of: code, Coding, string, boolean, Quantity
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Comments

If the data type is a code, then the code system is .group.source for .dependsOn.valueCode and .group.target for .product.valueCode.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.valueSet
Element IdConceptMap.group.element.target.dependsOn.valueSet
Definition

This mapping applies if the data element value is a code from this value set.

Short DisplayThe mapping depends on a data element with a value from this value set
Cardinality0..1 This element is affected by the following invariants: cmd-6
Typecanonical(ValueSet)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.element.target.product
Element IdConceptMap.group.element.target.product
Definition

Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.

Short DisplayOther data elements that this mapping also produces
Cardinality0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped
Element IdConceptMap.group.unmapped
Definition

What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.

Short DisplayWhat to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
Cardinality0..1
TypeBackboneElement
Comments

The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
cmd-2RuleIf the mode is 'fixed', either a code or valueSet must be provided, but not both.(mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
cmd-3RuleIf the mode is 'other-map', a url for the other map must be provided(mode = 'other-map') implies otherMap.exists()
cmd-8RuleIf the mode is not 'fixed', code, display and valueSet are not allowed(mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())
cmd-9RuleIf the mode is not 'other-map', relationship must be provided(mode != 'other-map') implies relationship.exists()
cmd-10RuleIf the mode is not 'other-map', otherMap is not allowed(mode != 'other-map') implies otherMap.empty()
ConceptMap.group.unmapped.id
Element IdConceptMap.group.unmapped.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
ConceptMap.group.unmapped.extension
Element IdConceptMap.group.unmapped.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.unmapped.modifierExtension
Element IdConceptMap.group.unmapped.modifierExtension
Definition

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
ConceptMap.group.unmapped.mode
Element IdConceptMap.group.unmapped.mode
Definition

Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

Short Displayuse-source-code | fixed | other-map
Cardinality1..1 This element is affected by the following invariants: cmd-3, cmd-2, cmd-8, cmd-9, cmd-10
Terminology BindingDefines which action to take if there is no match in the group.
The codes SHALL be taken from Concept Map Group Unmapped Mode
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.code
Element IdConceptMap.group.unmapped.code
Definition

The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

Short DisplayFixed code when mode = fixed
Cardinality0..1 This element is affected by the following invariants: cmd-2, cmd-8
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.display
Element IdConceptMap.group.unmapped.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Short DisplayDisplay for the code
Cardinality0..1 This element is affected by the following invariants: cmd-8
Typestring
Comments

The display is ignored when processing the map.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.valueSet
Element IdConceptMap.group.unmapped.valueSet
Definition

The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.

Short DisplayFixed code set when mode = fixed
Cardinality0..1 This element is affected by the following invariants: cmd-2, cmd-8
Typecanonical(ValueSet)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.relationship
Element IdConceptMap.group.unmapped.relationship
Definition

The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'.

Short Displayrelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Cardinality0..1 This element is affected by the following invariants: cmd-9
Terminology BindingThe default relationship value to apply between the source and target concepts when no concept mapping is specified.
The codes SHALL be taken from ConceptMapRelationship
Typecode
Is Modifiertrue (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between)
Comments

This element is labeled as a modifier because it may indicate that there is no mapping.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.otherMap
Element IdConceptMap.group.unmapped.otherMap
Definition

The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.

Short Displaycanonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
Cardinality0..1 This element is affected by the following invariants: cmd-3, cmd-10
Typecanonical(ConceptMap)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())