FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Operation-conceptmap-translate

Example OperationDefinition/ConceptMap-translate (Narrative)

Maturity Level : N/A
Responsible Owner: Vocabulary Terminology Infrastructure Work Group Ballot Standards Status : Informative Compartments : Not linked to any No defined compartments

This is the narrative for the resource. See also the XML or , JSON or Turtle format.

Concept Translation OPERATION: Concept Translation The official URL for

Note that this operation is the formal definition is: for the translate operation as an OperationDefinition on ConceptMap. See the Operation documentation


http://hl7.org/fhir/OperationDefinition/ConceptMap-translate

Generated Narrative: OperationDefinition ConceptMap-translate Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server.

One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated. The operation returns a set of parameters including a 'result' for whether there is an acceptable match, and a list of possible matches. Note that the list of matches may include notes of codes for which mapping is specifically excluded, so implementers have to check the match.equivalence for each match

URL: [base]/ConceptMap/$translate

URL: [base]/ConceptMap/[id]/$translate

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN url type 0..1 uri

A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server.

IN conceptMap type 0..1 ConceptMap code

The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.

IN conceptMapVersion type 0..1 string

The identifier that is used to identify a specific version of the concept map to be used for the translation. 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.

IN sourceCode 0..1 code

The code that is to be translated. If a code is provided, a system must be provided

IN system sourceSystem 0..1 uri

The system for the code that is sourceCode to be translated translated. Note: the previous name of this input parameter was system , and servers MAY choose to still accept that name

IN version sourceVersion 0..1 string

The version for the system of the system, if one was provided in sourceCode to be translated. Note: the source data previous name of this input parameter was version , and servers MAY choose to still accept that name.

IN sourceScope 0..1 uri

Limits the scope of the $translate operation to source codes (ConceptMap.group.element.code) that are members of this value set.

IN sourceCoding 0..1 Coding uri

A coding to translate

IN sourceCodeableConcept 0..1 CodeableConcept

Identifies the value set used when A full codeableConcept to validate. The server can translate any of the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. coding values (e.g. existing translations) as it chooses

IN targetCode 0..1 code

The source value set target code that is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without translated to. If a source value set if there code is provided, a full mapping for the entire code system in the concept map, or by manual intervention must be provided

IN coding targetCoding 0..1 Coding

A target coding to translate to

IN codeableConcept targetCodeableConcept 0..1 CodeableConcept

A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses

IN target targetScope 0..1 uri

Identifies Limits the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, scope of the server should return all known translations, along with their source $translate operation to target codes (ConceptMap.group.element.target.code) that are members of this value set.

IN targetsystem targetSystem 0..1 uri

identifies a target code system in which a mapping is sought. This parameter is an alternative to the target targetScope parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation

IN dependency 0..*

Another element Data from another attribute that may help produce the correct mapping

IN dependency.element dependency.attribute 0..1 uri

The element attribute for this dependency

IN dependency.concept dependency.value 0..1 CodeableConcept Element

The data value for this dependency

IN OUT reverse result 0..1 boolean if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters 1..1 OUT result boolean 1..1 boolean

True if the concept could be translated successfully. The value can only be true if at least one returned match has an equivalence which is not unmatched or disjoint a relationship other than 'not-related-to'.

OUT message 0..1 string

Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail)

OUT match 0..*

A concept in the target value set with an equivalence. a relationship. Note that there may be multiple matches of equal or differing equivalence, relationships, and the matches may include equivalence values that mean the 'not-related-to' relationship value which means that there is no match translation

OUT match.equivalence match.relationship 0..1 code

A code indicating the equivalence relationship (e.g., equivalent) of the translation, using values from [ConceptMapEquivalence]{concept-map-equivalence.html} ConceptMapRelationship

OUT match.concept 0..1 Coding

The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently)

OUT match.property 0..*

A property of this mapping (may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation)

OUT match.property.uri match.product 1..1 uri 0..*

The uri that identifies the property

OUT match.property.value 1..1 Element

Another element The value of the property

OUT match.product 0..*

A data value to go in an attribute that is the product of this mapping

OUT match.product.attribute match.product.element 1..1 uri 0..1

The attribute for this product

uri OUT match.product.value 1..1 Element

The element value for this product

OUT match.dependsOn 0..*

An data value in an additional attribute that this mapping depends on

OUT match.dependsOn.attribute match.product.concept 1..1 uri 0..1

The attribute that this mapping depends on

OUT match.dependsOn.value Coding 1..1 Element

The value for of the attribute that this product mapping depends on

OUT match.source match.originMap 0..1 uri

The canonical URI for reference to the concept map from which this mapping comes from


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.