WildFHIR R4 Enterprise Edition Implementation Guide
1.0.0 - current International flag

WildFHIR R4 Enterprise Edition Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: AEGIS WildFHIR R4 Purge All

Official URL: http://wildfhir4.aegis.net/ig/wildfhir/OperationDefinition/wildfhir-operation-purge-all Version: 1.0.0
Active as of 2025-03-26 Computable Name: AEGISWildFHIRR4PurgeAll

This is the WildFHIR R4 Purge All operation. It provides a standardized mechanism to force a hard delete or purge of ALL FHIR resources (and their version history).

The allowed use of this operation within the AEGIS WildFHIR R4 server is controlled via a configuration setting - true, use is allowed; false, a 400 (Bad Request) with an OperationOutcome is returned.

Generated Narrative: OperationDefinition wildfhir-operation-purge-all

URL: [base]/$purge-all

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
OUTreturn1..1OperationOutcome

If successful, the operation may contain an OperationOutcome with further information about the purge results (such as warnings or information messages, such as a count of records that were purged / eliminated).

If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. reference integrity issue, security issue, or insufficient privileges).

Implemented in AEGIS WildFHIR R4 FHIR test server - http://wildfhir4.aegis.net/fhir4-0-1

Notes:

WARNING This operation purges ALL data in the WildFHIR data repository and cannot be undone. Please use with caution.

The operation does not define any IN parameters and can be invoked using the GET or POST Syntax. Any request IN parameters will be ignored.

GET [base]/$purge-all

or,

POST [base]/$purge-all

Example

Request the purge of ALL data using GET syntax

GET [base]/$purge-all
[other headers]

Request the purge of ALL data using POST syntax

POST [base]/$purge-all
[other headers]

POST request body:

N/A

Response

HTTP/1.1 200 OK
[other headers]

Response body:

    <?xml version="1.0" encoding="UTF-8"?>
    <OperationOutcome xmlns="http://hl7.org/fhir">
      <id value="parameters-purge-out-example"/>
      <text>
        <status value="additional"/>
        <div xmlns="http://www.w3.org/1999/xhtml">
          <p>Purge successfully completed</p>
        </div>
      </text>
      <issue> 
        <severity value="information"/>
        <code value="informational"/>
        <details>
          <text value="Purge successfully completed"/>
        </details>
     </issue>
    </OperationOutcome>