FHIR CodeSystem/$validate-code for OMOP concepts
const options = {method: 'GET'};
fetch('https://fhir.omophub.com/fhir/{version}/CodeSystem/$validate-code', 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/$validate-code'import requests
url = "https://fhir.omophub.com/fhir/{version}/CodeSystem/$validate-code"
response = requests.get(url)
print(response.text){
"resourceType": "Parameters",
"parameter": [
{ "name": "result", "valueBoolean": true },
{ "name": "display", "valueString": "Type 2 diabetes mellitus" }
]
}
FHIR CodeSystem/$validate-code for OMOP concepts
Check whether a code exists in a FHIR CodeSystem backed by OMOP vocabularies - validates SNOMED, LOINC, RxNorm, ICD-10, and HCPCS codes on the wire.
FHIR CodeSystem/$validate-code for OMOP concepts
const options = {method: 'GET'};
fetch('https://fhir.omophub.com/fhir/{version}/CodeSystem/$validate-code', 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/$validate-code'import requests
url = "https://fhir.omophub.com/fhir/{version}/CodeSystem/$validate-code"
response = requests.get(url)
print(response.text){
"resourceType": "Parameters",
"parameter": [
{ "name": "result", "valueBoolean": true },
{ "name": "display", "valueString": "Type 2 diabetes mellitus" }
]
}
Overview
Validates whether a code is valid in a given code system. Returnstrue/false with the display name.
Important: Per the FHIR spec, $validate-code uses the url parameter (not system). This differs from $lookup which uses system.
Contract Parameters
string
default:"r4"
string
Code-system URI; required for the type-level operation.
system is accepted
as an alias.string
required
Code to validate.
string
Expected display text.
Request
curl "https://fhir.omophub.com/fhir/r4/CodeSystem/\$validate-code?\
url=http://snomed.info/sct&code=44054006" \
-H "Authorization: Bearer YOUR_API_KEY"
curl "https://fhir.omophub.com/fhir/r4/CodeSystem/\$validate-code?\
url=http://snomed.info/sct&code=44054006&\
display=Type%202%20diabetes%20mellitus" \
-H "Authorization: Bearer YOUR_API_KEY"
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
url | uri | Yes (type-level) | FHIR code system URI; system is accepted as an alias |
code | code | Yes | The code to validate |
display | string | No | Expected display text to verify |
Response (valid code)
Response Fields
string
Always
Parameters.array
FHIR result parameters.
string
result, display, or message.boolean | null
Validation result.
string | null
Display or explanatory message.
{
"resourceType": "Parameters",
"parameter": [
{ "name": "result", "valueBoolean": true },
{ "name": "display", "valueString": "Type 2 diabetes mellitus" }
]
}
Response (display mismatch)
{
"resourceType": "Parameters",
"parameter": [
{ "name": "result", "valueBoolean": true },
{ "name": "display", "valueString": "Type 2 diabetes mellitus" },
{
"name": "message",
"valueString": "Display mismatch: provided 'Diabetes type 2', actual 'Type 2 diabetes mellitus'."
}
]
}
Response (invalid code)
{
"resourceType": "Parameters",
"parameter": [
{ "name": "result", "valueBoolean": false },
{ "name": "message", "valueString": "Code '999999' not found in SNOMED" }
]
}
Was this page helpful?