Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.3.2.16 CodeSystem http://hl7.org/fhir/restful-interaction

FHIR Infrastructure icon Work Group Maturity Level: NNormative (from v4.0.0) Use Context: Country: World
Official URL: http://hl7.org/fhir/restful-interaction Version: 5.0.0
active as of 2023-03-26 Computable Name: FHIRRestfulInteractions
Flags: CaseSensitive, Complete. All codes ValueSet: http://hl7.org/fhir/ValueSet/restful-interaction OID: 2.16.840.1.113883.4.642.4.1823

This Code system is used in the following value sets:

  • ValueSet: Type Restful Interaction (Operations supported by REST at the type or instance level.)
  • ValueSet: System Restful Interaction (Operations supported by REST at the system level.)
  • ValueSet: Audit Event Sub-Type (More detailed code concerning the type of the audit event - defined by DICOM with some additional FHIR, HL7, and other additions.)
  • ValueSet: Interaction Trigger (FHIR RESTful interaction codes used for SubscriptionTopic trigger.)
  • ValueSet: Test Script Operation Code (This value set defines a set of codes that are used to indicate the supported operations of a testing engine or tool.)

4.3.2.16.1 Definition

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

4.3.2.16.2 Content

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

LvlCodeDefinitionCopy
1read Read the current state of the resource.btn btn
1vread Read the state of a specific version of the resource.btn btn
1update Update an existing resource by its id (or create it if it is new).btn btn
1patch Update an existing resource by posting a set of changes to it.btn btn
1delete Delete a resource.btn btn
1history 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
1create Create a new resource with a server assigned id.btn btn
1search 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 all resources based on some filter criteria.btn btn
2  search-compartment Search resources in a compartment based on some filter criteria.btn btn
1capabilities Get a Capability Statement for the system.btn btn
1transaction Update, create or delete a set of resources as a single transaction.btn btn
1batch perform a set of a separate interactions in a single http operationbtn btn
1operation 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:

LevelA few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information.
SourceThe source of the definition of the code (when the value set draws in codes defined elsewhere)
CodeThe code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
DisplayThe 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
DefinitionAn explanation of the meaning of the concept
CommentsAdditional notes about how to use the code