Release 5 Ballot

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

Work Group

Maturity Level: N

Normative (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 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:

Lvl	Code	Display	Definition	Copy
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:

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