2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Valueset-restful-interaction.xml

Raw XML (canonical form)

The set of interactions defined by the RESTful part of the FHIR specification (id = "valueset-restful-interaction")

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="valueset-restful-interaction"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/vs/restful-interaction"/>
  <name value="FHIR Restful Interactions"/>
  <publisher value="FHIR Project"/>
  <description value="The set of interactions defined by the RESTful part of the FHIR specification"/>
  <status value="draft"/>
  <define>
    <system value="http://hl7.org/fhir/restful-interaction"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="read"/>
      <display value="read"/>
      <definition value="Read the current state of the resource"/>
    </concept>
    <concept>
      <code value="vread"/>
      <display value="vread"/>
      <definition value="Read the state of a specific version of the resource"/>
    </concept>
    <concept>
      <code value="update"/>
      <display value="update"/>
      <definition value="Update an existing resource by its id (or create it if it is new)"/>
    </concept>
    <concept>
      <code value="delete"/>
      <display value="delete"/>
      <definition value="Delete a resource"/>
    </concept>
    <concept>
      <code value="history"/>
      <abstract value="false"/>
      <display value="history"/>
      <definition value="Retrieve the update history for a particular resource, type of resource, or the entire
       system"/>
      <concept>
        <code value="history-instance"/>
        <display value="history-instance"/>
        <definition value="Retrieve the update history for a particular resource"/>
      </concept>
      <concept>
        <code value="history-type"/>
        <display value="history-type"/>
        <definition value="Retrieve the update history for a all resources of a particular type"/>
      </concept>
      <concept>
        <code value="history-system"/>
        <display value="history-system"/>
        <definition value="Retrieve the update history for all resources on a system"/>
      </concept>
    </concept>
    <concept>
      <code value="create"/>
      <display value="create"/>
      <definition value="Create a new resource with a server assigned id"/>
    </concept>
    <concept>
      <code value="search"/>
      <abstract value="false"/>
      <display value="search"/>
      <definition value="Search a resource type or all resources based on some filter criteria"/>
      <concept>
        <code value="search-type"/>
        <display value="search-type"/>
        <definition value="Search all resources of the specified type based on some filter criteria"/>
      </concept>
      <concept>
        <code value="search-system"/>
        <display value="search-system"/>
        <definition value="Search all resources based on some filter criteria"/>
      </concept>
    </concept>
    <concept>
      <code value="validate"/>
      <display value="validate"/>
      <definition value="Check that the content would be acceptable as an update"/>
    </concept>
    <concept>
      <code value="conformance"/>
      <display value="conformance"/>
      <definition value="Get a conformance statement for the system"/>
    </concept>
    <concept>
      <code value="transaction"/>
      <display value="transaction"/>
      <definition value="Update, create or delete a set of resources as a single transaction"/>
    </concept>
    <concept>
      <code value="operation"/>
      <display value="operation"/>
      <definition value="Perform an operation as defined by an OperationDefinition"/>
    </concept>
  </define>
</ValueSet>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.