ValueSet Validate Code

Validating whether a given coding is in a specified set forms the backbone of FHIR terminology bindings: many resource properties can be required to have their values drawn from a given set of values specified by a ValueSet, which may need to be expanded behind the scenes.

[baseUrl]/ValueSet/$validate-code
[baseUrl]/ValueSet/[id]$validate-code

Parameters

Name	Type	Description	Required
url	uri	The canonical URL of the ValueSet to validate against	No*
code	string	The code to look up.	No
system	string	The canonical URL of the code system the code belongs to.	No
coding	Coding	Look up via full Coding.	No
codeableConcept	CodeableConcept	Look up multiple related codes.	No
display	string	Additionally validate the given display text	No
abstract	boolean	Whether codes labeled as abstract, i.e. representing broad concepts rather than specific values, should be included	No

^* If no url is provided, the operation must be invoked on a specific ValueSet instance.

Required Parameters

Although no parameters are strictly required by the operation, at least one of the following must be provided:

• Both code and system parameters (and optionally display)
• The coding parameter
• The codeableConcept parameter with at least one contained coding

Output

The operation returns a Parameters resource containing the validation result.

Name	Type	Description	Required
result	boolean	Whether or not any given coding is included in the ValueSet	Yes
display	string	The display text of the included code	No

Error Responses

Example: Specified ValueSet could not be found by URL (400 Bad Request)

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error"
            "code": "invalid",
            "details": {
                "text": "ValueSet http://example.com/ValueSet/missing not found"
            },
        }
    ]
}

Examples

Request:

TypeScript

const result = await medplum.post(medplum.fhirUrl('ValueSet', '$validate-code').toString(), {
  resourceType: 'Parameters',
  parameter: [
    { name: 'url', valueUri: 'http://hl7.org/fhir/ValueSet/condition-severity' },
    { name: 'coding', valueCoding: { system: 'http://snomed.info/sct', code: '255604002' } },
  ],
});

cURL

curl 'https://api.medplum.com/fhir/R4/ValueSet/$validate-code' \
  -X POST \
  -H "Content-Type: application/fhir+json" \
  -H "Authorization: Bearer $MY_ACCESS_TOKEN" \
  -d '{"resourceType":"Parameters","parameter":[{"name":"url","valueUri":"http://hl7.org/fhir/ValueSet/condition-severity"},{"name":"coding","valueCoding":{"system":"http://snomed.info/sct","code":"255604002"}}]}'

Response: (200 OK)

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "result", "valueBoolean": true },
    { "name": "display", "valueString": "Mild (qualifier value)" }
  ]
}