# \#api

**URL:** https://developer.community.nhs.uk/tag/api/21.md

[Latest](https://developer.community.nhs.uk/latest.md) · [Categories](https://developer.community.nhs.uk/categories.md) · [Tags](https://developer.community.nhs.uk/tags.md)

---

## [INT Env - Application Restricted API Requests](https://developer.community.nhs.uk/t/int-env-application-restricted-api-requests/15207)

<div class="topic-metadata">

**Author:** [@Application\_Support](https://developer.community.nhs.uk/u/Application_Support)\
**Replies:** 11\
**Last updated:** [28 September 2026 08:00 UTC](https://developer.community.nhs.uk/t/int-env-application-restricted-api-requests/15207 "2026-09-28T08:00:37Z")

</div>

Have an application registered within the INT environment. Obtaining the access token for API requests is working fine but we need advice on how to make requests to APIs that have ‘Application-restricted access’. Seems…

---

## [IM1 Partner API Witness Testing – Process & Preparation](https://developer.community.nhs.uk/t/im1-partner-api-witness-testing-process-preparation/15090)

<div class="topic-metadata">

**Author:** [@Fizza\_Ali](https://developer.community.nhs.uk/u/Fizza_Ali)\
**Replies:** 1\
**Last updated:** [10 September 2026 14:10 UTC](https://developer.community.nhs.uk/t/im1-partner-api-witness-testing-process-preparation/15090 "2026-09-10T14:10:10Z")

</div>

Hi everyone, We’re preparing for witness testing with the IM1 team as part of acquiring access to the Partner API, and I wanted to understand what the usual process looks like. For those who have been through this befo…

---

## [How to find clinic types for a service via the API?](https://developer.community.nhs.uk/t/how-to-find-clinic-types-for-a-service-via-the-api/14553)

<div class="topic-metadata">

**Author:** [@Jamie\_Burns](https://developer.community.nhs.uk/u/Jamie_Burns)\
**Replies:** 4\
**Last updated:** [27 August 2026 09:06 UTC](https://developer.community.nhs.uk/t/how-to-find-clinic-types-for-a-service-via-the-api/14553 "2026-08-27T09:06:46Z")

</div>

Hi, Is it possible to get the list of clinic types a specific service has via the API, using application-restricted access? I know we’ve got Retrieve Healthcare Service A033 (https://digital.nhs.uk/developer/api-catalo…

---

## [CIS2 Combined Authentication Selected Role](https://developer.community.nhs.uk/t/cis2-combined-authentication-selected-role/14219)

<div class="topic-metadata">

**Author:** [@Duncan\_James](https://developer.community.nhs.uk/u/Duncan_James)\
**Replies:** 3\
**Last updated:** [11 August 2026 09:52 UTC](https://developer.community.nhs.uk/t/cis2-combined-authentication-selected-role/14219 "2026-08-11T09:52:23Z")

</div>

We are implementing CIS2 using the User-restricted RESTful APIs - CIS2 combined authentication and authorisation security pattern as this is recommended for accessing user-restricted API’s. This is to authorise requests…

---

## [A005 Get Referral Error - Returing 500 Timeout](https://developer.community.nhs.uk/t/a005-get-referral-error-returing-500-timeout/14197)

<div class="topic-metadata">

**Author:** [@Jawad\_Ahmad](https://developer.community.nhs.uk/u/Jawad_Ahmad)\
**Replies:** 4\
**Last updated:** [11 August 2026 09:34 UTC](https://developer.community.nhs.uk/t/a005-get-referral-error-returing-500-timeout/14197 "2026-08-11T09:34:13Z")

</div>

Hi Team. On Friday, i noticed A005 Get Referral Endpoint stopped working on INT Environment. Other APIs seems to be working fine. I tried again today and still the same issue. Can i please get an update that if this is…

---

## [EMIS Partner API - FileRecord call - file size limits](https://developer.community.nhs.uk/t/emis-partner-api-filerecord-call-file-size-limits/12908)

<div class="topic-metadata">

**Author:** [@Faraz\_Malik](https://developer.community.nhs.uk/u/Faraz_Malik)\
**Replies:** 1\
**Last updated:** [6 July 2026 10:18 UTC](https://developer.community.nhs.uk/t/emis-partner-api-filerecord-call-file-size-limits/12908 "2026-07-06T10:18:51Z")

</div>

Hello, For context, this issue refers to a document processing platform that integrates into EMIS Web via the Partner API. We’ve been dealing with an issue with adding attachments to the FileRecord call. For context, w…

---

## [Automating XML Submissions to NHSE via MESH API](https://developer.community.nhs.uk/t/automating-xml-submissions-to-nhse-via-mesh-api/12520)

<div class="topic-metadata">

**Author:** [@Cory\_Schultze](https://developer.community.nhs.uk/u/Cory_Schultze)\
**Replies:** 3\
**Last updated:** [5 June 2026 15:08 UTC](https://developer.community.nhs.uk/t/automating-xml-submissions-to-nhse-via-mesh-api/12520 "2026-06-05T15:08:14Z")

</div>

Hi everyone, I’m in a bit of a pickle trying to make my SSIS pipeline submit ePMA XMLs to MESH API (because the Java Client is not an option for us - hard ‘no’ from IT). I’m going through the onboarding process, my man…

---

## [Trying to get IT access as a developer](https://developer.community.nhs.uk/t/trying-to-get-it-access-as-a-developer/12015)

<div class="topic-metadata">

**Author:** [@Mohammad\_Chaudhry](https://developer.community.nhs.uk/u/Mohammad_Chaudhry)\
**Replies:** 2\
**Last updated:** [30 May 2026 21:44 UTC](https://developer.community.nhs.uk/t/trying-to-get-it-access-as-a-developer/12015 "2026-05-30T21:44:34Z")

</div>

Hi everyone, I’m hoping someone can point me in the right direction regarding the NHS / PCSE Ophthalmic Payments API onboarding process. I’ve emailed the PCSE Ophthalmics Team multiple times (including on 19 February a…

---

## [Int - oAuth redirect\_uri\_mismatch](https://developer.community.nhs.uk/t/int-oauth-redirect-uri-mismatch/12207)

<div class="topic-metadata">

**Author:** [@Andrew\_Zagozda](https://developer.community.nhs.uk/u/Andrew_Zagozda)\
**Replies:** 3\
**Last updated:** [20 May 2026 09:19 UTC](https://developer.community.nhs.uk/t/int-oauth-redirect-uri-mismatch/12207 "2026-05-20T09:19:01Z")

</div>

I’ve set up a new INT application via the NHS Digital Onboarding website to test connectivity to e-Referral Service - Healthcare Worker ( Integration Testing ). My application connects to https://am.nhsint.auth-ptl.cis2…

---

## [Immunisation FHIR API](https://developer.community.nhs.uk/t/immunisation-fhir-api/12152)

<div class="topic-metadata">

**Author:** [@kevimunis](https://developer.community.nhs.uk/u/kevimunis)\
**Replies:** 2\
**Last updated:** [19 May 2026 12:42 UTC](https://developer.community.nhs.uk/t/immunisation-fhir-api/12152 "2026-05-19T12:42:04Z")

</div>

We’ve been looking at the Immunisation FHIR API as part of a solution that we are prototyping. It seems that this is intended to be used as a source of truth for patient immunisation records for certain key diseases. Ba…

---

## [e-RS INT — All endpoints returning HTTP 500 after ASID configuration](https://developer.community.nhs.uk/t/e-rs-int-all-endpoints-returning-http-500-after-asid-configuration/11547)

<div class="topic-metadata">

**Author:** [@Dennis\_Holmer](https://developer.community.nhs.uk/u/Dennis_Holmer)\
**Replies:** 3\
**Last updated:** [10 April 2026 13:57 UTC](https://developer.community.nhs.uk/t/e-rs-int-all-endpoints-returning-http-500-after-asid-configuration/11547 "2026-04-10T13:57:55Z")

</div>

Environment: e-RS INT (integration) Summary: We’ve recently configured our ASID for e-RS INT and are getting HTTP 500 on every endpoint we’ve tried. The response is a generic plain-text error (not a FHIR OperationOutc…

---

## [Misleading - Directory of Healthcare Services API](https://developer.community.nhs.uk/t/misleading-directory-of-healthcare-services-api/9965)

<div class="topic-metadata">

**Author:** [@peterd](https://developer.community.nhs.uk/u/peterd)\
**Replies:** 1\
**Last updated:** [20 January 2026 14:56 UTC](https://developer.community.nhs.uk/t/misleading-directory-of-healthcare-services-api/9965 "2026-01-20T14:56:28Z")

</div>

Hey I am transitioning my site from the older V2 of service search to the new Directory of Healthcare Services API V3. The docs state the following: Existing partners will be able to reuse their existing queries but w…

---

## [Organisation Data Service APIs users - can you help?](https://developer.community.nhs.uk/t/organisation-data-service-apis-users-can-you-help/269)

<div class="topic-metadata">

**Author:** [@fran.evans2](https://developer.community.nhs.uk/u/fran.evans2)\
**Replies:** 2\
**Last updated:** [2 January 2026 00:26 UTC](https://developer.community.nhs.uk/t/organisation-data-service-apis-users-can-you-help/269 "2026-01-02T00:26:10Z")

</div>

We are holding user research sessions next week to improve our content around the Organisation Data Service APIs. Can you find the documentation you need quickly and easily? Can we do anything to help you get started if…

---

## [Sandbox Fetch Immunization details of patient API returns "client error, 404 not found" response](https://developer.community.nhs.uk/t/sandbox-fetch-immunization-details-of-patient-api-returns-client-error-404-not-found-response/7678)

<div class="topic-metadata">

**Author:** [@Gaurav\_Patil](https://developer.community.nhs.uk/u/Gaurav_Patil)\
**Replies:** 3\
**Last updated:** [10 November 2025 11:44 UTC](https://developer.community.nhs.uk/t/sandbox-fetch-immunization-details-of-patient-api-returns-client-error-404-not-found-response/7678 "2025-11-10T11:44:30Z")

</div>

Hello Team, Currently we’re integrating Fetch Immunization details of patient : /immunisation/FHIR/R4/Immunization/{patientId} Getting “client error, 404 not found” response

---

## [File Record API (Partner APIs) Data format and display order](https://developer.community.nhs.uk/t/file-record-api-partner-apis-data-format-and-display-order/7808)

<div class="topic-metadata">

**Author:** [@ali.musa](https://developer.community.nhs.uk/u/ali.musa)\
**Replies:** 4\
**Last updated:** [24 September 2025 10:53 UTC](https://developer.community.nhs.uk/t/file-record-api-partner-apis-data-format-and-display-order/7808 "2025-09-24T10:53:28Z")

</div>

Hi all, I wanted to check if there’s a way to control the display order in the File Record API. For example, I’d like History to appear at the top, followed by Message, and then Comment, and at the end document. I also…

---

## [CIS2 Mock INT: mock-jwks returning generic pytest-nhsd-apim client instead of app-specific credentials](https://developer.community.nhs.uk/t/cis2-mock-int-mock-jwks-returning-generic-pytest-nhsd-apim-client-instead-of-app-specific-credentials/7716)

<div class="topic-metadata">

**Author:** [@Shariq\_Ayaz](https://developer.community.nhs.uk/u/Shariq_Ayaz)\
**Replies:** 2\
**Last updated:** [18 September 2025 10:29 UTC](https://developer.community.nhs.uk/t/cis2-mock-int-mock-jwks-returning-generic-pytest-nhsd-apim-client-instead-of-app-specific-credentials/7716 "2025-09-18T10:29:29Z")

</div>

I am setting up my Integration Testing app for CIS2 Healthcare Worker authentication. App name: mos-nhs-cis2 App ID: f5462fa6-50d2-40c3-ac80-053dae5da2c5 API Key: lmzYMGw1ElsGkhcS73hU6EgCXzlllglR Enabled APIs:…

---

## [EMIS FileRecord Date format](https://developer.community.nhs.uk/t/emis-filerecord-date-format/6073)

<div class="topic-metadata">

**Author:** [@chris.cooper](https://developer.community.nhs.uk/u/chris.cooper)\
**Replies:** 2\
**Last updated:** [5 June 2025 12:52 UTC](https://developer.community.nhs.uk/t/emis-filerecord-date-format/6073 "2025-06-05T12:52:51Z")

</div>

Hi All Hope your all good, I’ve created a C# API that integrates with EMIS using the using the EMIS EM\_PACC com (IPatientAccessEMISWebV4\_3) and the below methods. Everything works locally fine, but when I deploy to our…

---

## [Directory of Healthcare Services API - version 3 related](https://developer.community.nhs.uk/t/directory-of-healthcare-services-api-version-3-related/5625)

<div class="topic-metadata">

**Author:** [@GANESH\_KUMAR](https://developer.community.nhs.uk/u/GANESH_KUMAR)\
**Replies:** 0\
**Last updated:** [30 April 2025 06:12 UTC](https://developer.community.nhs.uk/t/directory-of-healthcare-services-api-version-3-related/5625 "2025-04-30T06:12:26Z")

</div>

IMPORTANT Hi NHS England API dev team! The existing Search by Nearest (Full Postcode) SOAP API (https://digital.nhs.uk/developer/api-catalogue/electronic-transmission-of-prescriptions-web-services-soap) returns an elem…

---

## [Seeking Guidance on Downloading NHS Prescriptions in PDF Format](https://developer.community.nhs.uk/t/seeking-guidance-on-downloading-nhs-prescriptions-in-pdf-format/5479)

<div class="topic-metadata">

**Author:** [@Assad\_Rehman](https://developer.community.nhs.uk/u/Assad_Rehman)\
**Replies:** 2\
**Last updated:** [17 April 2025 14:37 UTC](https://developer.community.nhs.uk/t/seeking-guidance-on-downloading-nhs-prescriptions-in-pdf-format/5479 "2025-04-17T14:37:44Z")

</div>

Hi everyone, I’m currently working on integrating NHS APIs into a PHP Laravel-based application, with the primary goal of downloading prescriptions, ideally in PDF format. Here’s a summary of what I’ve done so far: I…

---

## [EMIS Partner API FileRecord](https://developer.community.nhs.uk/t/emis-partner-api-filerecord/4990)

<div class="topic-metadata">

**Author:** [@ali.musa](https://developer.community.nhs.uk/u/ali.musa)\
**Replies:** 1\
**Last updated:** [20 March 2025 16:04 UTC](https://developer.community.nhs.uk/t/emis-partner-api-filerecord/4990 "2025-03-20T16:04:47Z")

</div>

I want to edit a consultation using the Partner API. According to the documentation, we need to change the FileStatus to 1 to enable editing. However, this approach is not working. Can anyone guide me on how to proceed?

---

## [IM1 Transaction API & EMIS Partner API](https://developer.community.nhs.uk/t/im1-transaction-api-emis-partner-api/2725)

<div class="topic-metadata">

**Author:** [@ali.musa](https://developer.community.nhs.uk/u/ali.musa)\
**Replies:** 2\
**Last updated:** [1 November 2024 07:36 UTC](https://developer.community.nhs.uk/t/im1-transaction-api-emis-partner-api/2725 "2024-11-01T07:36:24Z")

</div>

We need to compare the responses for patient medical records between the IM1 Transaction API and the EMIS Partner API to understand the differences and the effort required to support both. IM1 Transaction API capabiliti…

---

## [API Onboarding: Call for participants for user research!](https://developer.community.nhs.uk/t/api-onboarding-call-for-participants-for-user-research/918)

<div class="topic-metadata">

**Author:** [@ChristinaTan](https://developer.community.nhs.uk/u/ChristinaTan)\
**Replies:** 0\
**Last updated:** [13 May 2024 11:53 UTC](https://developer.community.nhs.uk/t/api-onboarding-call-for-participants-for-user-research/918 "2024-05-13T11:53:04Z")

</div>

Call for participants for user research! What’s the research? This research aims to understand and improve entry to the NHS England’s Digital Onboarding Service (DOS) by identifying and removing barriers for people wan…

---

## [Is there a health check endpoint for PDS FHIR int?](https://developer.community.nhs.uk/t/is-there-a-health-check-endpoint-for-pds-fhir-int/789)

<div class="topic-metadata">

**Author:** [@dorlugasigal](https://developer.community.nhs.uk/u/dorlugasigal)\
**Replies:** 1\
**Last updated:** [13 March 2024 12:00 UTC](https://developer.community.nhs.uk/t/is-there-a-health-check-endpoint-for-pds-fhir-int/789 "2024-03-13T12:00:41Z")

</div>

were developing some health check within our application, we noted that for sandbox pds fhir the endpoint /personal-demographics/FHIR/R4/\_health resulted with a health check, for example: { "status": "pass", "p…

---

## [401 when calling Token URL PDS Service](https://developer.community.nhs.uk/t/401-when-calling-token-url-pds-service/691)

<div class="topic-metadata">

**Author:** [@williamaitchison](https://developer.community.nhs.uk/u/williamaitchison)\
**Replies:** 3\
**Last updated:** [30 January 2024 08:17 UTC](https://developer.community.nhs.uk/t/401-when-calling-token-url-pds-service/691 "2024-01-30T08:17:21Z")

</div>

Hi, I am looking for some advice regarding getting the JWT from the integration environment. I am running the example code from GitHub . I have also set up the application with access to the PDS service. However I am…

---

## [e-Referral Service - FHIR API - Some worklists not available](https://developer.community.nhs.uk/t/e-referral-service-fhir-api-some-worklists-not-available/346)

<div class="topic-metadata">

**Author:** [@Davey](https://developer.community.nhs.uk/u/Davey)\
**Replies:** 1\
**Last updated:** [2 June 2023 08:50 UTC](https://developer.community.nhs.uk/t/e-referral-service-fhir-api-some-worklists-not-available/346 "2023-06-02T08:50:12Z")

</div>

According the API documentation for eRS the following worklists are not available; Appointments for Booking Displaced Appointments Are there any plans to make these tables available via the API (or have I missed them)…

---

## [What happened to the GPPractices XML API and where is the official replacement?](https://developer.community.nhs.uk/t/what-happened-to-the-gppractices-xml-api-and-where-is-the-official-replacement/246)

<div class="topic-metadata">

**Author:** [@callum](https://developer.community.nhs.uk/u/callum)\
**Replies:** 2\
**Last updated:** [23 February 2023 12:50 UTC](https://developer.community.nhs.uk/t/what-happened-to-the-gppractices-xml-api-and-where-is-the-official-replacement/246 "2023-02-23T12:50:47Z")

</div>

We use the GP Practices postcode lookup API in an app we have built. It has been dormant for a couple of years and during the restart and testing I’ve noticed our GP search feature has broken due to the following API end…

---

## [API Issue -- Exceed Skip -- ParameterValueOutOfRange](https://developer.community.nhs.uk/t/api-issue-exceed-skip-parametervalueoutofrange/217)

<div class="topic-metadata">

**Author:** [@ngenchev99](https://developer.community.nhs.uk/u/ngenchev99)\
**Replies:** 3\
**Last updated:** [14 February 2023 12:00 UTC](https://developer.community.nhs.uk/t/api-issue-exceed-skip-parametervalueoutofrange/217 "2023-02-14T12:00:12Z")

</div>

Hello, I’m developing an application that would collect some data from one of your APIs. Currently, I’m using the https://api.nhs.uk/service-search/search?api-version=1 endpoint. I need to take all services from your …

---

## [NHSD API integration survey - closes 31 January](https://developer.community.nhs.uk/t/nhsd-api-integration-survey-closes-31-january/201)

<div class="topic-metadata">

**Author:** [@jenna.hartley-smith](https://developer.community.nhs.uk/u/jenna.hartley-smith)\
**Replies:** 1\
**Last updated:** [30 January 2023 17:13 UTC](https://developer.community.nhs.uk/t/nhsd-api-integration-survey-closes-31-january/201 "2023-01-30T17:13:43Z")

</div>

For the last three years we’ve been building and improving our new API platform, and we’re keen to see how we’re doing. If you’ve been using our APIs during 2022, we’d be really grateful if you could find 5-10 minutes t…

---

## [Application-restricted Access eRS APIs - List of steps](https://developer.community.nhs.uk/t/application-restricted-access-ers-apis-list-of-steps/138)

<div class="topic-metadata">

**Author:** [@mustansar.hussain](https://developer.community.nhs.uk/u/mustansar.hussain)\
**Replies:** 3\
**Last updated:** [17 November 2022 10:46 UTC](https://developer.community.nhs.uk/t/application-restricted-access-ers-apis-list-of-steps/138 "2022-11-17T10:46:00Z")

</div>

Hi, I was wondering if anyone manage to start using the Application-restricted Access eRS APIs. We’ve recently developed an App that work fine and now planning to move this into Integration Environment. Does anyone have…
