STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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

Codesystem-restful-interaction

This is the narrative for the resource. See also the XML or JSON format. This example conforms to the profile CodeSystem.

FHIR Restful Interactions

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

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

LvlCodeDisplayDefinition
1read readRead the current state of the resource.
1vread vreadRead the state of a specific version of the resource.
1update updateUpdate an existing resource by its id (or create it if it is new).
1delete deleteDelete a resource.
1history historyRetrieve the change history for a particular resource, type of resource, or the entire system.
2  history-instance history-instanceRetrieve the change history for a particular resource.
2  history-type history-typeRetrieve the change history for a all resources of a particular type.
2  history-system history-systemRetrieve the change history for all resources on a system.
1create createCreate a new resource with a server assigned id.
1search searchSearch a resource type or all resources based on some filter criteria.
2  search-type search-typeSearch all resources of the specified type based on some filter criteria.
2  search-system search-systemSearch all resources based on some filter criteria.
1conformance conformanceGet a conformance statement for the system.
1transaction transactionUpdate, create or delete a set of resources as a single transaction.
1batch batchperform a set of a separate interactions in a single http operation
1operation operationPerform an operation as defined by an OperationDefinition.

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.