Need sample data to uinderstand what are the fields will be shared as part of NHS CAAS (cohort as a service)

API Platform
1

Need sample data to uinderstand what are the fields will be shared as part of NHS CAAS (cohort as a service)

Cohorting as a Service (CaaS) - NHS England Digital

2

Hi,

Thank you for your patience with this query.

At present, there is no publicly available static sample dataset for Cohorting as a Service (CaaS) in the same way you might find for some other APIs.

This is mainly because:

  • CaaS operates on sensitive patient-level data
  • Outputs are cohort-specific and dynamically generated
  • Data structures can vary depending on:
    • the cohort definition
    • the requesting programme
    • the legal basis and data sharing agreements in place

CaaS is usually **FHIR-based **, so outputs are structured around standard FHIR resources rather than a flat dataset.

You will need to engage with CaaS team directly (via enquiries@nhsdigital.nhs.uk) before you can begin integration with CaaS; and you will need:

  • an NHS sponsor or programme alignment
  • a defined cohort use case
  • appropriate information governance approvals

At that point, the CaaS team can provide:

  • sample payloads
  • API specifications
  • test environment access (where available)

Hope the above helps.

Thanks,

NHS England API Platform team

Please note: The API Platform team can only address queries relevant to the NHS England API platform, including security, rate limiting, logging, monitoring and alerting. For any API, CIS2, NHS Login specific queries, please reach out the relevant API / Service teams.

3

Hi, please can you contact the following email addresses with your enquiry james.armstrong17@nhs.net and sara.buck@nhs.net