Operation-valueset-validate-code.xml

Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ValueSet-validate-code"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Value Set based Validation</h2> 
      <p> OPERATION: Value Set based Validation</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code</pre> 
      <div> 
        <p> Validate that a coded value is in the set of codes allowed by a value set.</p> 

        <p> If the operation is not called at the instance level, one of the in parameters url, context
           or  valueSet must be provided.  One (and only one) of the in parameters code, coding,
           or codeableConcept must be provided.  The operation returns a result (true / false), an
           error message, and the recommended display for the code</p> 

      </div> 
      <p> URL: [base]/ValueSet/$validate-code</p> 
      <p> URL: [base]/ValueSet/[id]/$validate-code</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> url</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#uri">uri</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> context</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#uri">uri</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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-hspc
                height#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 conformance registry that
                 the server is using, but can be used to delegate the mapping from an application context
                 to a binding at run-time</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> valueSet</td> 
          <td> 0..1</td> 
          <td> 
            <a href="valueset.html">ValueSet</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> valueSetVersion</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The identifier that is used to identify a specific version of the value set to be used
                 when validating the code. This is an arbitrary value managed by the value set author and
                 is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd)
                 if a managed version is not available.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> code</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The code that is to be validated. If a code is provided, a system or a context must be
                 provided (if a context is provided, then the server SHALL ensure that the code is not
                 ambiguous without a system)</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> system</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#uri">uri</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The system for the code that is to be validated</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> systemVersion</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The version of the system, if one was provided in the source data</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> display</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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 using the display parameter in the
                 outcome. Whether displays are case sensitive is code system dependent</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> coding</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#Coding">Coding</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> A coding to validate</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> codeableConcept</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#CodeableConcept">CodeableConcept</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> date</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#dateTime">dateTime</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> abstract</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> 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.</p> 

              <p> 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.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> displayLanguage</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Specifies the language to be used for description when validating the display property</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> result</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> True if the concept details supplied are valid</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> message</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Error details, if result = false. If this is provided when result = true, the message
                 carries hints and warnings</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> display</td> 
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#string">string</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> A valid display for the concept if the system wishes to display this to a user</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> Note: the correct behaviour of validation with regard to language for Coding.display items
           is currently undefined, and further development and testing may lead to specific requirements
           or recommendations in subsequent releases</p> 

      </div> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"/> 
  <version value="4.5.0"/> 
  <name value="Value Set based Validation"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2020-08-20T17:41:31+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="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 url, context
   or  valueSet must be provided.  One (and only one) of the in parameters code, coding,
   or codeableConcept must be provided.  The operation returns a result (true / false), an
   error message, and the recommended display for the code"/> 
  <code value="validate-code"/> 
  <comment value="Note: the correct behaviour of validation with regard to language for Coding.display items
   is currently undefined, and further development and testing may lead to specific requirements
   or recommendations in subsequent releases"/> 
  <resource value="ValueSet"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="url"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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 value="uri"/> 
  </parameter> 
  <parameter> 
    <name value="context"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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-hspc
    height#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 conformance 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 value="uri"/> 
  </parameter> 
  <parameter> 
    <name value="valueSet"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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 value="ValueSet"/> 
  </parameter> 
  <parameter> 
    <name value="valueSetVersion"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The identifier that is used to identify a specific version of the value set to be used
     when validating the code. This is an arbitrary value managed by the value set author and
     is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd)
     if a managed version is not available."/> 
    <type value="string"/> 
  </parameter> 
  <parameter> 
    <name value="code"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The code that is to be validated. If a code is provided, a system or a context must be
     provided (if a context is provided, then the server SHALL ensure that the code is not
     ambiguous without a system)"/> 
    <type value="code"/> 
  </parameter> 
  <parameter> 
    <name value="system"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The system for the code that is to be validated"/> 
    <type value="uri"/> 
  </parameter> 
  <parameter> 
    <name value="systemVersion"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The version of the system, if one was provided in the source data"/> 
    <type value="string"/> 
  </parameter> 
  <parameter> 
    <name value="display"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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 using the display parameter in the
     outcome. Whether displays are case sensitive is code system dependent"/> 
    <type value="string"/> 
  </parameter> 
  <parameter> 
    <name value="coding"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="A coding to validate"/> 
    <type value="Coding"/> 
  </parameter> 
  <parameter> 
    <name value="codeableConcept"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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 value="CodeableConcept"/> 
  </parameter> 
  <parameter> 
    <name value="date"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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 value="dateTime"/> 
  </parameter> 
  <parameter> 
    <name value="abstract"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="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."/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="displayLanguage"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Specifies the language to be used for description when validating the display property"/> 
    <type value="code"/> 
  </parameter> 
  <parameter> 
    <name value="result"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="True if the concept details supplied are valid"/> 
    <type value="boolean"/> 
  </parameter> 
  <parameter> 
    <name value="message"/> 
    <use value="out"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Error details, if result = false. If this is provided when result = true, the message
     carries hints and warnings"/> 
    <type value="string"/> 
  </parameter> 
  <parameter> 
    <name value="display"/> 
    <use value="out"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="A valid display for the concept if the system wishes to display this to a user"/> 
    <type value="string"/> 
  </parameter> 
</OperationDefinition>