Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Operation-conceptmap-translate

Example OperationDefinition/ConceptMap-translate (Narrative)

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

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

Translate OPERATION: Translate The official URL for

Note that this operation definition is: http://hl7.org/fhir/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 is the in parameters (code, coding, codeableConcept) must be provided, to identify formal definition for the code that is to be translated. The translate operation returns a set of parameters including a 'result' for whether there is as 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 OperationDefinition on ConceptMap. See the match.equivalence for each match Operation documentation

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

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 code sourceCode 0..1 code

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

IN system 0..1 uri

The system for the code that is to be translated

IN version 0..1 string

The version of the system, if one was provided in the source data

IN source sourceScope 0..1 uri

Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what Limits the source value set is. However, without a source value set, scope of the server may be unable $translate operation to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note codes (ConceptMap.group.element.code) that servers may be able to identify an appropriate concept map without a source are members of this value set if there is a full mapping for the entire code system in the concept map, or by manual intervention set.

IN coding sourceCoding 0..1 Coding

A coding to translate

IN codeableConcept sourceCodeableConcept 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 targetCode 0..1 uri

Identifies the value set in which a translation The target code that is sought. May to be a logical id, or an absolute or relative location. translated to. If there's no a code is provided, a system must be provided

IN targetCoding 0..1 uri

A target specified, the coding to translate to

IN targetCodeableConcept 0..1 uri

A full codeableConcept to validate. The server should return all known translations, along with their source can translate any of the coding values (e.g. existing translations) as it chooses

IN targetsystem targetScope 0..1 uri

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

IN 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 code | Coding | string | boolean | Quantity

The data value for this dependency

IN reverse 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 OUT result 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 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.product 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 1..1 uri

Another element The uri that identifies the property

OUT match.property.value 1..1 Coding | string | integer | boolean | dateTime | decimal | code

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.element match.product.attribute 0..1 1..1 uri

The element attribute for this product

OUT match.product.concept match.product.value 0..1 1..1 code | Coding | string | boolean | Quantity

The value for this product

OUT match.dependsOn 0..*

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

OUT match.dependsOn.attribute 1..1 uri

The attribute for this product

OUT match.source match.dependsOn.value 0..1 1..1 code | Coding | string | integer | boolean | dateTime | decimal | uri | id

The value for this product

OUT match.originMap 0..1 uri

The canonical 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.