API statuses

Each API is tagged with a status

Service catalogue

In development

API in early prototyping. May be accessible for testing through a sandbox service or integration environment.

Beta

API available in a production environment. Remains prone to undergoing transformative changes following feedback.

In production

API available in a production environment. No further changes that might disrupt compatibility are expected.

Internal

API not yet open for integration by external third parties.

Under review for deprecation

API undergoing assessment for potential deprecation. We are thinking about phasing it out. Contact us if you have any concerns.

Deprecated

API remains available but our intention is to retire it. Updates are unlikely, and new integrations will not accepted.

Retired

API no longer available.

These statuses are based on the classification used by England's NHS Digital API Catalogue.

Developers

Our components and services make it quicker and easier to build and integrate services across health and social care.

Health and social care staff

Supporting health and care workers to record, access and share relevant information across the health and care system, to improve care.

The public

Improving the care you receive by making it easier to securely share data with the health and care professionals involved in your care, wherever you are in Scotland.

What do you think of this page?

© NHS Education for Scotland 2024