FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "ConceptMap-translate" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Concept Translation

OPERATION: Concept Translation

The official URL for 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 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 Cardinality Type Binding Documentation
IN url 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 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 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 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 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 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 a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention

IN coding 0..1 Coding

A coding to translate

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

Identifies 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, the server should return all known translations, along with their source

IN targetsystem 0..1 uri

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

IN dependency.element 0..1 uri

The element for this dependency

IN dependency.concept 0..1 CodeableConcept

The 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

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. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match

OUT match.equivalence 0..1 code

A code indicating the equivalence of the translation, using values from ConceptMapEquivalence

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 0..*

Another element that is the product of this mapping

OUT match.product.element 0..1 uri

The element for this product

OUT match.product.concept 0..1 Coding

The value for this product

OUT match.source 0..1 uri

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


{
  "resourceType" : "OperationDefinition",
  "id" : "ConceptMap-translate",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:43.614Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Concept Translation</h2>\n <p>OPERATION: Concept Translation</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/ConceptMap-translate</pre>\n <div>\n <p>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.</p>\n\n <p>One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.</p>\n\n <p>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</p>\n\n </div>\n <p>URL: [base]/ConceptMap/$translate</p>\n <p>URL: [base]/ConceptMap/[id]/$translate</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>url</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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.</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>conceptMap</td>\n <td>0..1</td>\n <td>\n <a href=\"conceptmap.html\">ConceptMap</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>conceptMapVersion</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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.</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>code</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#code\">code</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The code that is to be translated. If a code is provided, a system must be provided</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>system</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The system for the code that is to be translated</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>version</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The version of the system, if one was provided in the source data</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>source</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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 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 a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>coding</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#Coding\">Coding</a>\n </td>\n <td/>\n <td>\n <div>\n <p>A coding to translate</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>codeableConcept</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>\n </td>\n <td/>\n <td>\n <div>\n <p>A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>target</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>Identifies 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, the server should return all known translations, along with their source</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>targetsystem</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>identifies a target code system in which a mapping is sought. This parameter is an alternative to the target 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</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>dependency</td>\n <td>0..*</td>\n <td/>\n <td/>\n <td>\n <div>\n <p>Another element that may help produce the correct mapping</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>dependency.element</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The element for this dependency</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>dependency.concept</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The value for this dependency</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>reverse</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#boolean\">boolean</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>result</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#boolean\">boolean</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>message</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#string\">string</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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)</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match</td>\n <td>0..*</td>\n <td/>\n <td/>\n <td>\n <div>\n <p>A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.equivalence</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#code\">code</a>\n </td>\n <td/>\n <td>\n <div>\n <p>A code indicating the equivalence of the translation, using values from \n <a href=\"valueset-concept-map-equivalence.html\">ConceptMapEquivalence</a>\n </p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.concept</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#Coding\">Coding</a>\n </td>\n <td/>\n <td>\n <div>\n <p>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)</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.product</td>\n <td>0..*</td>\n <td/>\n <td/>\n <td>\n <div>\n <p>Another element that is the product of this mapping</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.product.element</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The element for this product</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.product.concept</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#Coding\">Coding</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The value for this product</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>OUT</td>\n <td>match.source</td>\n <td>0..1</td>\n <td>\n <a href=\"datatypes.html#uri\">uri</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The canonical reference to the concept map from which this mapping comes from</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div/>\n </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
  "version" : "4.0.0",
  "name" : "Concept Translation",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "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. \r\n\r\n One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated. \r\n\r\n 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",
  "code" : "translate",
  "resource" : [
    "ConceptMap"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "url",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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.",
      "type" : "uri"
    },
    {
      "name" : "conceptMap",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion.",
      "type" : "ConceptMap"
    },
    {
      "name" : "conceptMapVersion",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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.",
      "type" : "string"
    },
    {
      "name" : "code",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The code that is to be translated. If a code is provided, a system must be provided",
      "type" : "code"
    },
    {
      "name" : "system",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The system for the code that is to be translated",
      "type" : "uri"
    },
    {
      "name" : "version",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The version of the system, if one was provided in the source data",
      "type" : "string"
    },
    {
      "name" : "source",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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 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 a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention",
      "type" : "uri"
    },
    {
      "name" : "coding",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A coding to translate",
      "type" : "Coding"
    },
    {
      "name" : "codeableConcept",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses",
      "type" : "CodeableConcept"
    },
    {
      "name" : "target",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Identifies 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, the server should return all known translations, along with their source",
      "type" : "uri"
    },
    {
      "name" : "targetsystem",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "identifies a target code system in which a mapping is sought. This parameter is an alternative to the target 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",
      "type" : "uri"
    },
    {
      "name" : "dependency",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Another element that may help produce the correct mapping",
      "part" : [
        {
          "name" : "element",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The element for this dependency",
          "type" : "uri"
        },
        {
          "name" : "concept",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The value for this dependency",
          "type" : "CodeableConcept"
        }
      ]
    },
    {
      "name" : "reverse",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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",
      "type" : "boolean"
    },
    {
      "name" : "result",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "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",
      "type" : "boolean"
    },
    {
      "name" : "message",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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)",
      "type" : "string"
    },
    {
      "name" : "match",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match",
      "part" : [
        {
          "name" : "equivalence",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence](valueset-concept-map-equivalence.html)",
          "type" : "code"
        },
        {
          "name" : "concept",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "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)",
          "type" : "Coding"
        },
        {
          "name" : "product",
          "use" : "out",
          "min" : 0,
          "max" : "*",
          "documentation" : "Another element that is the product of this mapping",
          "part" : [
            {
              "name" : "element",
              "use" : "out",
              "min" : 0,
              "max" : "1",
              "documentation" : "The element for this product",
              "type" : "uri"
            },
            {
              "name" : "concept",
              "use" : "out",
              "min" : 0,
              "max" : "1",
              "documentation" : "The value for this product",
              "type" : "Coding"
            }
          ]
        },
        {
          "name" : "source",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The canonical reference to the concept map from which this mapping comes from",
          "type" : "uri"
        }
      ]
    }
  ]
}