type: codesystemcodesystem: restful-interaction

FHIR Restful Interactions

Official URL: http://hl7.org/fhir/restful-interaction
Status: active
Name: FHIRRestfulInteractions
Title: FHIR Restful Interactions
Publisher: FHIR Project
Description: The set of interactions defined by the RESTful part of the FHIR specification.
Case Sensitive: true
Content: complete

Concepts

Code	Display	Definition
read	read	Read the current state of the resource.
vread	vread	Read the state of a specific version of the resource.
update	update	Update an existing resource by its id (or create it if it is new).
update-conditional	update-conditional	Update an existing resource based on some identification criteria (or create it if it is new).
patch	patch	Update an existing resource by posting a set of changes to it.
patch-conditional	patch-conditional	Update an existing resource, based on some identification criteria, by posting a set of changes to it.
delete	delete	Delete a resource.
delete-conditional-single	delete-conditional-single	Delete a single resource based on some identification criteria.
delete-conditional-multiple	delete-conditional-multiple	Delete one or more resources based on some identification criteria.
delete-history	delete-history	Delete all historical versions of a resource.
delete-history-version	delete-history-version	Delete a specific version of a resource.
history	history	Retrieve the change history for a particular resource, type of resource, or the entire system.
create	create	Create a new resource with a server assigned id.
create-conditional	create-conditional	Create a new resource with a server assigned id if an equivalent resource does not already exist.
search	search	Search a resource type or all resources based on some filter criteria.
capabilities	capabilities	Get a Capability Statement for the system.
transaction	transaction	Update, create or delete a set of resources as a single transaction.
batch	batch	perform a set of a separate interactions in a single http operation
operation	operation	Perform an operation as defined by an OperationDefinition.

CodeSystem XML

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="restful-interaction"/>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/>
  </extension>
  <url value="http://hl7.org/fhir/restful-interaction"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.4.1823"/>
  </identifier>
  <name value="FHIRRestfulInteractions"/>
  <title value="FHIR Restful Interactions"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="FHIR Project"/>
  <description value="The set of interactions defined by the RESTful part of the FHIR specification."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/restful-interaction"/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <property>
    <code value="abstract"/>
    <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>
    <type value="boolean"/>
  </property>
  <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="update-conditional"/>
    <display value="update-conditional"/>
    <definition value="Update an existing resource based on some identification criteria (or create it if it is new)."/>
  </concept>
  <concept>
    <code value="patch"/>
    <display value="patch"/>
    <definition value="Update an existing resource by posting a set of changes to it."/>
  </concept>
  <concept>
    <code value="patch-conditional"/>
    <display value="patch-conditional"/>
    <definition value="Update an existing resource, based on some identification criteria, by posting a set of changes to it."/>
  </concept>
  <concept>
    <code value="delete"/>
    <display value="delete"/>
    <definition value="Delete a resource."/>
  </concept>
  <concept>
    <code value="delete-conditional-single"/>
    <display value="delete-conditional-single"/>
    <definition value="Delete a single resource based on some identification criteria."/>
  </concept>
  <concept>
    <code value="delete-conditional-multiple"/>
    <display value="delete-conditional-multiple"/>
    <definition value="Delete one or more resources based on some identification criteria."/>
  </concept>
  <concept>
    <code value="delete-history"/>
    <display value="delete-history"/>
    <definition value="Delete all historical versions of a resource."/>
  </concept>
  <concept>
    <code value="delete-history-version"/>
    <display value="delete-history-version"/>
    <definition value="Delete a specific version of a resource."/>
  </concept>
  <concept>
    <code value="history"/>
    <display value="history"/>
    <definition value="Retrieve the change history for a particular resource, type of resource, or the entire system."/>
    <property>
      <code value="abstract"/>
      <valueBoolean value="true"/>
    </property>
    <concept>
      <code value="history-instance"/>
      <display value="history-instance"/>
      <definition value="Retrieve the change history for a particular resource."/>
    </concept>
    <concept>
      <code value="history-type"/>
      <display value="history-type"/>
      <definition value="Retrieve the change history for all resources of a particular type."/>
    </concept>
    <concept>
      <code value="history-system"/>
      <display value="history-system"/>
      <definition value="Retrieve the change 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="create-conditional"/>
    <display value="create-conditional"/>
    <definition value="Create a new resource with a server assigned id if an equivalent resource does not already exist."/>
  </concept>
  <concept>
    <code value="search"/>
    <display value="search"/>
    <definition value="Search a resource type or all resources based on some filter criteria."/>
    <property>
      <code value="abstract"/>
      <valueBoolean value="true"/>
    </property>
    <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>
      <code value="search-compartment"/>
      <display value="search-compartment"/>
      <definition value="Search resources in a compartment based on some filter criteria."/>
    </concept>
  </concept>
  <concept>
    <code value="capabilities"/>
    <display value="capabilities"/>
    <definition value="Get a Capability 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="batch"/>
    <display value="batch"/>
    <definition value="perform a set of a separate interactions in a single http operation"/>
  </concept>
  <concept>
    <code value="operation"/>
    <display value="operation"/>
    <definition value="Perform an operation as defined by an OperationDefinition."/>
  </concept>
</CodeSystem>