Profile_R5_ConceptMap_R4B - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4B v0.1.0

Is Modifier false

Must Support false

Summary true

4. ConceptMap.meta

Definition

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

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. ConceptMap.implicitRules

Definition

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

Short A set of rules under which this content was created

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.

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. ConceptMap.language

Definition

The base language in which the resource is written.

Short Language of the resource content

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

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

IETF language tag

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. ConceptMap.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

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.

Control 0..1

Narrative

Is Modifier false

Must Support false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. ConceptMap.contained

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.

Short Contained, inline 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.

Control 0..*

Resource

Is Modifier false

Must Support false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

Invariants dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))

14. ConceptMap.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Must Support false

Summary false

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

This element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. ConceptMap.extension:versionAlgorithm

Slice Name versionAlgorithm

Definition

R5: ConceptMap.versionAlgorithm[x] (new:Coding, string)

Short R5: How to compare versions (new)

Comments

Element ConceptMap.versionAlgorithm[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.versionAlgorithm[x] has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control 0..1

Type Extension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)

Is Modifier false

Must Support false

Summary false

18. ConceptMap.extension:copyrightLabel

Slice Name copyrightLabel

Definition

R5: ConceptMap.copyrightLabel (new:string)

Short R5: Copyright holder and year(s) (new)

Comments

Element ConceptMap.copyrightLabel has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.copyrightLabel has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.copyrightLabel: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control 0..1

Type Extension(Artifact Copyright Label) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

20. ConceptMap.extension:approvalDate

Slice Name approvalDate

Definition

R5: ConceptMap.approvalDate (new:date)

Short R5: When the ConceptMap was approved by publisher (new)

Comments

Element ConceptMap.approvalDate has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.approvalDate has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.approvalDate: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

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

Control 0..1

Type Extension(Artifact Approval Date) (Extension Type: date)

Is Modifier false

Must Support false

Summary false

22. ConceptMap.extension:lastReviewDate

Slice Name lastReviewDate

Definition

R5: ConceptMap.lastReviewDate (new:date)

Short R5: When the ConceptMap was last reviewed by the publisher (new)

Comments

Element ConceptMap.lastReviewDate has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.lastReviewDate has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.lastReviewDate: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate. If specified, this date follows the original approval date.

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

Control 0..1

Type Extension(Artifact Last Review Date) (Extension Type: date)

Is Modifier false

Must Support false

Summary false

24. ConceptMap.extension:effectivePeriod

Slice Name effectivePeriod

Definition

R5: ConceptMap.effectivePeriod (new:Period)

Short R5: When the ConceptMap is expected to be used (new)

Comments

Element ConceptMap.effectivePeriod has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.effectivePeriod has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.effectivePeriod: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod. The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.

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

Control 0..1

Type Extension(Artifact Effective Period) (Extension Type: Period)

Is Modifier false

Must Support false

Summary false

26. ConceptMap.extension:topic

Slice Name topic

Definition

R5: ConceptMap.topic (new:CodeableConcept)

Short R5: E.g. Education, Treatment, Assessment, etc (new)

Comments

Element ConceptMap.topic has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.topic has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.topic: http://hl7.org/fhir/StructureDefinition/artifact-topic. Element ConceptMap.topic has been flagged as deprecated. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

Control 0..*

Type Extension(Artifact Topic) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

28. ConceptMap.extension:author

Slice Name author

Definition

R5: ConceptMap.author (new:ContactDetail)

Short R5: Who authored the ConceptMap (new)

Comments

Element ConceptMap.author has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.author has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.author: http://hl7.org/fhir/StructureDefinition/artifact-author.

Control 0..*

Type Extension(Artifact Author) (Extension Type: ContactDetail)

Is Modifier false

Must Support false

Summary false

30. ConceptMap.extension:editor

Slice Name editor

Definition

R5: ConceptMap.editor (new:ContactDetail)

Short R5: Who edited the ConceptMap (new)

Comments

Element ConceptMap.editor has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.editor has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.editor: http://hl7.org/fhir/StructureDefinition/artifact-editor.

Control 0..*

Type Extension(Artifact Editor) (Extension Type: ContactDetail)

Is Modifier false

Must Support false

Summary false

32. ConceptMap.extension:reviewer

Slice Name reviewer

Definition

R5: ConceptMap.reviewer (new:ContactDetail)

Short R5: Who reviewed the ConceptMap (new)

Comments

Element ConceptMap.reviewer has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.reviewer has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.reviewer: http://hl7.org/fhir/StructureDefinition/artifact-reviewer. See guidance around (not) making local changes to elements here.

Control 0..*

Type Extension(Artifact Reviewer) (Extension Type: ContactDetail)

Is Modifier false

Must Support false

Summary false

34. ConceptMap.extension:endorser

Slice Name endorser

Definition

R5: ConceptMap.endorser (new:ContactDetail)

Short R5: Who endorsed the ConceptMap (new)

Comments

Element ConceptMap.endorser has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.endorser has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.endorser: http://hl7.org/fhir/StructureDefinition/artifact-endorser. See guidance around (not) making local changes to elements here.

Control 0..*

Type Extension(Artifact Endorser) (Extension Type: ContactDetail)

Is Modifier false

Must Support false

Summary false

36. ConceptMap.extension:relatedArtifact

Slice Name relatedArtifact

Definition

R5: ConceptMap.relatedArtifact (new:RelatedArtifact)

Short R5: Additional documentation, citations, etc (new)

Comments

Element ConceptMap.relatedArtifact has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.relatedArtifact has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element ConceptMap.relatedArtifact: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact. Each related artifact is either an attachment, or a reference to another resource, but not both.

Control 0..*

Type Extension(Artifact related artifact) (Extension Type: RelatedArtifact)

Is Modifier false

Must Support false

Summary false

38. ConceptMap.extension:property

Slice Name property

Definition

R5: ConceptMap.property (new:BackboneElement)

Short R5: Additional properties of the mapping (new)

Comments

Element ConceptMap.property has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.property has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Additional properties of the mapping (new)) (Complex Extension)

Is Modifier false

Must Support false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

40. ConceptMap.extension:additionalAttribute

Slice Name additionalAttribute

Definition

R5: ConceptMap.additionalAttribute (new:BackboneElement)

Short R5: Definition of an additional attribute to act as a data source or target (new)

Comments

Element ConceptMap.additionalAttribute has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.additionalAttribute has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Definition of an additional attribute to act as a data source or target (new)) (Complex Extension)

Is Modifier false

Must Support false

42. ConceptMap.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

Short Extensions that cannot be ignored

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.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Must Support false

Summary false

Requirements

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

Alternate Names extensions, user content

44. ConceptMap.url

Definition

An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.

Short Canonical identifier for this concept map, represented as a URI (globally unique)

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. ConceptMap.identifier

Definition

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

Short Additional identifier for the concept map

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.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Identifier

Is Modifier false

Must Support false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. ConceptMap.version

Definition

The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short Business version of the concept map

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

Note This is a business version Id, not a resource version Id (see discussion)

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. ConceptMap.name

Definition

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

Short Name for this concept map (computer friendly)

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Requirements

Support human navigation and code generation.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. ConceptMap.title

Definition

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

Short Name for this concept map (human friendly)

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. ConceptMap.status

Definition

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

Short draft | active | retired | unknown

Comments

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

Control 1..1

The codes SHALL be taken from PublicationStatus
(required to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Is Modifier true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. ConceptMap.experimental

Definition

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

Short For testing purposes, not real usage

Comments

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

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. ConceptMap.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.

Short Date last changed

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.

Control 0..1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Alternate Names Revision Date

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. ConceptMap.publisher

Definition

The name of the organization or individual that published the concept map.

Short Name of the publisher (organization or individual)

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. ConceptMap.contact

Definition

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

Short Contact details for the publisher

Comments

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

Control 0..*

ContactDetail

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. ConceptMap.description

Definition

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

Short Natural language description of the concept map

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.

Control 0..1

markdown

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. ConceptMap.useContext

Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.

Short The context that the content is intended to support

Comments

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

Control 0..*

UsageContext

Is Modifier false

Must Support false

Summary true

Requirements

Assist in searching for appropriate content.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. ConceptMap.jurisdiction

Definition

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

Short Intended jurisdiction for concept map (if applicable)

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.

Control 0..*

Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.3.0)

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

CodeableConcept

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. ConceptMap.purpose

Definition

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

Short Why this concept map is defined

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.

Control 0..1

markdown

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. ConceptMap.copyright

Definition

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

Short Use and/or publishing restrictions

Comments

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

Control 0..1

markdown

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Requirements

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

Alternate Names License, Restrictions

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. ConceptMap.source[x]

Definition

Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.

Short The source value set that contains the concepts that are being mapped

Comments

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

Control 0..1

Type Choice of: uri, canonical(ValueSet)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

76. ConceptMap.target[x]

Definition

The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

Short The target value set which provides context for the mappings

Comments

Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.

Control 0..1

Type Choice of: uri, canonical(ValueSet)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. ConceptMap.group

Definition

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

Short Same source and target systems

Control 0..*

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

80. ConceptMap.group.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

82. ConceptMap.group.extension

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

84. ConceptMap.group.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

86. ConceptMap.group.source

Definition

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

Short Source system where 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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. ConceptMap.group.sourceVersion

Definition

The specific version of the code system, as determined by the code system authority.

Short Specific version of the code system

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. ConceptMap.group.target

Definition

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

Short Target system that the concepts are to 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'.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

92. ConceptMap.group.targetVersion

Definition

The specific version of the code system, as determined by the code system authority.

Short Specific version of the code system

Comments

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

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

94. ConceptMap.group.element

Definition

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

Short Mappings for a concept from the source set

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.

Control 1..*

Is Modifier false

Must Support false

Summary false

Alternate Names code, concept, item

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

96. ConceptMap.group.element.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

98. ConceptMap.group.element.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.element.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

100. ConceptMap.group.element.extension:valueSet

Slice Name valueSet

Definition

R5: ConceptMap.group.element.valueSet (new:canonical(ValueSet))

Short R5: Identifies the set of concepts being mapped (new)

Comments

Element ConceptMap.group.element.valueSet has a context of ConceptMap.group.element based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.element.valueSet has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If the value set expansion is empty then there are no source concepts to map in this rule.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Identifies the set of concepts being mapped (new)) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

102. ConceptMap.group.element.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

104. ConceptMap.group.element.code

Definition

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

Short Identifies element being mapped

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

106. ConceptMap.group.element.display

Definition

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

Short Display for the code

Comments

The display is ignored when processing the map.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

108. ConceptMap.group.element.target

Definition

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

Short Concept in target system for element

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.

Control 0..*

Is Modifier false

Must Support false

Summary false

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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

110. ConceptMap.group.element.target.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

112. ConceptMap.group.element.target.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.element.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

114. ConceptMap.group.element.target.extension:valueSet

Slice Name valueSet

Definition

R5: ConceptMap.group.element.target.valueSet (new:canonical(ValueSet))

Short R5: Identifies the set of target concepts (new)

Comments

Element ConceptMap.group.element.target.valueSet has a context of ConceptMap.group.element.target based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.element.target.valueSet has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Identifies the set of target concepts (new)) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

116. ConceptMap.group.element.target.extension:property

Slice Name property

Definition

R5: ConceptMap.group.element.target.property (new:BackboneElement)

Short R5: Property value for the source -> target mapping (new)

Comments

Element ConceptMap.group.element.target.property has a context of ConceptMap.group.element.target based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.element.target.property has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Property value for the source -> target mapping (new)) (Complex Extension)

Is Modifier false

118. ConceptMap.group.element.target.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

120. ConceptMap.group.element.target.code

Definition

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

Short Code that identifies the target element

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

122. ConceptMap.group.element.target.display

Definition

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

Short Display for the code

Comments

The display is ignored when processing the map.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. ConceptMap.group.element.target.equivalence

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.

Control 1..1

The codes SHALL be taken from ConceptMapEquivalence
(required to http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.3.0)

The degree of equivalence between concepts.

Is Modifier true because Some of the values mean that there is no mapping from the source to the target, particularly 'disjoint', and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

126. ConceptMap.group.element.target.equivalence.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

128. ConceptMap.group.element.target.equivalence.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.element.target.equivalence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

130. ConceptMap.group.element.target.equivalence.extension:noMap

Slice Name noMap

Definition

R5: ConceptMap.group.element.noMap additional types (boolean) additional types from child elements (value)

Short R5: No mapping to a target concept for this source concept additional types

Comments

Element ConceptMap.group.element.noMap is mapped to FHIR R4B element ConceptMap.group.element.target.equivalence as SourceIsBroaderThanTarget. The mappings for ConceptMap.group.element.noMap do not cover the following types: boolean. The mappings for ConceptMap.group.element.noMap do not cover the following types based on type expansion: value. If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: No mapping to a target concept for this source concept additional types) (Extension Type: boolean)

Is Modifier false

Summary false

132. ConceptMap.group.element.target.equivalence.value

Definition

Primitive value for code

Short Primitive value for code

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

134. ConceptMap.group.element.target.comment

Definition

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

Short Description of status/issues in mapping

Control 0..1
This element is affected by the following invariants: cmd-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. ConceptMap.group.element.target.dependsOn

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.

Short Other elements required for this mapping (from context)

Control 0..*

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

138. ConceptMap.group.element.target.dependsOn.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

140. ConceptMap.group.element.target.dependsOn.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

142. ConceptMap.group.element.target.dependsOn.extension:value

Slice Name value

Definition

R5: ConceptMap.group.element.target.dependsOn.value[x] additional types (Coding, boolean, Quantity)

Short R5: Value of the referenced data element additional types

Comments

Element ConceptMap.group.element.target.dependsOn.value[x] is mapped to FHIR R4B element ConceptMap.group.element.target.dependsOn.value as SourceIsBroaderThanTarget. The mappings for ConceptMap.group.element.target.dependsOn.value[x] do not cover the following types: boolean, Coding, Quantity. If the data type is a code, then the code system is .group.source for .dependsOn.valueCode and .group.target for .product.valueCode.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Value of the referenced data element additional types) (Extension Type: Choice of: Coding, boolean, Quantity)

Is Modifier false

Summary false

144. ConceptMap.group.element.target.dependsOn.extension:valueSet

Slice Name valueSet

Definition

R5: ConceptMap.group.element.target.dependsOn.valueSet (new:canonical(ValueSet))

Short R5: The mapping depends on a data element with a value from this value set (new)

Comments

Element ConceptMap.group.element.target.dependsOn.valueSet has a context of ConceptMap.group.element.target.dependsOn based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.element.target.dependsOn.valueSet has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: The mapping depends on a data element with a value from this value set (new)) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

146. ConceptMap.group.element.target.dependsOn.modifierExtension

Definition

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

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

148. ConceptMap.group.element.target.dependsOn.property

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.

Short Reference to property mapping depends on

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

150. ConceptMap.group.element.target.dependsOn.property.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

152. ConceptMap.group.element.target.dependsOn.property.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.element.target.dependsOn.property.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

154. ConceptMap.group.element.target.dependsOn.property.extension:attribute

Slice Name attribute

Definition

R5: ConceptMap.group.element.target.dependsOn.attribute additional types (code) additional types from child elements (value)

Short R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types

Comments

Element ConceptMap.group.element.target.dependsOn.attribute is mapped to FHIR R4B element ConceptMap.group.element.target.dependsOn.property as SourceIsBroaderThanTarget. The mappings for ConceptMap.group.element.target.dependsOn.attribute do not cover the following types: code. The mappings for ConceptMap.group.element.target.dependsOn.attribute do not cover the following types based on type expansion: value.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types) (Extension Type: code)

Is Modifier false

Summary false

156. ConceptMap.group.element.target.dependsOn.property.value

Definition

The actual value

Short Primitive value for uri

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

158. ConceptMap.group.element.target.dependsOn.system

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

Short Code System (if necessary)

Control 0..1

Type canonical(CodeSystem)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Meaning if Missing The code is in the source (dependsOn) or target (product) system

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

160. ConceptMap.group.element.target.dependsOn.value

Definition

Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.

Short Value of the referenced element

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

162. ConceptMap.group.element.target.dependsOn.display

Definition

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

Short Display for the code (if value is a code)

Comments

The display is ignored when processing the map.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

164. ConceptMap.group.element.target.product

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.

Short Other concepts that this mapping also produces

Control 0..*

Type Seettp://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. ConceptMap.group.unmapped

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.

Short What to do when there is no mapping for the source concept

Comments

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

Control 0..1

Is Modifier false

Must Support false

Summary false

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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

168. ConceptMap.group.unmapped.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

170. ConceptMap.group.unmapped.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on ConceptMap.group.unmapped.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

172. ConceptMap.group.unmapped.extension:valueSet

Slice Name valueSet

Definition

R5: ConceptMap.group.unmapped.valueSet (new:canonical(ValueSet))

Short R5: Fixed code set when mode = fixed (new)

Comments

Element ConceptMap.group.unmapped.valueSet has a context of ConceptMap.group.unmapped based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.unmapped.valueSet has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Fixed code set when mode = fixed (new)) (Extension Type: canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B, ValueSet))

Is Modifier false

Summary false

174. ConceptMap.group.unmapped.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

This element introduces a set of slices on ConceptMap.group.unmapped.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

176. ConceptMap.group.unmapped.modifierExtension:relationship

Slice Name relationship

Definition

R5: ConceptMap.group.unmapped.relationship (new:code)

Short R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)

Comments

Element ConceptMap.group.unmapped.relationship has a context of ConceptMap.group.unmapped based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.group.unmapped.relationship has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This element is labeled as a modifier because it may indicate that there is no mapping.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)) (Extension Type: code)

Is Modifier true because The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between

Summary true

178. ConceptMap.group.unmapped.mode

Definition

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

Short provided | fixed | other-map

Control 1..1

The codes SHALL be taken from ConceptMapGroupUnmappedMode
(required to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.3.0)

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

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

180. ConceptMap.group.unmapped.code

Definition

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

Short Fixed code when mode = fixed

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

182. ConceptMap.group.unmapped.display

Definition

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

Short Display for the code

Comments

The display is ignored when processing the map.

Control 0..1