FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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: 6.0.0-ballot2
active as of 2024-11-15 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:

  • 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

Generated Narrative: CodeSystem restful-interaction

Last updated: 2024-11-15T17:44:13.161Z

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

LvlCodeDefinitionCopy
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