# \#nrl-api

**URL:** https://developer.community.nhs.uk/tag/nrl-api/48.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)

---

## [Start connecting care today with NCRS and NRL](https://developer.community.nhs.uk/t/start-connecting-care-today-with-ncrs-and-nrl/12492)

<div class="topic-metadata">

**Author:** [@Alison\_Lowe](https://developer.community.nhs.uk/u/Alison_Lowe)\
**Replies:** 0\
**Last updated:** [3 June 2026 14:57 UTC](https://developer.community.nhs.uk/t/start-connecting-care-today-with-ncrs-and-nrl/12492 "2026-06-03T14:57:09Z")

</div>

The National Care Record Service (NCRS) provides health and care professionals with free online access to information about their patient, gathered from records across the NHS and Social Care, to use wherever and wheneve…

---

## [Does the NRL contain pointers for Welsh patients?](https://developer.community.nhs.uk/t/does-the-nrl-contain-pointers-for-welsh-patients/8777)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 5\
**Last updated:** [5 February 2026 10:18 UTC](https://developer.community.nhs.uk/t/does-the-nrl-contain-pointers-for-welsh-patients/8777 "2026-02-05T10:18:52Z")

</div>

We are attempting to upload a pointer for a patient registered in Wales. We received the following 400 response error: 'ORGANISATION\_NOT\_FOUND'. Are Welsh patients excluded?

---

## [Which organisation should be used for 'custodian' vs 'author'](https://developer.community.nhs.uk/t/which-organisation-should-be-used-for-custodian-vs-author/8779)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [13 November 2025 10:54 UTC](https://developer.community.nhs.uk/t/which-organisation-should-be-used-for-custodian-vs-author/8779 "2025-11-13T10:54:44Z")

</div>

Is the author the end user organisation or the system suppliers organisation?

---

## [What are the valid values for England-PracticeSetting?](https://developer.community.nhs.uk/t/what-are-the-valid-values-for-england-practicesetting/8778)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [13 November 2025 10:47 UTC](https://developer.community.nhs.uk/t/what-are-the-valid-values-for-england-practicesetting/8778 "2025-11-13T10:47:53Z")

</div>

How can we access the valid values for the England-PracticeSetting ValueSet (https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting) used for validating NRL R4 DocumentReference, given that available documentation …

---

## ['Message not well formed' error](https://developer.community.nhs.uk/t/message-not-well-formed-error/8776)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [13 November 2025 10:37 UTC](https://developer.community.nhs.uk/t/message-not-well-formed-error/8776 "2025-11-13T10:37:50Z")

</div>

I am getting the following error message: { "resourceType": "OperationOutcome", "issue": \[ { "severity": "error", "code": "invalid", "details": { "coding": \[ { "sy…

---

## ["The field 'relatesTo' is immutable and cannot be updated" error](https://developer.community.nhs.uk/t/the-field-relatesto-is-immutable-and-cannot-be-updated-error/8775)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [13 November 2025 10:30 UTC](https://developer.community.nhs.uk/t/the-field-relatesto-is-immutable-and-cannot-be-updated-error/8775 "2025-11-13T10:30:31Z")

</div>

I am having issues with Update (PUT) document reference. If I do not populate the relatesTo field, it complains: "diagnostics": "The field 'relatesTo' is immutable and cannot be updated", "expression": \[ …

---

## ["The required field 'category' is missing" error](https://developer.community.nhs.uk/t/the-required-field-category-is-missing-error/8774)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [13 November 2025 10:26 UTC](https://developer.community.nhs.uk/t/the-required-field-category-is-missing-error/8774 "2025-11-13T10:26:58Z")

</div>

We are getting a new error that we have not seen before: "diagnostics": "The required field 'category' is missing" How do we resolve this?

---

## [Where can I find documentation on use of SSP with NRL?](https://developer.community.nhs.uk/t/where-can-i-find-documentation-on-use-of-ssp-with-nrl/8747)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:57 UTC](https://developer.community.nhs.uk/t/where-can-i-find-documentation-on-use-of-ssp-with-nrl/8747 "2025-11-12T14:57:03Z")

</div>

Where can I find documentation on SSP?

---

## [Cannot see the ‘view document’ button for a pointer in NCRS](https://developer.community.nhs.uk/t/cannot-see-the-view-document-button-for-a-pointer-in-ncrs/8746)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:53 UTC](https://developer.community.nhs.uk/t/cannot-see-the-view-document-button-for-a-pointer-in-ncrs/8746 "2025-11-12T14:53:13Z")

</div>

In NCRS, I don’t get a button in the Documents tab to retrieve the document for a pointer. What is wrong?

---

## [What level is the TLS handshake done at?](https://developer.community.nhs.uk/t/what-level-is-the-tls-handshake-done-at/8745)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:49 UTC](https://developer.community.nhs.uk/t/what-level-is-the-tls-handshake-done-at/8745 "2025-11-12T14:49:26Z")

</div>

Does the TLS handshake need to be done on an infrastructure level, or an application level?

---

## [Request base URLs not as expected](https://developer.community.nhs.uk/t/request-base-urls-not-as-expected/8744)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:47 UTC](https://developer.community.nhs.uk/t/request-base-urls-not-as-expected/8744 "2025-11-12T14:47:59Z")

</div>

We are not seeing requests coming into our rest API application. Although we were expecting a request like this: https://\[your host\]/{externalId}/mental-health-crisis-plan.pdf we are seeing a request to the base URL: h…

---

## [Cannot tell if pointer is retrievable via SSP](https://developer.community.nhs.uk/t/cannot-tell-if-pointer-is-retrievable-via-ssp/8741)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:45 UTC](https://developer.community.nhs.uk/t/cannot-tell-if-pointer-is-retrievable-via-ssp/8741 "2025-11-12T14:45:03Z")

</div>

How do I know if a pointer is retrievable via SSP, or not?

---

## [What does AAL2 mean?](https://developer.community.nhs.uk/t/what-does-aal2-mean/8743)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:43 UTC](https://developer.community.nhs.uk/t/what-does-aal2-mean/8743 "2025-11-12T14:43:39Z")

</div>

What does AAL2 mean? Is AAL2 the same as 2FA?

---

## [What access restrictions apply to consumer functionality?](https://developer.community.nhs.uk/t/what-access-restrictions-apply-to-consumer-functionality/8742)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [12 November 2025 14:40 UTC](https://developer.community.nhs.uk/t/what-access-restrictions-apply-to-consumer-functionality/8742 "2025-11-12T14:40:25Z")

</div>

What privacy and access restrictions apply to NRL Consumer functionality - i.e., is the expectation that clinicians either have no access to the NRL Consumer functionality or ‘full access’, meaning an unfiltered view of …

---

## [How can we conduct early testing?](https://developer.community.nhs.uk/t/how-can-we-conduct-early-testing/8720)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 15:19 UTC](https://developer.community.nhs.uk/t/how-can-we-conduct-early-testing/8720 "2025-11-11T15:19:03Z")

</div>

Should we mock the API for early test environments and only connect one environment to Integration?

---

## [How can we test NRL?](https://developer.community.nhs.uk/t/how-can-we-test-nrl/8719)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 15:14 UTC](https://developer.community.nhs.uk/t/how-can-we-test-nrl/8719 "2025-11-11T15:14:07Z")

</div>

Are there NHS numbers available to use in INT that represent varied scenarios (e.g., a patient with a small number of documents and one with more than 20 for paging tests)?

---

## [How do I use x-request-id and x-correlation-id headers?](https://developer.community.nhs.uk/t/how-do-i-use-x-request-id-and-x-correlation-id-headers/8718)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 15:02 UTC](https://developer.community.nhs.uk/t/how-do-i-use-x-request-id-and-x-correlation-id-headers/8718 "2025-11-11T15:02:27Z")

</div>

How do I use x-request-id and x-correlation-id headers?

---

## [Differences between NRL v.2.8. and v.3.0. - JWTs](https://developer.community.nhs.uk/t/differences-between-nrl-v-2-8-and-v-3-0-jwts/8717)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:58 UTC](https://developer.community.nhs.uk/t/differences-between-nrl-v-2-8-and-v-3-0-jwts/8717 "2025-11-11T14:58:59Z")

</div>

Do I need to provide the same identifying information in the NRL v3 JWTs as I used to in the NRL v2.8 JWTs?

---

## [Cannot access NRL developer.nhs.uk documentation](https://developer.community.nhs.uk/t/cannot-access-nrl-developer-nhs-uk-documentation/8716)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:48 UTC](https://developer.community.nhs.uk/t/cannot-access-nrl-developer-nhs-uk-documentation/8716 "2025-11-11T14:48:51Z")

</div>

The SSL certificate for developer.nhs.uk has expired, and our firewall is blocking access to this documentation as a result. Is there another way to access this content?

---

## ["UNABLE\_TO\_RESOLVE\_CPAID\_ASID" error](https://developer.community.nhs.uk/t/unable-to-resolve-cpaid-asid-error/8713)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:32 UTC](https://developer.community.nhs.uk/t/unable-to-resolve-cpaid-asid-error/8713 "2025-11-11T14:32:51Z")

</div>

How do I resolve the following error? { "id": "ABC12345-1234-5678-9101-ABCDEF123456" "issue": \[ { "code": "structure", "details": { "coding": \[ { "code": "MISSI…

---

## [Cannot use producer search functionality to search for pointers provided by other organisations](https://developer.community.nhs.uk/t/cannot-use-producer-search-functionality-to-search-for-pointers-provided-by-other-organisations/8711)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:27 UTC](https://developer.community.nhs.uk/t/cannot-use-producer-search-functionality-to-search-for-pointers-provided-by-other-organisations/8711 "2025-11-11T14:27:32Z")

</div>

I cannot use producer search functionality to search for pointers provided by other organisations. I am getting the following error: “Your organisation ‘X00000’ does not have permission to access this resource. Contact…

---

## [Cannot find my application ID](https://developer.community.nhs.uk/t/cannot-find-my-application-id/8706)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:21 UTC](https://developer.community.nhs.uk/t/cannot-find-my-application-id/8706 "2025-11-11T14:21:02Z")

</div>

Where can I find my application ID?

---

## [Permissions in INT](https://developer.community.nhs.uk/t/permissions-in-int/8704)

<div class="topic-metadata">

**Author:** [@Elizabeth\_Williams](https://developer.community.nhs.uk/u/Elizabeth_Williams)\
**Replies:** 1\
**Last updated:** [11 November 2025 14:13 UTC](https://developer.community.nhs.uk/t/permissions-in-int/8704 "2025-11-11T14:13:35Z")

</div>

I am getting one of the following error messages. How do I resolve my issue? “The ‘nrl-app-id’ custom attribute for your application is missing or invalid. Please contact onboarding team to resolve the issue.” “Your or…
