Release 4B Snapshot #1

This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

4.3.14.23 Code System http://hl7.org/fhir/restful-interaction

FHIR Infrastructure Work Group Maturity Level: NNormative (from v4.0.0) Use Context: Any
This page has been approved as part of an ANSI standard. See the Conformance Package for further details.

This is a code system defined by the FHIR project.

Summary

Defining URL:http://hl7.org/fhir/restful-interaction
Version:4.3.0-snapshot1
Name:FHIR Restful Interactions
Title:
Definition:

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

Committee:FHIR Infrastructure Work Group
OID: (for OID based terminology systems)
Source ResourceXML / JSON

This Code system is used in the following value sets:

  • ValueSet: TypeRestfulInteraction (Operations supported by REST at the type or instance level.)
  • ValueSet: SystemRestfulInteraction (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 FHIR specific additions.)
  • ValueSet: Interaction Trigger (FHIR RESTful interaction codes used for SubscriptionTopic trigger.)

4.3.14.23.1 Content

4.3.14.23.2 FHIR Restful Interactions

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

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

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

 

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