Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Using Codes Code Systems Value Sets Concept Maps Identifier Systems

4.3.14.24 4.3.2.17 Code System CodeSystem http://hl7.org/fhir/restful-interaction

FHIR Infrastructure icon Work Group   Maturity Level : N Normative (from v4.0.0) Use Context : Any Country: World
This page has been approved as part of an ANSI
  • Narrative standard. See the Conformance Package for further details. This is a code system defined by the FHIR project. Summary
  • Defining URL: XML http://hl7.org/fhir/restful-interaction
  • Version: JSON 4.3.0
  • Name: TTL FHIR Restful Interactions
Committee:
Official URL : Title: http://hl7.org/fhir/restful-interaction Definition: The set of interactions defined by the RESTful part of the FHIR specification. Version : 5.0.0-draft-final
active as of 2023-03-01 FHIR Infrastructure Computable Name : FHIRRestfulInteractions Work Group
OID: Flags : CaseSensitive, Complete. All codes ValueSet: http://hl7.org/fhir/ValueSet/restful-interaction (for OID based terminology systems) Source Resource XML / JSON : 2.16.840.1.113883.4.642.4.1823

This Code system is used in the following value sets:

4.3.14.24.2 4.3.2.17.1 FHIR Restful Interactions Definition

The set of interactions defined by the RESTful part of the FHIR specification.

4.3.2.17.2 Content

This code system http://hl7.org/fhir/restful-interaction defines the following codes:

read vread update patch delete history history-instance history-type history-system create search search-type capabilities transaction batch operation
Lvl Code Display Definition Definition Copy
1 read Read the current state of the resource. btn   btn
1 vread Read the state of a specific version of the resource. btn   btn
1 update Update an existing resource by its id (or create it if it is new). btn   btn
1 patch Update an existing resource by posting a set of changes to it. btn   btn
1 delete Delete a resource. btn   btn
1 history Retrieve the change history for a particular resource, type of resource, or the entire system. btn   btn
2   history-instance Retrieve the change history for a particular resource. btn   btn
2   history-type Retrieve the change history for all resources of a particular type. btn   btn
2   history-system Retrieve the change history for all resources on a system. btn   btn
1 create Create a new resource with a server assigned id. btn   btn
1 search Search a resource type or all resources based on some filter criteria. btn   btn
2   search-type Search all resources of the specified type based on some filter criteria. btn   btn
2   search-system search-system Search all resources based on some filter criteria. btn   btn
2   search-compartment Search all resources in a compartment based on some filter criteria. btn   btn
1 capabilities Get a Capability Statement for the system. btn   btn
1 transaction Update, create or delete a set of resources as a single transaction. btn   btn
1 batch perform a set of a separate interactions in a single http operation btn   btn
1 operation Perform an operation as defined by an OperationDefinition. btn   btn

 

See the full registry of code systems defined as part of FHIR.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information.
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code