Skip to main content

Delete a document

DELETE /document/{id}
devhttps://api.sandbox.ovok.com

Delete document

Deletes a document and its associated file from the system.

Parameters

ParameterInDescriptionExample
idpathThe id of the DocumentReference resource to delete023f2f-

Response

{
"message": "Document deleted successfully"
}

Note: This operation will permanently delete both the DocumentReference metadata and the associated binary file from S3. This action cannot be undone.

Parameters

NameInTypeRequiredDescription
idpathstringyesFHIR DocumentReference id of the document to delete. Removes the underlying binary and the reference resource.

Responses

CodeDescription
200Success.
400The request could not be operated by the server.
401The resource owner or authorization server denied the request.
404The requested resource could not be found.
422The request could not be validated by the server.
500The server encountered an unexpected condition. Please try again later.

200DocumentDeletedResponseDto (application/json)

Document deletion acknowledgement.

  • message: string (required)