Page Status: updated 2023-04-19

ConceptMap

Page index

Introduction
Overview
Details
Supported operations

Introduction

The ConceptMap resource, shown in the profile NLLConceptMap, defines how a code, or set of codes, relates to another code, or set of codes. Some code systems include codes that are equivalent, or related to codes in another code system. The intention of a concept map is to show these relations.

The concept maps exposed in the National Medication List is primarily intended for client systems to facilitate user interfaces and help the user to select a relevant code, e.g. given which medical product has been selected, or to translate between code systems e.g. EDQM and Snomed CT.

Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources

Overview

NLLConceptMap (ConceptMap)	I		ConceptMap	There are no (further) constraints on this element Element id ConceptMap Short description A map from one set of concepts to one or more other concepts 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. Data type ConceptMap Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim: Entity. Role, or Act rim: N/A
id	S Σ	0..1	string	Element id ConceptMap.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string Mappings EHM: Kodrelations-id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id ConceptMap.meta Short description Metadata about the resource 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id ConceptMap.implicitRules Short description A set of rules under which this content was created 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. 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 it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id ConceptMap.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id ConceptMap.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id ConceptMap.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
url	S Σ	0..1	uri	There are no (further) constraints on this element Element id ConceptMap.url Short description Canonical identifier for this concept map, represented as a URI (globally unique) 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 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.url w5: FiveWs.identifier
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id ConceptMap.identifier Short description Additional identifier for the concept map 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. 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. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier workflow: Definition.identifier w5: FiveWs.identifier objimpl: no-gen-base
version	S Σ	0..1	string	Element id ConceptMap.version Short description Business version of the concept map 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. 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]. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.version w5: FiveWs.version EHM: Version
name	S Σ I	0..1	string	Element id ConceptMap.name Short description Name for this concept map (computer friendly) 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Tekniskt namn
title	S Σ	0..1	string	Element id ConceptMap.title Short description Name for this concept map (human friendly) Definition A short, descriptive, user-friendly title for the concept map. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.title EHM: Namn
status	S Σ ?!	1..1	codeBinding	Element id ConceptMap.status Short description draft \| active \| retired \| unknown Definition The status of this concept map. Enables tracking the life-cycle of the content. Comments Allows filtering of concept maps that are appropriate for use versus not. Data type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.status w5: FiveWs.status EHM: Status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element id ConceptMap.experimental Short description For testing purposes, not real usage 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. 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.experimental w5: FiveWs.class
date	S Σ	0..1	dateTime	Element id ConceptMap.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the concept 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 concept map changes. Comments 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.date w5: FiveWs.recorded EHM: Revisionsdatum
publisher	S Σ	0..1	string	Element id ConceptMap.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the concept map. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.publisher w5: FiveWs.witness EHM: Utgivare
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element id ConceptMap.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.contact
description	S	0..1	markdown	Element id ConceptMap.description Short description Natural language description of the concept map Definition A free text natural language description of the concept map from a consumer's perspective. 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. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.description rim: N/A EHM: Beskrivning
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element id ConceptMap.useContext Short description The context that the content is intended to support 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. 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. Data type UsageContext Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id ConceptMap.jurisdiction Short description Intended jurisdiction for concept map (if applicable) Definition A legal or geographic region in which the concept map is intended to be used. 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. Data type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD workflow: Definition.jurisdiction
purpose		0..1	markdown	There are no (further) constraints on this element Element id ConceptMap.purpose Short description Why this concept map is defined Definition Explanation of why this concept map is needed and why it has been designed as it has. 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. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.purpose w5: FiveWs.why[x] objimpl: no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element id ConceptMap.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions 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. Requirements Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content. Comments Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Definition.copyright objimpl: no-gen-base
source[x]	S Σ	0..1		Element id ConceptMap.source[x] Short description The source code system Definition Identifier for the source code system that contains the concepts that are being mapped and provides context for the mappings. Comments Mappings are done between code systems not between value sets as stated in the FHIR specification. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Källvärdemängd
sourceCanonical			canonical(ValueSet)	Data type canonical(ValueSet)
target[x]	S Σ	0..1		Element id ConceptMap.target[x] Short description The target code system Definition The target code system which provides context for the mappings Comments Mappings are done between code systems not between value sets as stated in the FHIR specification. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Målvärdemängd
targetCanonical			canonical(ValueSet)	Data type canonical(ValueSet)
group	S	0..*	BackboneElement	Element id ConceptMap.group Short description Same source and target systems Definition A group of mappings that all have the same source and target system. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Kodrelationsgrupper
id		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.extension Short description Additional content defined by implementations Alternate names extensions, user content 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 manageable, 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 manageable, 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
source	S	0..1	uri	Element id ConceptMap.group.source Short description Source system where concepts to be mapped are defined Definition An absolute URI that identifies the source system where the concepts to be mapped are defined. Comments This is not needed if the source value set is specified and it contains concepts from only a single system. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Källkodsystem
sourceVersion	S	0..1	string	Element id ConceptMap.group.sourceVersion Short description Specific version of the code system Definition The specific version of the code system, as determined by the code system authority. Comments The specification of a particular code system version may be required for code systems which lack concept permanence. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Källkodsystem version
target	S	0..1	uri	Element id ConceptMap.group.target Short description Target system that the concepts are to be mapped to Definition An absolute URI that identifies the target system that the concepts will be mapped to. 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 equivalence values are 'unmatched'. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Målkodsystem
targetVersion	S	0..1	string	Element id ConceptMap.group.targetVersion Short description Specific version of the code system Definition The specific version of the code system, as determined by the code system authority. Comments The specification of a particular code system version may be required for code systems which lack concept permanence. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Målkodsystem version
element	S	1..*	BackboneElement	Element id ConceptMap.group.element Short description Mappings for a concept from the source set Alternate names code, concept, item Definition Mappings for an individual concept in the source to one or more concepts in the target. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Relaterade källkoder
id		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.extension Short description Additional content defined by implementations Alternate names extensions, user content 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 manageable, 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 manageable, 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
code	S	0..1	code	Element id ConceptMap.group.element.code Short description Identifies element being mapped Definition Identity (code or path) or the element/item being mapped. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Kod i källvärdemängd
display		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.display Short description Display for the code Definition The display for the code. The display is only provided to help editors when editing the concept map. Comments The display is ignored when processing the map. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
target	S I	0..*	BackboneElement	Element id ConceptMap.group.element.target Short description Concept in target system for element Definition A concept from the target value set that this concept maps to. Comments Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cmd-1: If the map is narrower or inexact, there SHALL be some comments `comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))` Mappings rim: n/a EHM: Relaterade målkoder
id		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.target.extension Short description Additional content defined by implementations Alternate names extensions, user content 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 manageable, 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.target.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 manageable, 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
code	S	0..1	code	Element id ConceptMap.group.element.target.code Short description Code that identifies the target element Definition Identity (code or path) or the element/item that the map refers to. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Kod i målvärdemängd
display		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.display Short description Display for the code Definition The display for the code. The display is only provided to help editors when editing the concept map. Comments The display is ignored when processing the map. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
equivalence	S ?!	1..1	codeBinding	Element id ConceptMap.group.element.target.equivalence Short description relatedto \| equivalent Definition The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source). Comments This element is labeled as a modifier because it may indicate that a target does not apply. Data type code Binding The degree of equivalence between concepts. nll-concept-map-equivalence (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EHM: Typ av kodrelation
comment	I	0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.comment Short description Description of status/issues in mapping Definition A description of status/issues in mapping that conveys additional information not represented in the structured data. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
dependsOn		0..*	BackboneElement	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn Short description Other elements required for this mapping (from context) Definition A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.extension Short description Additional content defined by implementations Alternate names extensions, user content 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 manageable, 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 manageable, 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
property		1..1	uri	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.property Short description Reference to property mapping depends on Definition A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
system		0..1	canonical(CodeSystem)	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.system Short description Code System (if necessary) Definition An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). Comments see Canonical References Meaning when missing The code is in the source (dependsOn) or target (product) system Data type canonical(CodeSystem) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
value		1..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.value Short description Value of the referenced element Definition Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
display		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.element.target.dependsOn.display Short description Display for the code (if value is a code) Definition The display for the code. The display is only provided to help editors when editing the concept map. Comments The display is ignored when processing the map. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
product		0..*	see (dependsOn)	There are no (further) constraints on this element Element id ConceptMap.group.element.target.product Short description Other concepts that this mapping also produces Definition A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.
unmapped	I	0..1	BackboneElement	There are no (further) constraints on this element Element id ConceptMap.group.unmapped Short description What to do when there is no mapping for the source concept Definition What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched. Comments This only applies if the source code has a system value that matches the system defined for the group. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cmd-3: If the mode is 'other-map', a url must be provided `(mode = 'other-map') implies url.exists()` cmd-2: If the mode is 'fixed', a code must be provided `(mode = 'fixed') implies code.exists()` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.extension Short description Additional content defined by implementations Alternate names extensions, user content 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 manageable, 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. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 manageable, 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). 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. 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
mode		1..1	codeBinding	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.mode Short description provided \| fixed \| other-map 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 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). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding Defines which action to take if there is no match in the group. ConceptMapGroupUnmappedMode (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
code		0..1	code	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.code Short description Fixed code when mode = fixed Definition The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
display		0..1	string	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.display Short description Display for the code Definition The display for the code. The display is only provided to help editors when editing the concept map. Comments The display is ignored when processing the map. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
url		0..1	canonical(ConceptMap)	There are no (further) constraints on this element Element id ConceptMap.group.unmapped.url Short description canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped 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. Comments see Canonical References Data type canonical(ConceptMap) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.

Supported operations

HTTP methods

Operation	Supported	Comment
Search (GET, POST)	yes	See below for supported search options.
Insert (POST)	no
Update (PUT)	no
Delete (DEL)	no
Operation (GET, POST)	yes	See below for supported extended operations.

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported Queries

The following query alternatives are available for this resource.

GET ../ConceptMap
GET ../ConceptMap/[id]

Compartment searches

Compartments are not supported by this resource.

Include & reverse includes

Include and revinclude are not supported by this resource.

For generic information about how to search in FHIR look here.

Search parameters

The table below shows all supported search parameters.

Parameter	Description	Comment
ConceptMap	A search without parameters returnes all concept maps `../ConceptMap`
ConceptMap/[id]	A read based on the logical ID of a concept map `../ConceptMap/nll-form-to-ucum-unit`

Other operations

$translate

Invocations

GET ../ConceptMap/$translate?system=[system]&code=[code]&source=[source]&target=[target]
GET ../ConceptMap/[id]/$translate?system=[system]&code=[code]

This operation does NOT change content.
This operation translates a code from one value set to another.
This is a standard operation in FHIR, see $translate for more information.

Parameters (In)

Parameter	Description	Comment
system	The system of the code that is to be translated `..?system=http://electronichealth.se/fhir/CodeSystem/mpa-form`
code	The code that is to be translated `..&code=PSOIIN`
source	The value set the code comes from `..&source=http://electronichealth.se/fhir/ValueSet/nll-mpa-form`
target	The value set in which a translation is sought `..&target=http://electronichealth.se/fhir/ValueSet/nll-ucum-unit`

Parameters (Out)

Parameter	Description	Comment
result	True if the concept could be translated successfully `true`
match	A concept in the target value set with an equivalence
match.equivalence	A code indicating the equivalence of the translation `equivalent`
match.concept	The translation outcome as a Coding, eg `"system": "http://snomed.info/sct", "code": "258994006"`