UKCore Hackathon Supporting Guide

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Reference Servers

The prototype UKCore Reference Server is internally one single server. There are two means of accessing it:

  • Unauthenticated access
  • Secure Access

For this Hackathon it is expected only the Unauthenticated access is needed, but the secure access has been added in case of more complex discussions around FHIR interactions are desired.

Please note: the reference implementation server uses paging, with a page size of 20 results.


Unauthenticated Access

Unauthenticated access is split into logical sections which are based around potential standards and/or standards used internationally.

Available on these servers:

API Documentation Frameworks and Implementation Guides FHIR Server baseUrl
Clinical Data Sharing RESTful endpoint providing read-only access for care resources. This API can be found on several EPR and other systems. IHE-QEDM and HL7 UK - UKCore Access (in-progress UK equivalent). Both aim at establishing common query API's across the health and social care enterprise. See also Framework - Shared Observation Records and Clinical Observations

IHE-MHD Finding and Retrieving Documents, see also Framework Document Sharing
https://3cdzg7kbj4.execute-api.eu-west-2.amazonaws.com/poc/clinicaldatasharing/FHIR/R4
Patient Summary Records Framework Patient Summary Records
Orchestration Services RESTful queries and interactions across health administration resources and bulk resource transfers IHE-MHD Sending Documents FHIR version of IHE-XDS api's which can also be used with other EDMS. See also Framework Document Sharing

FHIR Structured Data Capture for handling forms, see also Framework - Questionnaires and Structured Data Capture

HL7 FHIR Workflow, see also Framework Patient Care Coordination

IHE Patient Master Identity Registry (PMIR)

IHE Patient Identifier Cross-reference for Mobile (PIXm)
https://3cdzg7kbj4.execute-api.eu-west-2.amazonaws.com/poc/events/FHIR/R4
Care Coordination Services, services aimed at supporting patient care involving multiple providers. Currently hosted on Orchestration Services Framework Patient Care Coordination

IHE Dynamic Care Team Management (DCTM)

IHE Dynamic Care Planning (DCP)
Care Directory Services RESTful queries across related care services resources HL7 FHIR Administration
IHE-mCSD. This is preloaded with ODS organisation and practitioner data
https://3cdzg7kbj4.execute-api.eu-west-2.amazonaws.com/poc/caredirectories/FHIR/R4
Conformance and Validation. HL7 FHIR Validation https://3cdzg7kbj4.execute-api.eu-west-2.amazonaws.com/poc/Conformance/FHIR/R4
Terminology HL7 FHIR Terminology. This endpoint requires authentication. Some functions of this server are exposed via the Conformance and Validation (see above) https://ontology.nhs.uk/authoring/fhir

Secure Access

This FHIR Server supports a wider range of FHIR RESTful interactions (see https://cnuc9zdola.execute-api.eu-west-2.amazonaws.com/dev/metadata). Direct access to this server requires authentication, details are available if required.

Service Url
Using Postman https://github.com/awslabs/fhir-works-on-aws-deployment#using-postman-to-make-api-requests
FHIR Server BaseUrl https://cnuc9zdola.execute-api.eu-west-2.amazonaws.com/dev
AWS Cognito TokenUrl https://1cqk42q02th79tba81omg430ku.auth.eu-west-2.amazoncognito.com/oauth2/token
back to top