Invoice — new field clinicalPathway

Summary

The GraphQL type Invoice now exposes a read-only field clinicalPathway of type ClinicalPathway, providing direct access to the clinical pathway linked to an invoice — including episodeId and metadata (e.g. policy number, authorisation code). Returns null when no pathway is linked.

Previously, retrieving the pathway associated with an invoice required iterating all pathways for a patient and matching by assigned objects. This field is now available directly on the invoice.

Query example

query InvoicePathway($invoiceId: ID!) {
  invoice(id: $invoiceId) {
    id
    clinicalPathway {
      id
      episodeId
      metadata {
        key
        value
      }
    }
  }
}

Integration guidance

• clinicalPathway { id } for just the reference: If you only need the pathway ID (e.g. for a foreign-key join), request clinicalPathway { id } to keep the response lightweight.
• Full context: Request additional fields like episodeId, metadata, status when you need pathway-level data in the same call as the invoice.
• Nullable: clinicalPathway returns null when the invoice is not linked to a pathway. Check for null before accessing nested fields.

Migration

This release is additive. Existing invoice and invoices clients do not need to change.