Event schemas

The following describes the properties available to include in the JSON schemas for events related to ORDERS

{
  "eventType": "ORDER.CREATED",
  "version": "1",
  "orderNumber": "XXXX",
  "email" : "[email protected]",
  "shippingAddress": "1st line of address with city, country and post/zip code. maybe state as well",
  "productCode": "XXXX"
}

{
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "email" : "[email protected]",
  "eventType": "ORDER.DISPATCHED",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "trackingUrl" : "https://example.com?trackingId=<unique parcel reference>",
  "version": "1"
}

{
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "email" : "[email protected]",
  "eventType": "ORDER.OUT_FOR_DELIVERY",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "trackingUrl" : "https://example.com?trackingId=<unique parcel reference>",
  "version": "1"
}

{
  "dispatchedAt": "2022-03-07T16:13:42.345Z",
  "email" : "[email protected]",
  "eventType": "ORDER.RECEIVED",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "trackingUrl" : "https://example.com?trackingId=<unique parcel reference>",
  "version": "1"
}

The following describes the properties available to include in the JSON schemas for events related to PHLEBOTOMY

{
  "eventType": "PHLEBOTOMY.NURSE_ASSIGNED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "partnerUserId" : "XXXX",
  "productCode": "XXXX",
  "version": "1"
}

{
  "eventType": "PHLEBOTOMY.APPOINTMENT_SCHEDULED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "partnerUserId" : "XXXX",
  "productCode": "XXXX",
  "scheduledDate": "2022-03-07T16:13:42.345Z",
  "version": "1"
}

{
  "chargeable": true,
  "eventType": "PHLEBOTOMY.APPOINTMENT_RESCHEDULED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "partnerUserId" : "XXXX",
  "productCode": "XXXX",
  "scheduledDate": "2022-03-07T16:13:42.345Z",
  "version": "1"
}

{
  "cancellationDate": "2022-03-07T16:13:42.345Z",
  "chargeable": false,
  "eventType": "PHLEBOTOMY.APPOINTMENT_CANCELLED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "partnerUserId" : "XXXX",
  "productCode": "XXXX",
  "version": "1"
}

The following describes the properties available to include in the JSON schemas for events related to TESTS

{
  "email": "[email protected]",
  "eventType": "TEST.REGISTERED",
  "firstName": "John",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "testTitle": "Example test",
  "version": "1"
}

{
  "eventType": "TEST.LAB_ACCESSIONED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "partnerUserId" : "XXXX",
  "testId": "620ce889de8cf1cbe9c370e11",
  "version": "1"
}

{
  "eventType": "TEST.PROCESSED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "partnerUserId" : "XXXX",
  "testId": "620ce889de8cf1cbe9c370e11",
  "version": "1"
}

{
  "eventType": "TEST.CLINICAL_COMMENTARY_UPLOADED",
  "kitId": "FRXXX",
  "orderNumber": "XXXX",
  "productCode": "XXXX",
  "partnerUserId" : "XXXX",
  "testId": "620ce889de8cf1cbe9c370e11",
  "version": "1"
}