Skip to content

Operation $validate-code on CodeSystem

Validate that a coded value is in the code system.

Endpoints

[fhir_base]/CodeSystem/$validate-code

[fhir_base]/CodeSystem/[id]/$validate-code

Query parameters

Query parameter Type Status Description
url uri supported CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server
codeSystem codeSystem supported The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server
code code supported The code that is to be validated
version string supported The version of the code system, if one was provided in the source data
display string supported The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent
coding Coding supported A coding to validate
codeableConcept CodeableConcept supported A full codeableConcept to validate.
date dateTime unsupported The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
abstract boolean unsupported If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.
displayLanguage code unsupported Specifies the language to be used for description when validating the display property.

Example

Validate whether code social-history is in CS observation-category

    curl --location 'https://kodjin-example.edenlab.dev/terminology/CodeSystem/observation-category/$validate-code?code=social-history&display=Social%20History' \
    --header 'content-type: application/json' \
    --data ''

    {
    "parameter": [
        {
            "name": "result",
            "valueBoolean": true
        },
        {
            "name": "display",
            "valueString": "Social History"
        }
    ],
    "resourceType": "Parameters"
    }

    {
        "parameter": [
            {
                "name": "result",
                "valueBoolean": false
            },
            {
                "name": "message",
                "valueString": "The value provided 'social-history' is not in the code system observation-category"
            }
        ],
        "resourceType": "Parameters"
    }