Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). 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.16 4.3.2.17 CodeSystem http://hl7.org/fhir/restful-interaction

FHIR Infrastructure icon Work Group   Maturity Level : N Normative (from v4.0.0) Use Context : Country: World
Official URL : http://hl7.org/fhir/restful-interaction Version : 5.0.0 6.0.0-ballot2
active as of 2023-03-26 2024-08-12 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:

4.3.2.16.1 4.3.2.17.1 Definition

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

4.3.2.16.2 4.3.2.17.2 Content

Generated Narrative: CodeSystem restful-interaction

Last updated: 2024-08-12T16:52:12.437+08:00

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

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

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