CodeSystem Concept Lookup
Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this operation is a full decomposition of a code from a structure terminology
In Aidbox, this is essentially the same as search Concept by system and code
1
GET [base]/fhir/CodeSystem/$lookup?system=http://loinc.org&code=1963-8
Copied!
equals to
1
GET [base]/Concept?system=http://loinc.org&code=1963-8
Copied!
The only difference is the response format.
With Concept Search you can do even more than just getting one concept. For example, you can search and filter by any concept elements.
1
POST [base]/CodeSystem/$lookup
Copied!
More info can be found in the official doc.

Parameters

Parameter
Type
Status
code
​code​
supported
system
​uri​
supported
version
​string​
supported
coding
​Coding​
supported
date
​dateTime​
not supported
displayLanguage
​code​
not supported
property
​code​
not supported

Examples

Available output parameters: name, display, version, designation, property
Request
Response
1
POST [base]/CodeSystem/$lookup
2
{
3
"resourceType" : "Parameters",
4
"parameter" : [
5
{
6
"name" : "system",
7
"valueUri" : "http://hl7.org/fhir/goal-status"
8
9
},
10
{
11
"valueCoding": {
12
"code": "accepted"
13
}
14
}
15
]
16
}
Copied!
1
{
2
"resourceType": "Parameters",
3
"parameter": [
4
{
5
"name": "display",
6
"valueString": "Accepted"
7
},
8
{
9
"name": "name",
10
"valueString": "GoalStatus"
11
}
12
]
13
}
Copied!
Request
Response
1
GET [base]/CodeSystem/$lookup?system=http://hl7.org/fhir/v2/0003&code=RAR
Copied!
or:
1
POST [base]/CodeSystem/$lookup
2
{
3
"resourceType" : "Parameters",
4
"parameter" : [
5
{
6
"name" : "system",
7
"valueUri" : "http://hl7.org/fhir/v2/0003"
8
9
},
10
{
11
"name": "code",
12
"valueCode": "RAR"
13
}
14
]
15
}
Copied!
1
{
2
"resourceType": "Parameters",
3
"parameter": [
4
{
5
"name": "display",
6
"valueString": "RAR - Pharmacy administration information query response"
7
},
8
{
9
"name": "designation",
10
"value": {
11
"display": {
12
"de": "Antwort bzgl. der Behandlungs-/Darreichungsform",
13
"nl": "RAR - Medicatietoediening-informatie query antwoord"
14
}
15
}
16
},
17
{
18
"name": "property",
19
"value": {
20
"v2-0003": {
21
"deprecationDate": "2000-11"
22
}
23
}
24
},
25
{
26
"name": "name",
27
"valueString": "v2 Event Type"
28
}
29
]
30
}
Copied!
Last modified 9mo ago
Copy link