FHIR CodeSystem/$validate-code for OMOP concepts - OMOPHub.com API

Overview

Validates whether a code is valid in a given code system. Returns true/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.

Request

curl "https://fhir.omophub.com/fhir/r4/CodeSystem/\$validate-code?\
url=http://snomed.info/sct&code=44054006" \
  -H "Authorization: Bearer YOUR_API_KEY"

With display verification:

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 (NOTE: `url`, not `system`)
`code`	code	Yes	The code to validate
`display`	string	No	Expected display text to verify

Response (valid code)

{
  "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" }
  ]
}