ValueSet/$validate-code

Checks whether a code, Coding, or CodeableConcept is a member of a ValueSet. When display is supplied, Termbox also validates the display text.

FHIR Specification

See the official FHIR specification for supported request parameters and response parameters: https://www.hl7.org/fhir/valueset-operation-validate-code.html.

Response

Returns a FHIR Parameters resource. The result output parameter is true when the submitted code is in the ValueSet.

Example

GET /ValueSet/$validate-code?url=http://snomed.info/sct?fhir_vs=isa/386661006&code=722892007&system=http://snomed.info/sct
Accept: application/fhir+json

POST /ValueSet/$validate-code
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "url", "valueUri": "http://snomed.info/sct?fhir_vs=isa/386661006" },
    { "name": "system", "valueUri": "http://snomed.info/sct" },
    { "name": "code", "valueCode": "722892007" },
    { "name": "display", "valueString": "Fever due to infection (finding)" }
  ]
}

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "result", "valueBoolean": true },
    { "name": "code", "valueCode": "722892007" },
    { "name": "display", "valueString": "Fever due to infection (finding)" },
    { "name": "system", "valueUri": "http://snomed.info/sct" }
  ]
}

The SNOMED CT examples assume SNOMED CT is loaded in Termbox. The example checks whether 722892007 is in the implicit ValueSet for descendants of 386661006.