ConceptMap
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.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/ConceptMap| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/ConceptMap/[id] |
| Vread | GET | /fhir/R5/ConceptMap/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/ConceptMap/[id] |
| Patch | PATCH | /fhir/R5/ConceptMap/[id] |
| Delete | DELETE | /fhir/R5/ConceptMap/[id] |
| Create | POST | /fhir/R5/ConceptMap |
| Search | GET | /fhir/R5/ConceptMap?... |
| History | GET | /fhir/R5/ConceptMap/[id]/_history |
| Type-history | GET | /fhir/R5/ConceptMap/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this concept map, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the concept map |
version | string | 0..1 | Business version of the concept map |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 0..1 | Name for this concept map (computer friendly) |
title | string | 0..1 | Name for this concept map (human friendly) |
status | code | 1..1 | draft |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher/steward (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the concept map |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for concept map (if applicable) |
purpose | markdown | 0..1 | Why this concept map is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
approvalDate | date | 0..1 | When the ConceptMap was approved by publisher |
lastReviewDate | date | 0..1 | When the ConceptMap was last reviewed by the publisher |
effectivePeriod | Period | 0..1 | When the ConceptMap is expected to be used |
topic | CodeableConcept | 0..* | E.g. Education, Treatment, Assessment, etc |
author | ContactDetail | 0..* | Who authored the ConceptMap |
editor | ContactDetail | 0..* | Who edited the ConceptMap |
reviewer | ContactDetail | 0..* | Who reviewed the ConceptMap |
endorser | ContactDetail | 0..* | Who endorsed the ConceptMap |
relatedArtifact | RelatedArtifact | 0..* | Additional documentation, citations, etc |
property | BackboneElement | 0..* | Additional properties of the mapping |
additionalAttribute | BackboneElement | 0..* | Definition of an additional attribute to act as a data source or target |
sourceScope[x] | uri / canonical | 0..1 | The source value set that contains the concepts that are being mapped |
targetScope[x] | uri / canonical | 0..1 | The target value set which provides context for the mappings |
group | BackboneElement | 0..* | Same source and target systems |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
derived-from | reference | What resource is being referenced |
description | string | The description of the activity definition |
effective | date | The time during which the activity definition is intended to be in use |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
mapping-property | uri | Other properties required for this mapping |
name | string | Computationally friendly name of the activity definition |
other-map | reference | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped |
predecessor | reference | What resource is being referenced |
publisher | string | Name of the publisher of the activity definition |
source-code | token | Identifies elements being mapped |
source-group-system | reference | Source system where concepts to be mapped are defined |
source-scope | reference | The source value set that contains the concepts that are being mapped |
source-scope-uri | uri | The URI for the source value set that contains the concepts being mapped |
status | token | The current status of the activity definition |
target-code | token | Code that identifies the target element |
target-group-system | reference | Target system that the concepts are to be mapped to |
target-scope | reference | The target value set which provides context for the mappings |
target-scope-uri | uri | The URI for the target value set that contains the concepts being mapped. |
title | string | The human-friendly name of the activity definition |
topic | token | Topics associated with the module |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
ConceptMap - Maturity: Trial Use 3 (FMM 3).