Cancel result (Transaction ERESULT-21)
General
This service a for deleting a service that shouldn't have been sent to the eResult in its current state.
Business notes
Rules
- A result sent can only cancel once, if consumer try to cancel one more than once - il will fail
Impact on resources
A result cancellation will impact FHIR resources as follow:
- Resource DiagnosticReport => Status "Cancelled"
- Resource Communication => Status "Stopped" ou "Enterred-in-error" -- See below for more details
Depending if result has been sent to its recipient (status == "completed"), the resulting status of a cancellation will be different:
- If a result has not been read(received) by its recipient, That is Communication has "status== in-progress", then the status of the Communication will become: "status== stopped"
- If a result has been read(received) by its recipient, That is Communication has "status== completed", then the status of the Communication will become: "entered-in-error" This distinction status may be used later to Communicate cancellation to a recipient that would have already read a result later cancelled
Input
For Security reason, URL (Base and Query parameter), Authentification mechanism are supplied privately documentation supplied by Agence eSanté to each integrator
This service has no body.
Output
Success
In case of success, the API will returned:
- A HTTP Code 200
- a Bundle with type transaction-response.
Each entry of the Bundle contain a 'response' containing itself a:
- A status which is "200 OK"
- Location (Id of the updated ressource. ie: "Communication/8286d34f-f5bd-416a-bd12-7773cb3592ce/_history/2"
- An OperationOutcome indicating that this is successfull
Full example can be found [here] (https://simplifier.net/eprescriptionlux/6b528d9e-c692-4b11-9407-b137f4005625)
Error
In case of error, an OperationOutcome will be returned. See Error Handling for more information.
Main errors related to this service are:
| HTTP Code | eResult error code | Description |
|---|---|---|
| 404 | ERESULT_0201 | Consumer try to cancel result that doesn't exist |
| 409 | ERESULT_0202 | Consumer try to cancel an already cancelled result |