API Hub

Explore and Make use of Nationally Defined Messaging APIs

Version: This is an old version of the CDS API implementation guide. For the current version, please visit the CDS API implementation guide page or view the NHS Digital API hub.

Pre requisites

Development pre-requisites

Pre-Requisites for the CDS API

Consumer / Provider Server API Conformance

MUST support HL7 FHIR STU3 version 3.0.1.
MUST Implement REST behaviour according to the FHIR specification
MUST support XML or JSON formats for all API interactions.
SHOULD expose a valid CDS FHIR CapabilityStatement identifying the list of resources, operations and search parameters supported.

Consumer Conformance

MUST support bundled and referenced resources
MAY support contained resources

Provider Conformance

MUST support bundled or referenced resources
MAY support contained resources, but this is not a preferred option

Tags:

All content is available under the Open Government Licence v3.0, except where otherwise stated