ValidateCodeSystemCode

Summary

A REST operation implemented by the Terminology service that validates a code against a code system using terminology artifacts loaded in memory to support high performance.

The validation code operation complies with the FHIR Operation $validate-code on CodeSystem specification.

The implementation of this operation is almost identical to the $validate-code operation on ValueSet. The "system" parameter is not required, in this case, because the code system is explicitly identified in the URL.

Example Requests

Using query parameters with the CodeSystem identified in the path of the URL

POST {{terminology-api-base}}/api/terminology/fhir/CodeSystem/address-type/$validate-code?code=physical

Using query parameters

Note: The "url" query parameter often has special characters that must be URL-encoded, as in this example.

POST {{terminology-api-base}}/api/terminology/fhir/CodeSystem/$validate-code?url=http%3A%2F%2Fhl7.org%2Ffhir%2Faddress-type&code=physical

Example Response

Good/valid response

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "result",
            "valueBoolean": true
        }
    ]
}

Bad/invalid response

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "result",
            "valueBoolean": false
        },
        {
            "name": "message",
            "valueString": "Code not found in code system"
        }
    ]
}

flowchart LR
nValidateCodeSystemCode_15D077E8["Command: Validate CodeSystem Code"]
  nValidationService_20F4F748["Service: ValidationService"] -->|sends| nValidateCodeSystemCode_15D077E8
  nValidateCodeSystemCode_15D077E8 -->|handled by| nTerminologyService_621D88E6["Service: TerminologyService"]
  subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
    nValidateCodeSystemCode_15D077E8
    nValidationService_20F4F748
  end
  subgraph nKnowledgeArtifactManagement_308AC1BE_domain["Domain: Knowledge Artifact Management"]
    nTerminologyService_621D88E6
  end

Relationships

flowchart LR
nValidateCodeSystemCode_15D077E8["Command: Validate CodeSystem Code"]
  nValidationService_20F4F748["Service: ValidationService"] -->|sends| nValidateCodeSystemCode_15D077E8
  nValidateCodeSystemCode_15D077E8 -->|handled by| nTerminologyService_621D88E6["Service: TerminologyService"]
  subgraph nCompliance_DBAE25D_domain["Domain: Compliance"]
    nValidateCodeSystemCode_15D077E8
    nValidationService_20F4F748
  end
  subgraph nKnowledgeArtifactManagement_308AC1BE_domain["Domain: Knowledge Artifact Management"]
    nTerminologyService_621D88E6
  end