OCL Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: OCL ConceptMap Profile

A profile for ConceptMap resources as defined by Open Concept Lab terminology services.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
ConceptMap	C	0..*	ConceptMap	A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url	SΣ	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Additional identifier for the concept map ele-1: All FHIR elements must have a @value or children
version	SΣ	1..1	string	Business version of the concept map ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name for this concept map (computer friendly) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Name for this concept map (human friendly) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required) ele-1: All FHIR elements must have a @value or children
publisher	SΣ	0..1	string	Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children
source[x]	SΣ	1..1		The source system or value set (uri or Reference) ele-1: All FHIR elements must have a @value or children
sourceUri			uri
sourceCanonical			canonical(ValueSet)
target[x]	SΣ	1..1		The target system or value set (uri or Reference) ele-1: All FHIR elements must have a @value or children
targetUri			uri
targetCanonical			canonical(ValueSet)
group	S	0..*	BackboneElement	Same source and target systems ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
source	S	1..1	uri	URI of source system ele-1: All FHIR elements must have a @value or children
target	S	1..1	uri	URI of target system ele-1: All FHIR elements must have a @value or children
element	S	1..*	BackboneElement	Mappings for a concept from the source set ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Identifies element being mapped ele-1: All FHIR elements must have a @value or children
target	SC	1..*	BackboneElement	Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Code that identifies the target element ele-1: All FHIR elements must have a @value or children
equivalence	?!S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence

Constraints

Id	Grade	Path(s)	Details	Requirements
cmd-0	warning	ConceptMap	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1	error	ConceptMap.group.element.target	If the map is narrower or inexact, there SHALL be some comments : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2	error	ConceptMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ConceptMap	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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ConceptMap	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	error	ConceptMap	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ConceptMap	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from ConceptMap

Name	Flags	Card.	Type	Description & Constraints
ConceptMap		0..*	ConceptMap	A map from one set of concepts to one or more other concepts
url	S	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique)
identifier	S	1..1	Identifier	Additional identifier for the concept map
version	S	1..1	string	Business version of the concept map
name	S	1..1	string	Name for this concept map (computer friendly)
title	S	1..1	string	Name for this concept map (human friendly)
status	S	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
publisher	S	0..1	string	Name of the publisher (organization or individual)
source[x]	S	1..1	uri, canonical(ValueSet)	The source system or value set (uri or Reference)
target[x]	S	1..1	uri, canonical(ValueSet)	The target system or value set (uri or Reference)
group	S	0..*	BackboneElement	Same source and target systems
source	S	1..1	uri	URI of source system
target	S	1..1	uri	URI of target system
element	S	1..*	BackboneElement	Mappings for a concept from the source set
code	S	1..1	code	Identifies element being mapped
target	S	1..*	BackboneElement	Concept in target system for element
code	S	1..1	code	Code that identifies the target element
equivalence	S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence

Name	Flags	Card.	Type	Description & Constraints
ConceptMap	C	0..*	ConceptMap	A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique)
identifier	SΣ	1..1	Identifier	Additional identifier for the concept map
version	SΣ	1..1	string	Business version of the concept map
name	SΣ	1..1	string	Name for this concept map (computer friendly)
title	SΣ	1..1	string	Name for this concept map (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the concept map
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this concept map is defined
copyright		0..1	markdown	Use and/or publishing restrictions
source[x]	SΣ	1..1		The source system or value set (uri or Reference)
sourceUri			uri
sourceCanonical			canonical(ValueSet)
target[x]	SΣ	1..1		The target system or value set (uri or Reference)
targetUri			uri
targetCanonical			canonical(ValueSet)
group	S	0..*	BackboneElement	Same source and target systems
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source	S	1..1	uri	URI of source system
sourceVersion		0..1	string	Specific version of the code system
target	S	1..1	uri	URI of target system
targetVersion		0..1	string	Specific version of the code system
element	S	1..*	BackboneElement	Mappings for a concept from the source set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Identifies element being mapped
display		0..1	string	Display for the code
target	SC	1..*	BackboneElement	Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code that identifies the target element
display		0..1	string	Display for the code
equivalence	?!S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required)
comment	C	0..1	string	Description of status/issues in mapping
dependsOn		0..*	BackboneElement	Other elements required for this mapping (from context)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
property		1..1	uri	Reference to property mapping depends on
system		0..1	canonical(CodeSystem)	Code System (if necessary)
value		1..1	string	Value of the referenced element
display		0..1	string	Display for the code (if value is a code)
product		0..*	See dependsOn (ConceptMap)	Other concepts that this mapping also produces
unmapped	C	0..1	BackboneElement	What to do when there is no mapping for the source concept cmd-2: If the mode is 'fixed', a code must be provided cmd-3: If the mode is 'other-map', a url must be provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	code	provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
code		0..1	code	Fixed code when mode = fixed
display		0..1	string	Display for the code
url		0..1	canonical(ConceptMap)	canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ConceptMap.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence
ConceptMap.group.unmapped.mode	required	ConceptMapGroupUnmappedMode http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.3.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmd-0	warning	ConceptMap	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1	error	ConceptMap.group.element.target	If the map is narrower or inexact, there SHALL be some comments : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2	error	ConceptMap.group.unmapped	If the mode is 'fixed', a code must be provided : (mode = 'fixed') implies code.exists()
cmd-3	error	ConceptMap.group.unmapped	If the mode is 'other-map', a url must be provided : (mode = 'other-map') implies url.exists()
dom-2	error	ConceptMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ConceptMap	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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ConceptMap	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	error	ConceptMap	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ConceptMap	A resource should have narrative for robust management : text.`div`.exists()
dom-r4b	warning	ConceptMap.contained	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Mandatory: 7 elements(5 nested mandatory elements)
Must-Support: 17 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ConceptMap	C	0..*	ConceptMap	A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url	SΣ	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Additional identifier for the concept map ele-1: All FHIR elements must have a @value or children
version	SΣ	1..1	string	Business version of the concept map ele-1: All FHIR elements must have a @value or children
name	SΣ	1..1	string	Name for this concept map (computer friendly) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Name for this concept map (human friendly) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required) ele-1: All FHIR elements must have a @value or children
publisher	SΣ	0..1	string	Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children
source[x]	SΣ	1..1		The source system or value set (uri or Reference) ele-1: All FHIR elements must have a @value or children
sourceUri			uri
sourceCanonical			canonical(ValueSet)
target[x]	SΣ	1..1		The target system or value set (uri or Reference) ele-1: All FHIR elements must have a @value or children
targetUri			uri
targetCanonical			canonical(ValueSet)
group	S	0..*	BackboneElement	Same source and target systems ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
source	S	1..1	uri	URI of source system ele-1: All FHIR elements must have a @value or children
target	S	1..1	uri	URI of target system ele-1: All FHIR elements must have a @value or children
element	S	1..*	BackboneElement	Mappings for a concept from the source set ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Identifies element being mapped ele-1: All FHIR elements must have a @value or children
target	SC	1..*	BackboneElement	Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	code	Code that identifies the target element ele-1: All FHIR elements must have a @value or children
equivalence	?!S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence

Constraints

Id	Grade	Path(s)	Details	Requirements
cmd-0	warning	ConceptMap	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1	error	ConceptMap.group.element.target	If the map is narrower or inexact, there SHALL be some comments : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2	error	ConceptMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ConceptMap	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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ConceptMap	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	error	ConceptMap	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ConceptMap	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from ConceptMap

Name	Flags	Card.	Type	Description & Constraints
ConceptMap		0..*	ConceptMap	A map from one set of concepts to one or more other concepts
url	S	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique)
identifier	S	1..1	Identifier	Additional identifier for the concept map
version	S	1..1	string	Business version of the concept map
name	S	1..1	string	Name for this concept map (computer friendly)
title	S	1..1	string	Name for this concept map (human friendly)
status	S	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
publisher	S	0..1	string	Name of the publisher (organization or individual)
source[x]	S	1..1	uri, canonical(ValueSet)	The source system or value set (uri or Reference)
target[x]	S	1..1	uri, canonical(ValueSet)	The target system or value set (uri or Reference)
group	S	0..*	BackboneElement	Same source and target systems
source	S	1..1	uri	URI of source system
target	S	1..1	uri	URI of target system
element	S	1..*	BackboneElement	Mappings for a concept from the source set
code	S	1..1	code	Identifies element being mapped
target	S	1..*	BackboneElement	Concept in target system for element
code	S	1..1	code	Code that identifies the target element
equivalence	S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ConceptMap	C	0..*	ConceptMap	A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique)
identifier	SΣ	1..1	Identifier	Additional identifier for the concept map
version	SΣ	1..1	string	Business version of the concept map
name	SΣ	1..1	string	Name for this concept map (computer friendly)
title	SΣ	1..1	string	Name for this concept map (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the concept map
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this concept map is defined
copyright		0..1	markdown	Use and/or publishing restrictions
source[x]	SΣ	1..1		The source system or value set (uri or Reference)
sourceUri			uri
sourceCanonical			canonical(ValueSet)
target[x]	SΣ	1..1		The target system or value set (uri or Reference)
targetUri			uri
targetCanonical			canonical(ValueSet)
group	S	0..*	BackboneElement	Same source and target systems
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source	S	1..1	uri	URI of source system
sourceVersion		0..1	string	Specific version of the code system
target	S	1..1	uri	URI of target system
targetVersion		0..1	string	Specific version of the code system
element	S	1..*	BackboneElement	Mappings for a concept from the source set
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Identifies element being mapped
display		0..1	string	Display for the code
target	SC	1..*	BackboneElement	Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code that identifies the target element
display		0..1	string	Display for the code
equivalence	?!S	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required)
comment	C	0..1	string	Description of status/issues in mapping
dependsOn		0..*	BackboneElement	Other elements required for this mapping (from context)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
property		1..1	uri	Reference to property mapping depends on
system		0..1	canonical(CodeSystem)	Code System (if necessary)
value		1..1	string	Value of the referenced element
display		0..1	string	Display for the code (if value is a code)
product		0..*	See dependsOn (ConceptMap)	Other concepts that this mapping also produces
unmapped	C	0..1	BackboneElement	What to do when there is no mapping for the source concept cmd-2: If the mode is 'fixed', a code must be provided cmd-3: If the mode is 'other-map', a url must be provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	code	provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
code		0..1	code	Fixed code when mode = fixed
display		0..1	string	Display for the code
url		0..1	canonical(ConceptMap)	canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ConceptMap.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ConceptMap.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ConceptMap.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
ConceptMap.group.element.target.equivalence	required	ConceptMapEquivalence http://hl7.org/fhir/ValueSet/concept-map-equivalence
ConceptMap.group.unmapped.mode	required	ConceptMapGroupUnmappedMode http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.3.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmd-0	warning	ConceptMap	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1	error	ConceptMap.group.element.target	If the map is narrower or inexact, there SHALL be some comments : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2	error	ConceptMap.group.unmapped	If the mode is 'fixed', a code must be provided : (mode = 'fixed') implies code.exists()
cmd-3	error	ConceptMap.group.unmapped	If the mode is 'other-map', a url must be provided : (mode = 'other-map') implies url.exists()
dom-2	error	ConceptMap	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ConceptMap	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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	ConceptMap	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	error	ConceptMap	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ConceptMap	A resource should have narrative for robust management : text.`div`.exists()
dom-r4b	warning	ConceptMap.contained	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Mandatory: 7 elements(5 nested mandatory elements)
Must-Support: 17 elements

Other representations of profile: CSV, Excel, Schematron