Page Status: Outdated

ConceptMap - Fetch

Page index

Introduction

This section describes the process of fetching ConceptMap(s).

The basic approach to achieve this use case is an HTTP GET on ConceptMap. For example:

GET [base]/ConceptMap/nll-form-to-ucum-unit

Se ConceptMap for a complete list of query options.

Sequence diagram

The diagram below shows the typical sequence needed to fetch concept maps. No authorization token is needed to access the ConceptMap resource.

Note that the requests shown in the diagram doesn't include the full basepath. It only shows the last part of the http request including resource and possible search/query parameters.

See the generic example for other type of responses.

Examples

HTTP Header

Required authorization and provenance information.

TODO

Parameter Mandatory Comment
Authorization
X-Access
X-Purpose
X-Provenance
X-Request-ID
X-User-Agent
X-OrgInfo
X-PatientRef

This is an example of access and purpose type. The type must reflect the given situation. A full list of access and purpose types will be enclosed in the developer portal Confluence, EHM.

See HTTP Header and Authorization for generic information about the HTTP header.

Example 1 - fetch all concept maps

This example shows how to fetch all present and active concept maps. The response will include a bundle with an entry element for each concept map.

Request

GET [base]/fhir/ConceptMap

Response

{
  "resourceType": "Bundle",
  "id": "a0c666b1-a431-476f-94ea-f27f0299f96a",
  "meta": {f
    "lastUpdated": "2020-02-17T08:13:13.288+01:00"
  },
  "type": "searchset",
  "total": 11,
  "link": [
    {
      "relation": "self",
      "url": "http://.../fhir/ConceptMap"
    }
  ],
  "entry": [
    {
      "fullUrl": "http://.../fhir/ConceptMap/nll-site-to-qualifier",
      "resource": {
        "resourceType": "ConceptMap",
        "id": "nll-site-to-qualifier",
...
        "group": [
          {
            "source": "http://snomed.info/sct",
            "sourceVersion": "Swedish Edition 2019-11-30",
            "target": "http://snomed.info/sct",
            "targetVersion": "Swedish Edition 2019-11-30",
            "element": [
              {
                "code": "344001",
                "target": [
                  {
                    "code": "255551008",
                    "equivalence": "relatedto"
                  },
                  {
                    "code": "255549009",
                    "equivalence": "relatedto"
                  },
...
    {
      "fullUrl": "http://.../fhir/ConceptMap/nll-route-to-site",
      "resource": {
        "resourceType": "ConceptMap",

Example 2 - translate one value set to another

This example shows how to translate a given ValueSet (in this case nll-snomed-site) to another (nll-snomed-qualifier) using the translate operation. The response shows a result, which includes matches and potential matches.

Request

GET [base]/fhir/ConceptMap/$translate?system=http://snomed.info/sct&code=344001&source=http://electronichealth.se/fhir/ValueSet/nll-snomed-site&target=http://electronichealth.se/fhir/ValueSet/nll-snomed-qualifier

Response

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "result",
      "valueBoolean": true
    },
    {
      "name": "match",
      "part": [
        {
          "name": "equivalence",
          "valueCode": "relatedto"
        },
        {
          "name": "concept",
          "valueCoding": {
            "system": "http://snomed.info/sct",
            "code": "7771000"
          }
        }
      ]
    },
    {
      "name": "match",
      "part": [
        {
          "name": "equivalence",
          "valueCode": "relatedto"
        },
        {
          "name": "concept",
          "valueCoding": {
            "system": "http://snomed.info/sct",
            "code": "24028007"
          }
        }
      ]
    },
...