Operation-resource-validate.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Resource-validate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Resource-validate"/>
  <name value="Validate a resource"/>
  <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="The validate interaction checks whether the attached content would be acceptable either
   generally, or as a create, or an update or delete to an existing resource.  The action
   the server takes depends on the mode parameter:  * [missing]: The server checks the content
   of the resource against any schema, constraint rules, and other general terminology rules
   * create: The server checks the content, and then checks that the content would be acceptable
   as a create (e.g. that the content would not validate any uniqueness constraints) * update:
   The server checks the content, and then checks that it would accept it as an update against
   the nominated specific resource (e.g. that there are no changes to immutable fields the
   server does not allow to change, and checking version integrity if appropriate) * delete:
   The server ignores the content, and checks that the nominated resource is allowed to be
   deleted (e.g. checking referential integrity rules)  Modes update and delete can only
   be used when the operation is invoked at the resource level.   The return from this operation
   is an OperationOutcome"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <kind value="operation"/>
  <code value="validate"/>
  <notes value="This operation may be used during design and development to validate application design.
   It can also be used at run-time. One possible use might be that a client asks the server
   whether a proposed update is valid as the user is editing a dialog, and displays an updated
   error to the user. The operation can be used as part of a light-weight two phase commit
   protocol but there is no expectation that the server will hold the content of the resource
   after this operation is used, or that the server guarantees to succesfully perform an
   actual create, update or delete after the validation operation completes."/>
  <system value="false"/>
  <type value="Resource"/>
  <instance value="true"/>
  <parameter>
    <name value="resource"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Must be present unles the mode is &quot;delete&quot;"/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="mode"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Default is 'no action; (e.g. general validation)"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="profile"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="If this is nominated, then the resource is validated against this specific profile. If
     a profile is nominated, and the server cannot validate agsinst the nominated profile,
     it SHALL return an error"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="If the operation outcome does not list any errors, and a mode was specified, then this
     is an indication that the operation would be expected to succeed (excepting for transactional
     integrity issues, see below)"/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>