FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/ConceptMap-translate (Narrative)

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

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


URL: [base]/ConceptMap/$translate

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INurl0..1uri

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.

INconceptMap0..1ConceptMap

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

INconceptMapVersion0..1string

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.

INsourceCode0..1code

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

INsystem0..1uri

The system for the code that is to be translated

INversion0..1string

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

INsourceScope0..1uri

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

INsourceCoding0..1Coding

A coding to translate

INsourceCodeableConcept0..1CodeableConcept

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

INtargetCode0..1uri

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

INtargetCoding0..1uri

A target coding to translate to

INtargetCodeableConcept0..1uri

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

INtargetScope0..1uri

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

INtargetSystem0..1uri

identifies a target code system in which a mapping is sought. This parameter is an alternative to the 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

INdependency0..*

Another element that may help produce the correct mapping

INdependency.element0..1uri

The element for this dependency

INdependency.value0..1code | Coding | string | integer | boolean | dateTime | decimal | uri | id

The value for this dependency

OUTresult1..1boolean

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

OUTmessage0..1string

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)

OUTmatch0..*

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

OUTmatch.relationship0..1code

A code indicating the relationship (e.g., equivalent) of the translation, using values from ConceptMapRelationship

OUTmatch.concept0..1Coding

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)

OUTmatch.product0..*

An element that is the product of this mapping

OUTmatch.product.property1..1uri

The element for this product

OUTmatch.product.value1..1code | Coding | string | integer | boolean | dateTime | decimal | uri | id

The value for this product

OUTmatch.dependsOn0..*

An element that this mapping depends on

OUTmatch.dependsOn.property1..1uri

The element for this product

OUTmatch.dependsOn.value1..1code | Coding | string | integer | boolean | dateTime | decimal | uri | id

The value for this product

OUTmatch.originMap0..1uri

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.