Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

4.8.22.2 Operation $validate-code on CodeSystem

Vocabulary icon Work Group Maturity Level: NNormative Compartments: N/A

Validate that a coded value is in the code system. If the operation is not called at the instance level, one of the parameters "url" or "codeSystem" must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.

When invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system, coding, or codeableConcept). Other parameters (including version and display) are optional. When validating a code or a coding, then the code, system and version output parameters SHOULD be populated when possible. When a validating a CodeableConcept, then the codeableConcept output parameter SHOULD be populated when possible.

The canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code

Formal Definition (as a OperationDefinition).

URL: [base]/CodeSystem/$validate-code

URL: [base]/CodeSystem/[id]/$validate-code

This is an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
url0..1uri

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

codeSystem0..1CodeSystem

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

code0..1code

The code that is to be validated

version0..1string

The version of the code system, if one was provided in the source data

display0..1string

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

coding0..1Coding

A coding to validate. The system must match the specified code system

codeableConcept0..1CodeableConcept

A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present

date0..1dateTime

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.

abstract0..1boolean

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.

Note that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.

displayLanguage0..1code

Specifies the language to be used for description when validating the display property

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
result1..1boolean

True if the concept details supplied are valid

message0..1string

Error details, if result = false. If this is provided when result = true, the message carries hints and warnings

display0..1string

A valid display for the concept if the system wishes to display this to a user

code0..1code

The code that was validated

system0..1uri

The system for the code that was validated

version0..1string

The version of the system of the code that was validated

codeableConcept0..1CodeableConcept

A codeableConcept containing codings for all the validated codes

issues0..1OperationOutcome

List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display

4.8.22.2.1 Examples

Request: Simple validation of a code against a known code system

GET [base]/CodeSystem/loinc/$validate-code?code=1963-8&display=test

Request: Validate a CodeableConcept against a client specified code system

POST [base]/CodeSystem/$validate-code
[other headers]

{
  "ResourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "codeableConcept",
    "valueCodeableConcept" : {
      "coding" : {
        "system" : "http://example.org",
          "code" : "code",
      "display" : "test"
      }
    }
  },
  {
    "name" : "codeSystem",
    "resource": {
      "resourceType" : "codeSystem",
    [etc.]
    }
  }
  ]
}

Response: When the request can be processed ok


HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "result",
    "valueBoolean" : "false"
  },
  {
    "name" : "message",
    "valueString" : "The display \"test\" is incorrect"
  },
  {
    "name" : "display",
    "valueString" : "Bicarbonate [Moles/volume] in Serum"
  }
  ]
}

Response: When the validation cannot be performed. An error like this not returned if the code is not valid, but when the server is unable to determine whether the code is valid



HTTP/1.1 400 Bad Request
[other headers]

{
  "resourceType": "OperationOutcome",
  "id": "exception",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">No system parameter provided in request</div>"
  },
  "issue": [
    {
      "severity": "error",
      "code": "required",
      "details": {
        "text": "No system parameter provided in request"
      }
    }
  ]
}

 

For more information about operations, including how they are invoked, see Operations.