R4 Ballot #1 (Mixed Normative/Trial use) Current Build
This page was published as part of FHIR v3.3.0: R4 Ballot #1 : Mixed Normative/Trial use (First Normative ballot). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .
Vocabulary Work Group   Maturity Level : 5 N Normative (from v4.1.0) Compartments : N/A
Normative Candidate Note:
This page is candidate normative content for R4 in has been approved as part of an ANSI standard. See the Conformance Package . Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made. for further details.

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. One (and only one) of the in parameters (code, coding, codeableConcept) must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code 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.

The official 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:
Name Cardinality Type Binding Profile Documentation
url 0..1 uri

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 0..1 CodeSystem

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 0..1 code

The code that is to be validated

version 0..1 string

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

display 0..1 string

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 0..1 Coding

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

codeableConcept 0..1 CodeableConcept

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

date 0..1 dateTime

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 0..1 boolean

if If this parameter has a value of true, then an abstract code the client is allowed to be used in stating that the validation is being performed in a context of where a concept designated as 'abstract' is appropriate/allowed to be used, and the code that server should regard abstract codes as valid. If this parameter is being validated. Typically, false, abstract codes are allowed not considered to be used in value set specifications (e.g. any 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 subsumed by an abstract code), but not intended to be used asa 'concrete' concept to in an actual recrod. If false (which patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the default value), then only concrete general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as defined by decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the code system are allowed server that it is working in such a context.

displayLanguage 0..1 code

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

Out Parameters:
Name Cardinality Type Binding Profile Documentation
result 1..1 boolean

True if the concept details supplied are valid

message 0..1 string

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

display 0..1 string

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

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

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

Request: Validate a CodeableConcept against a client specified code system (Request):

POST [base]/CodeSystem/$validate-code
[other headers]
{
  "ResourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "coding",

    "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

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 .