Operation $purge on Patient

CAUTION

The operation $purge on patient is currently alpha and has to be enabled explicitly by setting the env var ENABLE_OPERATION_PATIENT_PURGE to true. Please don't use it in production. Please be aware that the database might not be able to migrate to a newer version of Blaze if the operation was used.

CAUTION

The operation $purge on patient is trial use in the unreleased next version of FHIR (R6). So it is subject to change. Please use it with care.

The patient $purge operation is used to request the removal of all current and historical versions for all resources in a patient compartment. The return is an OperationOutcome with results and/or details about execution. The code of the first issue of the OperationOutcome is either success on successful purging of all resources or an error.

POST [base]/Patient/[id]/$purge

All resources in the patient compartment are marked as purged immediately. All reads which happen after the $purge operation completes, will not see any of the purged resources. Only active paging sessions and asynchronous requests started before the patient $purge operation will be able to access the purged versions for a limited amount of time.

The official documentation can be found here.