This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

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

FHIR Infrastructure Work Group

Maturity Level: N

Normative (from v4.0.0)

Use Context: Country: World

• Narrative
• XML
• JSON
• TTL

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.17.1 Definition

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

4.3.2.17.2 Content

This case-sensitive code system http://hl7.org/fhir/restful-interaction defines the following codes in a Is-A heirarchy:

Lvl	Code	Definition	Copy
1	read	Read the current state of the resource.
1	vread	Read the state of a specific version of the resource.
1	update	Update an existing resource by its id (or create it if it is new).
1	update-conditional	Update an existing resource based on some identification criteria (or create it if it is new).
1	patch	Update an existing resource by posting a set of changes to it.
1	patch-conditional	Update an existing resource, based on some identification criteria, by posting a set of changes to it.
1	delete	Delete a resource.
1	delete-conditional-single	Delete a single resource based on some identification criteria.
1	delete-conditional-multiple	Delete one or more resources based on some identification criteria.
1	delete-history	Delete all historical versions of a resource.
1	delete-history-version	Delete a specific version of a resource.
1	history	Retrieve the change history for a particular resource, type of resource, or the entire system.
2	history-instance	Retrieve the change history for a particular resource.
2	history-type	Retrieve the change history for all resources of a particular type.
2	history-system	Retrieve the change history for all resources on a system.
1	create	Create a new resource with a server assigned id.
1	create-conditional	Create a new resource with a server assigned id if an equivalent resource does not already exist.
1	search	Search a resource type or all resources based on some filter criteria.
2	search-type	Search all resources of the specified type based on some filter criteria.
2	search-system	Search all resources based on some filter criteria.
2	search-compartment	Search resources in a compartment based on some filter criteria.
1	capabilities	Get a Capability Statement for the system.
1	transaction	Update, create or delete a set of resources as a single transaction.
1	batch	perform a set of a separate interactions in a single http operation
1	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: