FHIR Cross-Version Extensions package for FHIR R4B from FHIR R4
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4B from FHIR R4 - Version 0.0.1-snapshot-2. See the Directory of published versions

: FHIR Restful Interactions - XML Representation

Page standards status: Normative Maturity Level: 5

Raw xml | Download


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="restful-interaction"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CodeSystem restful-interaction</b></p><a name="restful-interaction"> </a><a name="hcrestful-interaction"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/restful-interaction</code> defines the following codes in a Is-A hierarchy:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style="white-space:nowrap">read<a name="restful-interaction-read"> </a></td><td>Read the current state of the resource.</td></tr><tr><td>1</td><td style="white-space:nowrap">vread<a name="restful-interaction-vread"> </a></td><td>Read the state of a specific version of the resource.</td></tr><tr><td>1</td><td style="white-space:nowrap">update<a name="restful-interaction-update"> </a></td><td>Update an existing resource by its id (or create it if it is new).</td></tr><tr><td>1</td><td style="white-space:nowrap">patch<a name="restful-interaction-patch"> </a></td><td>Update an existing resource by posting a set of changes to it.</td></tr><tr><td>1</td><td style="white-space:nowrap">delete<a name="restful-interaction-delete"> </a></td><td>Delete a resource.</td></tr><tr><td>1</td><td style="white-space:nowrap">history<a name="restful-interaction-history"> </a></td><td>Retrieve the change history for a particular resource, type of resource, or the entire system.</td></tr><tr><td>2</td><td style="white-space:nowrap">  history-instance<a name="restful-interaction-history-instance"> </a></td><td>Retrieve the change history for a particular resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  history-type<a name="restful-interaction-history-type"> </a></td><td>Retrieve the change history for all resources of a particular type.</td></tr><tr><td>2</td><td style="white-space:nowrap">  history-system<a name="restful-interaction-history-system"> </a></td><td>Retrieve the change history for all resources on a system.</td></tr><tr><td>1</td><td style="white-space:nowrap">create<a name="restful-interaction-create"> </a></td><td>Create a new resource with a server assigned id.</td></tr><tr><td>1</td><td style="white-space:nowrap">search<a name="restful-interaction-search"> </a></td><td>Search a resource type or all resources based on some filter criteria.</td></tr><tr><td>2</td><td style="white-space:nowrap">  search-type<a name="restful-interaction-search-type"> </a></td><td>Search all resources of the specified type based on some filter criteria.</td></tr><tr><td>2</td><td style="white-space:nowrap">  search-system<a name="restful-interaction-search-system"> </a></td><td>Search all resources based on some filter criteria.</td></tr><tr><td>1</td><td style="white-space:nowrap">capabilities<a name="restful-interaction-capabilities"> </a></td><td>Get a Capability Statement for the system.</td></tr><tr><td>1</td><td style="white-space:nowrap">transaction<a name="restful-interaction-transaction"> </a></td><td>Update, create or delete a set of resources as a single transaction.</td></tr><tr><td>1</td><td style="white-space:nowrap">batch<a name="restful-interaction-batch"> </a></td><td>perform a set of a separate interactions in a single http operation</td></tr><tr><td>1</td><td style="white-space:nowrap">operation<a name="restful-interaction-operation"> </a></td><td>Perform an operation as defined by an OperationDefinition.</td></tr></table></div>
  </text>
  <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>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/package-source">
    <extension url="packageId">
      <valueId value="hl7.fhir.uv.xver-r4.r4b"/>
    </extension>
    <extension url="version">
      <valueString value="0.0.1-snapshot-2"/>
    </extension>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <url value="http://hl7.org/fhir/restful-interaction"/>
  <version value="4.0.1"/>
  <name value="FHIR Restful Interactions"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2025-09-13T16:11:23-04:00"/>
  <publisher value="FHIR Infrastructure"/>
  <contact>
    <name value="FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="The set of interactions defined by the RESTful part of the FHIR specification."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/restful-interaction"/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <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="patch"/>
    <display value="patch"/>
    <definition
                value="Update an existing resource 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="history"/>
    <display value="history"/>
    <definition
                value="Retrieve the change 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 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="search"/>
    <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="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>