Page Status: updated 2023-04-19

ConceptMap

Page index

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

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlS Σ0..1uri
identifierΣ0..1Identifier
versionS Σ0..1string
nameS Σ I0..1string
titleS Σ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateS Σ0..1dateTime
publisherS Σ0..1string
contactΣ0..*ContactDetail
descriptionS0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
sourceCanonicalcanonical(ValueSet)
targetCanonicalcanonical(ValueSet)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
sourceS0..1uri
sourceVersionS0..1string
targetS0..1uri
targetVersionS0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS0..1code
display0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS0..1code
display0..1string
equivalenceS ?!1..1codeBinding
commentI0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
property1..1uri
system0..1canonical(CodeSystem)
value1..1string
display0..1string
product0..*see (dependsOn)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
mode1..1codeBinding
code0..1code
display0..1string
url0..1canonical(ConceptMap)
ConceptMap
DefinitionA 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.
Cardinality0...*
Invariants
  • 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}')
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
ConceptMap.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Mappings
  • EHM: Kodrelations-id
ConceptMap.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
ConceptMap.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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.

Mappings
  • rim: N/A
ConceptMap.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
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.

Invariants
  • 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
ConceptMap.url
DefinitionAn 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.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.url
  • w5: FiveWs.identifier
ConceptMap.identifier
DefinitionA 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.
Cardinality0...1
TypeIdentifier
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.identifier
  • w5: FiveWs.identifier
  • objimpl: no-gen-base
ConceptMap.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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].

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.version
  • w5: FiveWs.version
  • EHM: Version
ConceptMap.name
DefinitionA 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Tekniskt namn
ConceptMap.title
DefinitionA short, descriptive, user-friendly title for the concept map.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.title
  • EHM: Namn
ConceptMap.status
DefinitionThe status of this concept map. Enables tracking the life-cycle of the content.
Cardinality1...1
Typecode
Binding

The lifecycle status of an artifact.

PublicationStatus (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.status
  • w5: FiveWs.status
  • EHM: Status
ConceptMap.experimental
DefinitionA 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.
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.experimental
  • w5: FiveWs.class
ConceptMap.date
DefinitionThe 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.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
AliasRevision Date
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.date
  • w5: FiveWs.recorded
  • EHM: Revisionsdatum
ConceptMap.publisher
DefinitionThe name of the organization or individual that published the concept map.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.publisher
  • w5: FiveWs.witness
  • EHM: Utgivare
ConceptMap.contact
DefinitionContact details to assist a user in finding and communicating with the publisher.
Cardinality0...*
TypeContactDetail
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.contact
ConceptMap.description
DefinitionA free text natural language description of the concept map from a consumer's perspective.
Cardinality0...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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.description
  • rim: N/A
  • EHM: Beskrivning
ConceptMap.useContext
DefinitionThe 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.
Cardinality0...*
TypeUsageContext
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.useContext
ConceptMap.jurisdiction
DefinitionA legal or geographic region in which the concept map is intended to be used.
Cardinality0...*
TypeCodeableConcept
Binding

Countries and regions within which this artifact is targeted for use.

Jurisdiction ValueSet (extensible)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.jurisdiction
ConceptMap.purpose
DefinitionExplanation of why this concept map is needed and why it has been designed as it has.
Cardinality0...1
Typemarkdown
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.purpose
  • w5: FiveWs.why[x]
  • objimpl: no-gen-base
ConceptMap.copyright
DefinitionA 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.
Cardinality0...1
Typemarkdown
AliasLicense, Restrictions
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Definition.copyright
  • objimpl: no-gen-base
ConceptMap.source[x]
DefinitionIdentifier for the source code system that contains the concepts that are being mapped and provides context for the mappings.
Cardinality0...1
Typecanonical(ValueSet)
Must SupportTrue
SummaryTrue
Comments

Mappings are done between code systems not between value sets as stated in the FHIR specification.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Källvärdemängd
ConceptMap.target[x]
DefinitionThe target code system which provides context for the mappings
Cardinality0...1
Typecanonical(ValueSet)
Must SupportTrue
SummaryTrue
Comments

Mappings are done between code systems not between value sets as stated in the FHIR specification.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Målvärdemängd
ConceptMap.group
DefinitionA group of mappings that all have the same source and target system.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Kodrelationsgrupper
ConceptMap.group.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ConceptMap.group.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.group.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • 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
ConceptMap.group.source
DefinitionAn absolute URI that identifies the source system where the concepts to be mapped are defined.
Cardinality0...1
Typeuri
Must SupportTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Källkodsystem
ConceptMap.group.sourceVersion
DefinitionThe specific version of the code system, as determined by the code system authority.
Cardinality0...1
Typestring
Must SupportTrue
Comments

The specification of a particular code system version may be required for code systems which lack concept permanence.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Källkodsystem version
ConceptMap.group.target
DefinitionAn absolute URI that identifies the target system that the concepts will be mapped to.
Cardinality0...1
Typeuri
Must SupportTrue
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'.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Målkodsystem
ConceptMap.group.targetVersion
DefinitionThe specific version of the code system, as determined by the code system authority.
Cardinality0...1
Typestring
Must SupportTrue
Comments

The specification of a particular code system version may be required for code systems which lack concept permanence.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Målkodsystem version
ConceptMap.group.element
DefinitionMappings for an individual concept in the source to one or more concepts in the target.
Cardinality1...*
TypeBackboneElement
Must SupportTrue
Aliascode, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Relaterade källkoder
ConceptMap.group.element.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ConceptMap.group.element.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.group.element.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • 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
ConceptMap.group.element.code
DefinitionIdentity (code or path) or the element/item being mapped.
Cardinality0...1
Typecode
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Kod i källvärdemängd
ConceptMap.group.element.display
DefinitionThe display for the code. The display is only provided to help editors when editing the concept map.
Cardinality0...1
Typestring
Comments

The display is ignored when processing the map.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target
DefinitionA concept from the target value set that this concept maps to.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
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.

Invariants
  • 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'))
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Relaterade målkoder
ConceptMap.group.element.target.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ConceptMap.group.element.target.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.group.element.target.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • 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
ConceptMap.group.element.target.code
DefinitionIdentity (code or path) or the element/item that the map refers to.
Cardinality0...1
Typecode
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Kod i målvärdemängd
ConceptMap.group.element.target.display
DefinitionThe display for the code. The display is only provided to help editors when editing the concept map.
Cardinality0...1
Typestring
Comments

The display is ignored when processing the map.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.equivalence
DefinitionThe 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).
Cardinality1...1
Typecode
Binding

The degree of equivalence between concepts.

nll-concept-map-equivalence (required)
Must SupportTrue
ModifierTrue
Comments

This element is labeled as a modifier because it may indicate that a target does not apply.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Typ av kodrelation
ConceptMap.group.element.target.comment
DefinitionA description of status/issues in mapping that conveys additional information not represented in the structured data.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn
DefinitionA 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.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ConceptMap.group.element.target.dependsOn.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.group.element.target.dependsOn.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • 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
ConceptMap.group.element.target.dependsOn.property
DefinitionA 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.
Cardinality1...1
Typeuri
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.system
DefinitionAn absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
Cardinality0...1
Typecanonical(CodeSystem)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.value
DefinitionIdentity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.dependsOn.display
DefinitionThe display for the code. The display is only provided to help editors when editing the concept map.
Cardinality0...1
Typestring
Comments

The display is ignored when processing the map.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.element.target.product
DefinitionA 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.
Cardinality0...*
Typesee (dependsOn)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.unmapped
DefinitionWhat 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.
Cardinality0...1
TypeBackboneElement
Comments

This only applies if the source code has a system value that matches the system defined for the group.

Invariants
  • cmd-2: If the mode is 'fixed', a code must be provided
    (mode = 'fixed') implies code.exists()
  • cmd-3: If the mode is 'other-map', a url must be provided
    (mode = 'other-map') implies url.exists()
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ConceptMap.group.unmapped.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • 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
ConceptMap.group.unmapped.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

Invariants
  • 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
ConceptMap.group.unmapped.mode
DefinitionDefines 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).
Cardinality1...1
Typecode
Binding

Defines which action to take if there is no match in the group.

ConceptMapGroupUnmappedMode (required)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.code
DefinitionThe fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
Cardinality0...1
Typecode
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.display
DefinitionThe display for the code. The display is only provided to help editors when editing the concept map.
Cardinality0...1
Typestring
Comments

The display is ignored when processing the map.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ConceptMap.group.unmapped.url
DefinitionThe canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
Cardinality0...1
Typecanonical(ConceptMap)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://electronichealth.se/fhir/StructureDefinition/NLLConceptMap" />
    <version value="1.0.0" />
    <name value="NLLConceptMap" />
    <status value="active" />
    <date value="2022-02-10" />
    <publisher value="Swedish eHealth Agency" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="EHM" />
        <name value="E-h&#228;lsomyndigheten concept" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="ConceptMap" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ConceptMap" />
    <derivation value="constraint" />
    <differential>
        <element id="ConceptMap.id">
            <path value="ConceptMap.id" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kodrelations-id" />
            </mapping>
        </element>
        <element id="ConceptMap.url">
            <path value="ConceptMap.url" />
            <mustSupport value="true" />
        </element>
        <element id="ConceptMap.version">
            <path value="ConceptMap.version" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Version" />
            </mapping>
        </element>
        <element id="ConceptMap.name">
            <path value="ConceptMap.name" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Tekniskt namn" />
            </mapping>
        </element>
        <element id="ConceptMap.title">
            <path value="ConceptMap.title" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Namn" />
            </mapping>
        </element>
        <element id="ConceptMap.status">
            <path value="ConceptMap.status" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Status" />
            </mapping>
        </element>
        <element id="ConceptMap.date">
            <path value="ConceptMap.date" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Revisionsdatum" />
            </mapping>
        </element>
        <element id="ConceptMap.publisher">
            <path value="ConceptMap.publisher" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Utgivare" />
            </mapping>
        </element>
        <element id="ConceptMap.description">
            <path value="ConceptMap.description" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Beskrivning" />
            </mapping>
        </element>
        <element id="ConceptMap.source[x]">
            <path value="ConceptMap.source[x]" />
            <short value="The source code system" />
            <definition value="Identifier for the source code system that contains the concepts that are being mapped and provides context for the mappings." />
            <comment value="Mappings are done between code systems not between value sets as stated in the FHIR specification." />
            <type>
                <code value="canonical" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="K&#228;llv&#228;rdem&#228;ngd" />
            </mapping>
        </element>
        <element id="ConceptMap.target[x]">
            <path value="ConceptMap.target[x]" />
            <short value="The target code system" />
            <definition value="The target code system which provides context for the mappings" />
            <comment value="Mappings are done between code systems not between value sets as stated in the FHIR specification." />
            <type>
                <code value="canonical" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="M&#229;lv&#228;rdem&#228;ngd" />
            </mapping>
        </element>
        <element id="ConceptMap.group">
            <path value="ConceptMap.group" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kodrelationsgrupper" />
            </mapping>
        </element>
        <element id="ConceptMap.group.source">
            <path value="ConceptMap.group.source" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="K&#228;llkodsystem" />
            </mapping>
        </element>
        <element id="ConceptMap.group.sourceVersion">
            <path value="ConceptMap.group.sourceVersion" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="K&#228;llkodsystem version" />
            </mapping>
        </element>
        <element id="ConceptMap.group.target">
            <path value="ConceptMap.group.target" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="M&#229;lkodsystem" />
            </mapping>
        </element>
        <element id="ConceptMap.group.targetVersion">
            <path value="ConceptMap.group.targetVersion" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="M&#229;lkodsystem version" />
            </mapping>
        </element>
        <element id="ConceptMap.group.element">
            <path value="ConceptMap.group.element" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Relaterade k&#228;llkoder" />
            </mapping>
        </element>
        <element id="ConceptMap.group.element.code">
            <path value="ConceptMap.group.element.code" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kod i k&#228;llv&#228;rdem&#228;ngd" />
            </mapping>
        </element>
        <element id="ConceptMap.group.element.target">
            <path value="ConceptMap.group.element.target" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Relaterade m&#229;lkoder" />
            </mapping>
        </element>
        <element id="ConceptMap.group.element.target.code">
            <path value="ConceptMap.group.element.target.code" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Kod i m&#229;lv&#228;rdem&#228;ngd" />
            </mapping>
        </element>
        <element id="ConceptMap.group.element.target.equivalence">
            <path value="ConceptMap.group.element.target.equivalence" />
            <short value="relatedto | equivalent" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/ValueSet/nll-concept-map-equivalence" />
            </binding>
            <mapping>
                <identity value="EHM" />
                <map value="Typ av kodrelation" />
            </mapping>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://electronichealth.se/fhir/StructureDefinition/NLLConceptMap",
    "version": "1.0.0",
    "name": "NLLConceptMap",
    "status": "active",
    "date": "2022-02-10",
    "publisher": "Swedish eHealth Agency",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "EHM",
            "name": "E-hälsomyndigheten concept"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "ConceptMap",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ConceptMap",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ConceptMap.id",
                "path": "ConceptMap.id",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kodrelations-id"
                    }
                ]
            },
            {
                "id": "ConceptMap.url",
                "path": "ConceptMap.url",
                "mustSupport": true
            },
            {
                "id": "ConceptMap.version",
                "path": "ConceptMap.version",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Version"
                    }
                ]
            },
            {
                "id": "ConceptMap.name",
                "path": "ConceptMap.name",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Tekniskt namn"
                    }
                ]
            },
            {
                "id": "ConceptMap.title",
                "path": "ConceptMap.title",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Namn"
                    }
                ]
            },
            {
                "id": "ConceptMap.status",
                "path": "ConceptMap.status",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Status"
                    }
                ]
            },
            {
                "id": "ConceptMap.date",
                "path": "ConceptMap.date",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Revisionsdatum"
                    }
                ]
            },
            {
                "id": "ConceptMap.publisher",
                "path": "ConceptMap.publisher",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Utgivare"
                    }
                ]
            },
            {
                "id": "ConceptMap.description",
                "path": "ConceptMap.description",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Beskrivning"
                    }
                ]
            },
            {
                "id": "ConceptMap.source[x]",
                "path": "ConceptMap.source[x]",
                "short": "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.",
                "comment": "Mappings are done between code systems not between value sets as stated in the FHIR specification.",
                "type":  [
                    {
                        "code": "canonical"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Källvärdemängd"
                    }
                ]
            },
            {
                "id": "ConceptMap.target[x]",
                "path": "ConceptMap.target[x]",
                "short": "The target code system",
                "definition": "The target code system which provides context for the mappings",
                "comment": "Mappings are done between code systems not between value sets as stated in the FHIR specification.",
                "type":  [
                    {
                        "code": "canonical"
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Målvärdemängd"
                    }
                ]
            },
            {
                "id": "ConceptMap.group",
                "path": "ConceptMap.group",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kodrelationsgrupper"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.source",
                "path": "ConceptMap.group.source",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Källkodsystem"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.sourceVersion",
                "path": "ConceptMap.group.sourceVersion",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Källkodsystem version"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.target",
                "path": "ConceptMap.group.target",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Målkodsystem"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.targetVersion",
                "path": "ConceptMap.group.targetVersion",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Målkodsystem version"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.element",
                "path": "ConceptMap.group.element",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Relaterade källkoder"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.element.code",
                "path": "ConceptMap.group.element.code",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kod i källvärdemängd"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.element.target",
                "path": "ConceptMap.group.element.target",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Relaterade målkoder"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.element.target.code",
                "path": "ConceptMap.group.element.target.code",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Kod i målvärdemängd"
                    }
                ]
            },
            {
                "id": "ConceptMap.group.element.target.equivalence",
                "path": "ConceptMap.group.element.target.equivalence",
                "short": "relatedto | equivalent",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/ValueSet/nll-concept-map-equivalence"
                },
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Typ av kodrelation"
                    }
                ]
            }
        ]
    }
}
ConceptMap..
ConceptMap.id..
ConceptMap.url..
ConceptMap.version..
ConceptMap.name..
ConceptMap.title..
ConceptMap.status..
ConceptMap.date..
ConceptMap.publisher..
ConceptMap.description..
ConceptMap.source[x]canonical()..
ConceptMap.target[x]canonical()..
ConceptMap.group..
ConceptMap.group.source..
ConceptMap.group.sourceVersion..
ConceptMap.group.target..
ConceptMap.group.targetVersion..
ConceptMap.group.element..
ConceptMap.group.element.code..
ConceptMap.group.element.target..
ConceptMap.group.element.target.code..
ConceptMap.group.element.target.equivalence..

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.

  1. GET ../ConceptMap
  2. 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"