Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NHS API Metadata API

The Metadata API from NHS API — 1 operation(s) for metadata.

NHS API Metadata API is one of 13 APIs that NHS API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.0, at version 0.0.1.

Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/referrals/FHIR, https://int.api.service.nhs.uk/referrals/FHIR, https://api.service.nhs.uk/referrals/FHIR.

1 operations 1 paths 0 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.0.1
Base URL
https://api.service.nhs.uk/personal-demographics
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

NHS API Metadata API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Metadata 1
GET
/metadata
Get capability statement
get-capability-statement → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-api-metadata-api-openapi.yml Raw ↑

Other APIs NHS API publishes across the network.

GP Connect Access Document - FHIR API
EPS Prescription Tracker - FHIR API
Booking and Referral - FHIR API
NHS Website Content API
Elective Waiting List API
NHS API CodeSystem API
NHS API List{id} API
NHS API Organization API
NHS API OrganizationAffiliation API
NHS API R4 API
NHS API STU3 API
NHS API ValueSet API