Page Status: updated 2022-10-27
ConceptMap - Fetch and extended operations
Page index
Introduction
Sv. Hämta kodrelationer.
This page describes how to fetch the resource ConceptMap by a few examples.
Concept maps can be fetched in different ways. See ConceptMap query operations for information about all options.
In short, a query request is either a read, that is, a retrieval via the resource ID, or a search via a search condition. The result differs between a read and a search. A search results in a Bundle being returned containing all matching resources. If there are no hits, an empty Bundle is returned. A read results in the requested resource being returned or an error if no resource with the requested ID exists. If a system error occurs both searches and reads result in an error (i.e. an OperationOutcome).
Fetching one or more ConceptMaps is done by one of the following operations.
GET [base]/ConceptMap
GET [base]/ConceptMap/[id]
It is also possible to run one extended operation on the ConceptMap resource. It is done in the following way.
GET|POST [base]/ConceptMap/$[operation]
See ConceptMap for more information about the ConceptMap resource.
Examples
HTTP Headers
See HTTP Header and Authorization for generic information about all HTTP headers used by the National Medication List including information about authorization, purpose and access type. The authorization token is translated to an authority role. The authority role together with the purpose and type of access is used by the National Medication List to determine what actions a user may perform and what information the user may access.
| Header | Comment |
|---|---|
| authorization | The users's security token |
| prefer | Type of returned content |
| x-access | The cause for the call |
| x-context-id | An ID to group a sequence of requests |
| x-org-info | Information about the users's organisation |
| x-patientref | The logical ID of the patient |
| x-provenance | A provenance resource with information about the user interacting with NLL |
| x-purpose | The purpose of the call |
| x-request-id | A random and unique ID |
| x-user-agent | Information about the calling system |
Example 1 - Fetch a specific concept map
This example shows how to fetch a specific concept map, in this case Administreringsväg till Administreringsställe (nll-route-to-site).
The request is made as a read by the logical id,
GET [base]/ConceptMap/nll-route-to-site.
HTTP headers
| Header | Value | Comment |
|---|---|---|
| authorization | ||
| prefer | ||
| x-access | ||
| x-org-info | ||
| x-patientref | ||
| x-provenance | ||
| x-purpose | ||
| x-request-id | bd293d24-c043-44e3-b885-289a02fb75c0 |
|
| x-user-agent | {"name":"Test system testaren","version":"0.01010101010.1 beta"} |
Decoded value |
HTTP body: Administreringsväg till Administreringsställe (nll-route-to-site)
Example 2 - Translate a code
This example shows how to translate a code within Doseringshastighetsenhet till Snomed CT Doseringshastighetsenhet (nll-ucum-rate-unit-to-snomed).
The request is made by calling the extended operation $translate,
GET [base]/ConceptMap/nll-ucum-rate-unit-to-snomed/$translate?system=http://unitsofmeasure.org&code=L/min.
HTTP headers
| Header | Value | Comment |
|---|---|---|
| authorization | ||
| prefer | ||
| x-access | ||
| x-org-info | ||
| x-patientref | ||
| x-provenance | ||
| x-purpose | ||
| x-request-id | 93af3557-a835-48a7-9ebf-8c93ea7d12e7 |
|
| x-user-agent | {"name":"Test system testaren","version":"0.01010101010.1 beta"} |
Decoded value |
HTTP body: Example of translate a code in a ConceptMap