Probatix Documentation
Probatix Webhooks v1

Diagnostic test replaced

Sent when a diagnostic test has been replaced.

Sent when a diagnostic test has been replaced.

All webhook requests include the shared webhook headers.

Request Body

application/json

Webhook payload.

TypeScript Definitions

Use the request body type in TypeScript.

body*DiagnosticTest
id*string (uuid)
diagnosticOrder*string (iri-reference)

IRI of the parent diagnostic order.

diagnosticProduct*string (iri-reference)

IRI of the DiagnosticProduct that was ordered for this test.

testResults?array<string (iri-reference)>

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.

patient?Patient | null
email?string (email)
firstName?string | null
lastName?string | null
gender?string

Allowed values: "M", "F", "D", "X"

dateOfBirth?string (date)
healthInsuranceDetails?HealthInsuranceDetails | null
countryCode?string | null
provider?string | null
healthInsuranceTypeDE?string | null

Allowed values: "GKV", "PKV", null

subscriberIdentifier?string | null

The insurer assigned ID for the Subscriber.

specimens?array<Specimen>
shipmentTracking?ShipmentTracking | null
provider*string

Allowed values: "DHL", "Swiss Post", "OTHER"

createdAt*string (date-time)

Timestamp when the shipment was created.

updatedAt*string (date-time)

Timestamp when the shipment was last updated.

trackingCode?string | null
url?string (url)
shipmentStatus?string | null

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

providerStatus?string | null

Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.

rawProviderHistory?array | null

Raw shipment history from the provider.

activatedAt?string | null

Timestamp when the patient activated the TestKit.

labIntakeAt?string | null

Timestamp when the specimen arrived in the laboratory.

replacementDiagnosticTest?string (iri-reference)

IRI of the diagnostic test that replaced this test, when it was replaced.

replacesDiagnosticTest?string (iri-reference)

IRI of the diagnostic test this test replaces, when applicable.

canceledAt?string | null

Timestamp when the diagnostic test was canceled.

completedAt?string | null

Timestamp when the diagnostic test was completed.

createdAt*string (date-time)

Timestamp when the DiagnosticTest was created.

Response Body

Example Requests

POST/diagnostic_tests/replaced