R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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

Operation-codesystem-validate-code

Vocabulary Work Group

Maturity Level: N/A

Ballot Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML or JSON format.

Code System based Validation

OPERATION: Code System based Validation

The official URL for this operation definition is:

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

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

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

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

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

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

IN

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

IN

code

0..1

code

The code that is to be validated

IN

version

0..1

string

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

IN

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

IN

coding

0..1

Coding

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

IN

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

IN

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.

IN

abstract

0..1

boolean

if true, then an abstract code is allowed to be used in the context of the code that is being validated. Typically, abstract codes are allowed to be used in value set specifications (e.g. any code that is subsumed by an abstract code), but not in an actual recrod. If false (which is the default value), then only concrete codes as defined by the code system are allowed

IN

displayLanguage

0..1

code

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

OUT

result

1..1

boolean

True if the concept details supplied are valid

OUT

message

0..1

string

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

OUT

display

0..1

string

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

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.