Operation-valueset-validate-code.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ValueSet-validate-code",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code",
  "name": "Value Set based Validation",
  "status": "draft",
  "kind": "operation",
  "date": "2019-10-24T11:53:00+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Validate that a coded value is in the set of codes allowed by a value set.   If the operation is not called at the instance level, one of the in parameters \"identifier\" or \"valueset\" 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": "validate-code",
  "resource": [
    "ValueSet"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "url",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server",
      "type": "uri"
    },
    {
      "name": "context",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the profile registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time",
      "type": "uri"
    },
    {
      "name": "valueSet",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server",
      "type": "ValueSet"
    },
    {
      "name": "code",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The code that is to be validated. If a code is provided, a system must be provided",
      "type": "code"
    },
    {
      "name": "system",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The system for the code that is to be validated",
      "type": "uri"
    },
    {
      "name": "version",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The version of the system, if one was provided in the source data",
      "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",
      "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 value set, and may also validate that the codings are not in conflict with each other if more than one is present",
      "type": "CodeableConcept"
    },
    {
      "name": "date",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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.",
      "type": "dateTime"
    },
    {
      "name": "abstract",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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). If false (which is the default value), then only concrete codes as defined by the value set are allowed",
      "type": "boolean"
    },
    {
      "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": "result",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "True if the concept details supplied are valid",
      "type": "boolean"
    },
    {
      "name": "message",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and warnings",
      "type": "string"
    },
    {
      "name": "display",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "A valid display for the concept if the system wishes to display this to a user",
      "type": "string"
    }
  ]
}