Operation-valueset-batch.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ValueSet-batch"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/ValueSet-batch"/>
  <name value="Batch Mode Validation"/>
  <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 a set of concepts against value sets in a single oeration  Typically, this would
   be called when a validating a resource or document that contains many codes, to reduce
   network latency events"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <kind value="operation"/>
  <code value="batch"/>
  <system value="false"/>
  <type value="ValueSet"/>
  <instance value="false"/>
  <parameter>
    <name value="item"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="An item to be validated"/>
    <part>
      <name value="concept"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="A codeable concept to be validated. If the source is a coding, or a code/system pair,
       wrap it in a CodeableConcept"/>
      <type value="CodeableConcept"/>
    </part>
    <part>
      <name value="uri"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The value set to validate the concept against. This is a logical value set identifier
       (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly
       in the server's valuesets, or it is defined implicitly by some code system known to the
       server"/>
      <type value="uri"/>
    </part>
  </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="item"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="The outcome of validating an item. There must be an entry for every item in the same order"/>
    <part>
      <name value="result"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="True if the concept details supplied are valid"/>
      <type value="boolean"/>
    </part>
    <part>
      <name value="message"/>
      <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 wanrings"/>
      <type value="string"/>
    </part>
    <part>
      <name value="display"/>
      <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"/>
    </part>
  </parameter>
</OperationDefinition>