Skip to content

Removed develop.nhs.uk links from consumer PAI spec #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elizabeth-hill wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Removed develop.nhs.uk links from consumer PAI spec #207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf9930c
Update consumer.yaml
elizabeth-hill Feb 19, 2026
2fb90c4
Merge branch 'master' into feature/elhi1-NRL-2958-remove-developer.nh…
katebobyn-nhs Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions specification/record-locator/consumer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ info:

| Category and system code (snomed) | Type and system code (snomed) | Retrieval formats |
|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Mental health crisis plan ([736253002](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736253002)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form ([1382601000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1382601000000107)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Contingency plan ([325691000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=325691000000100)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | End of life care plan ([736373009](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736373009)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | End of life care coordination summary ([861421000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=861421000000109)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Emergency health care plan ([887701000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887701000000100)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Advance care plan ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Treatment escalation plan ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Personalised Care and Support Plan ([2181441000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=2181441000000107)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Mental health crisis plan ([736253002](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736253002)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form ([1382601000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1382601000000107)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Contingency plan ([325691000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=325691000000100)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | End of life care plan ([736373009](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736373009)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | End of life care coordination summary ([861421000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=861421000000109)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Emergency health care plan ([887701000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887701000000100)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Advance care plan ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Treatment escalation plan ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Personalised Care and Support Plan ([2181441000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=2181441000000107)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Lloyd George record folder ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101)) | unstructured PDF - LDR retrieval proxy |
| Observation ([1102421000000108](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1102421000000108)) | Royal College of Physicians NEWS2 (National Early Warning Score 2) chart ([1363501000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1363501000000100)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Clinical note ([823651000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=823651000000106)) | Summary record ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109)) | [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Observation ([1102421000000108](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1102421000000108)) | Royal College of Physicians NEWS2 (National Early Warning Score 2) chart ([1363501000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1363501000000100)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Clinical note ([823651000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=823651000000106)) | Summary record ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109)) | [unstructured PDF - SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105426/https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
| Record artifact ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008)) | Appointment ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101)) | |
| Record headings ([716931000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=716931000000107)) | Clinical summary ([887181000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887181000000106)) | in-context launch |

Expand Down Expand Up @@ -271,7 +271,7 @@ info:
## Spine Secure Proxy (SSP)

Information retrieval is an interaction between a consumer and a provider; routing and receiving requests via the SSP allows both parties to be ignorant of each other’s authentication and authorisation mechanisms, as the SSP handles the other side of the transaction.
The SSP is a content agnostic forward proxy, which is used to control and protect access to health systems. It provides a single security point for both authentication and authorisation for systems. See the [SSP specification](https://developer.nhs.uk/apis/spine-core/ssp_overview.html) for more details.
The SSP is a content agnostic forward proxy, which is used to control and protect access to health systems. It provides a single security point for both authentication and authorisation for systems. See the [SSP specification](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) for more details.

**Requesting Information via the SSP**
Endpoints which allow retrieval of information via the SSP MUST do so with a [HTTPS GET](https://www.rfc-editor.org/rfc/rfc9110.html) request, to the URL contained within the NRL pointer.
Expand Down
Loading