https://tx.ontoserver.csiro.au/fhir/OperationDefinition/CodeSystemValueSet-it-validate-code
Operation

Validate that a coded value is in the code system.

OPERATION 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. 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.

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

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

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

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

May be invoked by performing an HTTP GET operation as well as a POST.

Parameters

UseNameCardinalityTypeBindingDocumentation
INcode0..1code
The code that is to be validated
INversion0..1string
The version of the code system
INdisplay0..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
INcoding0..1Coding
A coding to validate. The system must match the specified code system
INcodeableConcept0..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
INdisplayLanguage0..1code
Specifies the language to be used for description when validating the display property
INurl0..1uri
CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server's code systems, or it is known implicitly by the server
INcodeSystem0..0CodeSystem
INdate0..0dateTime
INtx-resource0..*Resource
INvalueSetVersion0..1string
INsystem0..1uri
INsystemVersion0..1string
INuseSupplement0..*canonical
INcontext0..1uri
INvalueSet0..1ValueSet
INsystem-version0..*canonical
INforce-system-version0..*canonical
INinferSystem0..1boolean
INactiveOnly0..1boolean
INmode1..1string
INvaluesetMode0..1string
INlenient-display-validation0..1boolean
INvalueset-membership-only0..1boolean
{
  "resourceType": "OperationDefinition",
  "text": {
  "status": "generated",
  "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Operation</div>"
  },
  "url": "https://tx.ontoserver.csiro.au/fhir/OperationDefinition/CodeSystemValueSet-it-validate-code",
  "name": "Validate-code",
  "title": "Validate that a coded value is in the code system.",
  "status": "active",
  "kind": "operation",
  "description": "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.\n\nWhen 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.",
  "affectsState": false,
  "code": "validate-code",
  "resource": [ "CodeSystem", "ValueSet" ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [ {
  "name": "code",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "The code that is to be validated",
  "type": "code"
  }, {
  "name": "version",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "The version of the code system",
  "type": "string"
  }, {
  "name": "display",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "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",
  "type": "string"
  }, {
  "name": "coding",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "A coding to validate. The system must match the specified code system",
  "type": "Coding"
  }, {
  "name": "codeableConcept",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "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",
  "type": "CodeableConcept"
  }, {
  "name": "displayLanguage",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "Specifies the language to be used for description when validating the display property",
  "type": "code"
  }, {
  "name": "url",
  "use": "in",
  "min": 0,
  "max": "1",
  "documentation": "CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server's code systems, or it is known implicitly by the server",
  "type": "uri"
  }, {
  "name": "codeSystem",
  "use": "in",
  "min": 0,
  "max": "0",
  "type": "CodeSystem"
  }, {
  "name": "date",
  "use": "in",
  "min": 0,
  "max": "0",
  "type": "dateTime"
  }, {
  "name": "tx-resource",
  "use": "in",
  "min": 0,
  "max": "*",
  "type": "Resource"
  }, {
  "name": "valueSetVersion",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "string"
  }, {
  "name": "system",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "uri"
  }, {
  "name": "systemVersion",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "string"
  }, {
  "name": "useSupplement",
  "use": "in",
  "min": 0,
  "max": "*",
  "type": "canonical"
  }, {
  "name": "context",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "uri"
  }, {
  "name": "valueSet",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "ValueSet"
  }, {
  "name": "system-version",
  "use": "in",
  "min": 0,
  "max": "*",
  "type": "canonical"
  }, {
  "name": "force-system-version",
  "use": "in",
  "min": 0,
  "max": "*",
  "type": "canonical"
  }, {
  "name": "inferSystem",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "boolean"
  }, {
  "name": "activeOnly",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "boolean"
  }, {
  "name": "mode",
  "use": "in",
  "min": 1,
  "max": "1",
  "type": "string"
  }, {
  "name": "valuesetMode",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "string"
  }, {
  "name": "lenient-display-validation",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "boolean"
  }, {
  "name": "valueset-membership-only",
  "use": "in",
  "min": 0,
  "max": "1",
  "type": "boolean"
  } ]
}