This page is part of the Da Vinci Clinical Documentation Exchange (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
Push (POST and PUT)
Information Exchange Interaction Description
The Push (POST and PUT) information exchange interaction is a RESTful option for FHIR APIs. It uses POST and PUT mechanisms to create and update information through a FHIR API. A system acting as the Information Client POSTs or PUTs information onto a system acting as an Information Server using the FHIR API on the Information Server.
Actor Descriptions
Information Client
The Information Client initiates a transaction to store (create) or modify (update) information on the Information Server.
Information Server
The Information Server accepts the information provided by the Information Client.
Actor Interaction Diagram
|
Processing Steps
Preconditions
An Information Client has health record Information and wants to supply it via an Information Server with a FHIR API that allows information from the Information Client to be pushed directly to the server.
The Information Server adheres to business rules that govern which Information Clients can push information to the server.
The Information Client is authorized to create new or update information onto the Information Server.
A secure information transport mechanism exists between the Information Sender and all Information Recipients (https)
Trigger
Something in the Information Client’s workflow happens which causes the need to share new or updated information with an external system.
Main Flow
A POST or PUT is made by the Information Client to the Information Server to store provided health record information.
Post Conditions
Information Server receives health record information that the Information Client provided.
If the Information Client was not authorized to POST/PUT information on the Information Server, an error condition resulted.
If the Patient Resource associated with the information was not appropriate to be shared with the Information Server, an error condition resulted and subsequent action was taken by the Information Server to delete the information that was PUT/POSTed.
If the type of information provided was not permitted to be received (based on the business rules of the Information Server), an error condition resulted and the information was deleted.
HRex Detailed Description
For a more detailed description of the Push (POST and PUT) Interaction, consult the HRex implementation guide.
