Skip to main content

Changelog

2026-08-31​

  • Rate limiting is now enforced. Rate Limiting previously noted there was no fixed per-minute cap. The API now applies per-minute and per-day limits, counted per practitioner credential (not pooled across your partner account). Requests over a limit receive 429 Too Many Requests with a Retry-After header. See the page for the per-endpoint figures.

2026-08-12​

  • Removed allowIscreenInvoiceNotification from the Patient endpoints. It was added on 2026-08-06 and has since been withdrawn: suppressing the email removed the patient's only notification of an invoice, leaving them no way to pay it. i-screen now always sends the invoice payment-link email. The field is ignored if you send it, so no action is needed on your side.

2026-08-06​

  • Add allowIscreenInvoiceNotification to Patient endpoints (defaults to true). Set to false to suppress the invoice payment-link email on POST /invoices if you're sending your own branded version instead. Note there was never a separate email on settlement, only the practitioner is notified then, so this one flag covers the full invoice email lifecycle for the patient.
  • Clarify that Request form is ready and Results are ready fire once per test, while Invoice settled notification and Order ready notification fire once per order/invoice, consolidating every test inside it.
  • Correct Invoice settled notification: this fires for invoices created via POST /invoices too, once the patient pays. Previously implied it only applied to practitioner-portal-created invoices.
  • Add collectedDate attribute to Get a single test and Get multiple tests endpoints — the date the sample was collected, distinct from result.availableDate (results release) and resultsDueDate (estimated turnaround).
  • Add POST /patients/link-requests/:linkRequestId/simulate-approval trigger (staging only) to approve a link request without requiring the patient to click the email link, mirroring the existing settle/results triggers.
  • Document the 404 response from POST /patients/link-requests when no i-screen account exists at all for the given email.
  • Add Rate Limiting and expand Authentication with token format and rotation guidance.
  • Clarify exactly which patient-facing email each notification flag gates: allowIscreenPathologyFormNotification only affects the request-form email on directly purchased orders; it does not affect the invoice payment-link email, which is never suppressible since the patient needs it to pay.

2026-08-05​

  • Add type field to every webhook payload (results-ready, form-ready, patient-link-request-approved; invoice-settled and order-ready already had it). If you point more than one webhookUri.* field at a single receiving endpoint, use type to dispatch instead of inspecting payload shape.

2026-08-04​

  • GET /patients/link-requests now supports skip/limit pagination (response now returns {total, limit, skip, data}) and validates the status filter against pending/approved/expired.
  • Add 409 Conflict response to Create a new patient for an email that already belongs to an existing i-screen account, with a data.reason discriminator (PATIENT_ALREADY_LINKED or PATIENT_EXISTS_CONSENT_REQUIRED).
  • Add Patient link requests endpoints (POST /patients/link-requests, GET /patients/link-requests, GET /patients/link-requests/:linkRequestId) to request a patient's consent to connect an existing i-screen account to your practitioner.
  • Add Patient link request approved webhook.

2026-04-23​

  • Add patientId attribute to Results are ready webhook payload.

2025-11-05​

  • Add result.segments.observations.sign attribute to Get a single test endpoint.

2025-07-24​

  • Add accreditationBody and accreditationNumber to Practitioner endpoints.
  • Deprecate ahpraNo in Practitioner endpoints.

2025-04-30​

  • Add DNA results example.

2024-09-26​

  • Add testTypeSchema attribute to Product endpoints (health-check).

2024-05-31​

  • Add requestForm attribute to Product endpoints.

2024-04-30​

  • Add Payment Methods endpoints.
  • Add Orders (Direct Purchases) endpoints.
  • Add Order ready notification webhook.
  • Add tests attribute to Get a single invoice endpoint.

2024-04-18​

  • Add invoiceNumber attribute to Test endpoints.

2023-12-13​

  • Add summary.desirable and summary.abnormal attributes to Get multiple tests when status is results-available.

2023-06-27​

  • Add allowIscreenPathologyFormNotification and allowIscreenResultsNotification to Patient endpoints.

2023-06-23​

  • Add Invoice settled notification webhook.

2023-04-30​

  • Add instructions and testTypes attributes to Product endpoints (health checks only).

2022-11-21​

  • Add phone and address attributes to Practitioner endpoints.

2022-09-20​

  • Add testKit attribute to Product endpoints.

2022-05-03​

  • Remove companyName from Patch current practitioner. Contact i-screen to change practitioner name.

2022-04-27​

  • Populate test result with dummy values and attachments on Results are ready webhook.

2022-04-26​

  • Add result attribute to Get a test.
  • Update Results are ready webhook payload.
  • Fix Request form is ready webhook payload example.

2022-04-18​

  • Add Trigger: Settle Invoice endpoint.
  • Add Trigger: Results Are Ready endpoint.
  • Update webhook payload arguments.

2022-03-30​

  • Change amount type from string to number in Invoice endpoints.
  • Update Create an invoice section.

2022-03-29​

  • Add Products endpoints.

2022-03-23​

  • Add request and response examples to Patch a patient.
  • Add status query parameter to Get multiple tests.
  • Add status query parameter to Get multiple invoices.

2022-03-22​

  • Staging environment is now live.
  • Change authentication type to Bearer.
  • Add Results are ready webhook.
  • Change date format to dd/MM/YYYY.

2022-03-12​

  • Initial API draft.