ConceptMap

ResourceFoundation · TerminologyTrial useMaturity 3

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

19 of 26 parameters tested

Structure

Show inherited elements (23)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this concept map, represented as a URI (globally unique)
identifierΣ	0..1	Identifier	Additional identifier for the concept map
versionΣ	0..1	string	Business version of the concept map
nameΣ	0..1	string	Name for this concept map (computer friendly)
titleΣ	0..1	string	Name for this concept map (human friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	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 (extensible): jurisdiction
purpose	0..1	markdown	Why this concept map is defined
copyright	0..1	markdown	Use and/or publishing restrictions
source[x]Σ	0..1	uri | canonical(ValueSet)	The source value set that contains the concepts that are being mapped
target[x]Σ	0..1	uri | canonical(ValueSet)	The target value set which provides context for the mappings
group	0..*	BackboneElement	Same source and target systems
source	0..1	uri	Source system where concepts to be mapped are defined
sourceVersion	0..1	string	Specific version of the code system
target	0..1	uri	Target system that the concepts are to be mapped to
targetVersion	0..1	string	Specific version of the code system
elementRequired	1..*	BackboneElement	Mappings for a concept from the source set
code	0..1	code	Identifies element being mapped
display	0..1	string	Display for the code
target	0..*	BackboneElement	Concept in target system for element
code	0..1	code	Code that identifies the target element
display	0..1	string	Display for the code
equivalenceRequired?!	1..1	code	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjointBinding (required): concept-map-equivalence
comment	0..1	string	Description of status/issues in mapping
dependsOn	0..*	BackboneElement	Other elements required for this mapping (from context)
propertyRequired	1..1	uri	Reference to property mapping depends on
system	0..1	canonical(CodeSystem)	Code System (if necessary)
valueRequired	1..1	string	Value of the referenced element
display	0..1	string	Display for the code (if value is a code)
product	0..*	Same as ConceptMap.group.element.target.dependsOn	Other concepts that this mapping also produces
unmapped	0..1	BackboneElement	What to do when there is no mapping for the source concept
modeRequired	1..1	code	provided | fixed | other-mapBinding (required): conceptmap-unmapped-mode
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

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ConceptMap?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
context	token	A use context assigned to the concept map (ConceptMap.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the concept map (ConceptMap.useContext.value.ofType(Quantity)) | (ConceptMap.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the concept map ConceptMap.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the concept map ConceptMap.useContext
context-type-value	composite	A use context type and value assigned to the concept map ConceptMap.useContext
date	date	The concept map publication date ConceptMap.date
dependson	uri	Reference to property mapping depends on ConceptMap.group.element.target.dependsOn.property
description	string	The description of the concept map ConceptMap.description
identifier	token	External identifier for the concept map ConceptMap.identifier
jurisdiction	token	Intended jurisdiction for the concept map ConceptMap.jurisdiction
name	string	Computationally friendly name of the concept map ConceptMap.name
other	reference	canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped ConceptMap.group.unmapped.url
product	uri	Reference to property mapping depends on ConceptMap.group.element.target.product.property
publisher	string	Name of the publisher of the concept map ConceptMap.publisher
source	reference	The source value set that contains the concepts that are being mapped (ConceptMap.source.ofType(canonical))
source-code	token	Identifies element being mapped ConceptMap.group.element.code
source-system	uri	Source system where concepts to be mapped are defined ConceptMap.group.source
source-uri	reference	The source value set that contains the concepts that are being mapped (ConceptMap.source.ofType(uri))
status	token	The current status of the concept map ConceptMap.status
target	reference	The target value set which provides context for the mappings (ConceptMap.target.ofType(canonical))
target-code	token	Code that identifies the target element ConceptMap.group.element.target.code
target-system	uri	Target system that the concepts are to be mapped to ConceptMap.group.target
target-uri	reference	The target value set which provides context for the mappings (ConceptMap.target.ofType(uri))
title	string	The human-friendly name of the concept map ConceptMap.title
url	uri	The uri that identifies the concept map ConceptMap.url
version	token	The business version of the concept map ConceptMap.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition