FHIR CodeSystem/$subsumes for concept hierarchy
const options = {method: 'GET'};
fetch('https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url 'https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes'import requests
url = "https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes"
response = requests.get(url)
print(response.text){
"resourceType": "Parameters",
"parameter": [{ "name": "outcome", "valueCode": "subsumes" }]
}
FHIR CodeSystem/$subsumes for concept hierarchy
Test subsumption relationships between two OMOP concepts with FHIR $subsumes - determine parent, child, equivalent, or not-subsumed status.
FHIR CodeSystem/$subsumes for concept hierarchy
const options = {method: 'GET'};
fetch('https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url 'https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes'import requests
url = "https://fhir.omophub.com/fhir/{version}/CodeSystem/$subsumes"
response = requests.get(url)
print(response.text){
"resourceType": "Parameters",
"parameter": [{ "name": "outcome", "valueCode": "subsumes" }]
}
Overview
Tests whether concept A subsumes (is an ancestor of) concept B, or vice versa. Used for hierarchy-aware code validation and clinical decision support. Supports both type-level and instance-level invocation.Contract Parameters
string
default:"r4"
string
First code; required unless
codingA is supplied.object
Coding alternative for the first concept.
string
Second code; required unless
codingB is supplied.object
Coding alternative for the second concept.
string
Code-system URI; required for the type-level operation.
Request
# Does "Diabetes mellitus" subsume "Type 2 diabetes mellitus"?
curl "https://fhir.omophub.com/fhir/r4/CodeSystem/\$subsumes?\
codeA=73211009&codeB=44054006&system=http://snomed.info/sct" \
-H "Authorization: Bearer YOUR_API_KEY"
By OMOP concept ID
curl "https://fhir.omophub.com/fhir/r4/CodeSystem/\$subsumes?\
codeA=201820&codeB=201826&system=https://fhir-terminology.ohdsi.org" \
-H "Authorization: Bearer YOUR_API_KEY"
Instance-level
curl "https://fhir.omophub.com/fhir/r4/CodeSystem/omop-v20260227/\$subsumes?\
codeA=201820&codeB=201826" \
-H "Authorization: Bearer YOUR_API_KEY"
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codeA | code | Unless codingA is supplied | First concept code |
codingA | Coding | Unless codeA is supplied | Coding alternative for first concept |
codeB | code | Unless codingB is supplied | Second concept code |
codingB | Coding | Unless codeB is supplied | Coding alternative for second concept |
system | uri | Yes (type-level) | Code system URI |
Response
Response Fields
string
Always
Parameters.array
Contains the outcome parameter.
string
Always
outcome.string
Subsumption outcome.
{
"resourceType": "Parameters",
"parameter": [{ "name": "outcome", "valueCode": "subsumes" }]
}
Possible Outcomes
| Outcome | Meaning |
|---|---|
equivalent | A and B are the same concept |
subsumes | A is an ancestor of B (A subsumes B) |
subsumed-by | A is a descendant of B (B subsumes A) |
not-subsumed | No hierarchical relationship between A and B |
Examples
# A subsumes B (Diabetes mellitus → Type 2 DM)
# → outcome: subsumes
# Reverse (Type 2 DM → Diabetes mellitus)
# → outcome: subsumed-by
# Same concept
# → outcome: equivalent
# Unrelated concepts (Type 2 DM vs Myocardial infarction)
# → outcome: not-subsumed
Errors
| HTTP | Issue Code | Cause |
|---|---|---|
| 400 | invalid | Missing codeA, codeB, or system parameter |
| 404 | not-found | Code not found in the specified code system |
Was this page helpful?