Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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

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

FHIR Infrastructure icon Work Group Maturity Level: NNormative (from v4.0.0) Use Context: Any

This is a code system defined by the FHIR project.

Summary

Defining URL:http://hl7.org/fhir/restful-interaction
Version:5.0.0-ballot
Name:FHIR Restful Interactions
Title:
Status:active
Definition:

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

Committee:FHIR Infrastructure icon Work Group
OID:2.16.840.1.113883.4.642.4.1823 (for OID based terminology systems)
Flags:CaseSensitive, Complete
All codes ValueSet:http://hl7.org/fhir/ValueSet/restful-interaction

This Code system is used in the following value sets:

  • ValueSet: TypeRestfulInteraction (Operations supported by REST at the type or instance 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: TestScriptOperationCode (This value set defines a set of codes that are used to indicate the supported operations of a testing engine or tool.)
  • ValueSet: Interaction Trigger (FHIR RESTful interaction codes used for SubscriptionTopic trigger.)
  • ValueSet: SystemRestfulInteraction (Operations supported by REST at the system level.)

4.3.2.19.1 Content

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

LvlCodeDisplayDefinitionCopy
1read readRead the current state of the resource.btn btn
1vread vreadRead the state of a specific version of the resource.btn btn
1update updateUpdate an existing resource by its id (or create it if it is new).btn btn
1patch patchUpdate an existing resource by posting a set of changes to it.btn btn
1delete deleteDelete a resource.btn btn
1history historyRetrieve the change history for a particular resource, type of resource, or the entire system.btn btn
2  history-instance history-instanceRetrieve the change history for a particular resource.btn btn
2  history-type history-typeRetrieve the change history for all resources of a particular type.btn btn
2  history-system history-systemRetrieve the change history for all resources on a system.btn btn
1create createCreate a new resource with a server assigned id.btn btn
1search searchSearch a resource type or all resources based on some filter criteria.btn btn
2  search-type search-typeSearch all resources of the specified type based on some filter criteria.btn btn
2  search-system search-systemSearch all resources based on some filter criteria.btn btn
1capabilities capabilitiesGet a Capability Statement for the system.btn btn
1transaction transactionUpdate, create or delete a set of resources as a single transaction.btn btn
1batch batchperform a set of a separate interactions in a single http operationbtn btn
1operation operationPerform 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