Diagnostic test canceled
Sent when a diagnostic test has been canceled.
Sent when a diagnostic test has been canceled.
All webhook requests include the shared webhook headers.
Request Body
application/json
Webhook payload.
TypeScript Definitions
Use the request body type in TypeScript.
IRI of the parent diagnostic order.
IRI of the DiagnosticProduct that was ordered for this test.
IRIs of linked test results, sorted by `createdAt`. In most patient-facing use cases, the most recent test result is the relevant one. Older results are included for transparency and historical records.
Allowed values: "M", "F", "D", "X"
Allowed values: "GKV", "PKV", null
The insurer assigned ID for the Subscriber.
Allowed values: "DHL", "Swiss Post", "OTHER"
Timestamp when the shipment was created.
Timestamp when the shipment was last updated.
Normalized shipment status for informational purposes only.
Allowed values: "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null
Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.
Raw shipment history from the provider.
Timestamp when the patient activated the TestKit.
Timestamp when the specimen arrived in the laboratory.
IRI of the diagnostic test that replaced this test, when it was replaced.
IRI of the diagnostic test this test replaces, when applicable.
Timestamp when the diagnostic test was canceled.
Timestamp when the diagnostic test was completed.
Timestamp when the DiagnosticTest was created.
Response Body
Example Requests
/diagnostic_tests/canceled