diff --git a/specification/record-locator/consumer.yaml b/specification/record-locator/consumer.yaml index 35f0b79..6762ac3 100644 --- a/specification/record-locator/consumer.yaml +++ b/specification/record-locator/consumer.yaml @@ -25,28 +25,37 @@ info: It can be used to store and publish pointers to patient data held in health systems across England and to look up where relevant patient data is held. + A provider is sometimes the end user organisation who authored the data, and sometimes a software provider acting as a proxy on behalf of end user organisations, for example, a Shared Care Record Provider acting on behalf of a cluster of ICBs. Where a proxy is acting on behalf of an end user organisation that is already onboarded as an NRL provider, caution needs to be taken to ensure they are not providing us with pointers we already have. + + For a more comprehensive overview of NRL, including examples of use and benefits, please see our [service overview page](https://digital.nhs.uk/services/national-record-locator#roadmap-and-latest-updates), + There is a growing list of health and social care organisations authorised to share records using NRL, and presently the pointers are classified into the following categories and types: - | 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)) | 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) | - | 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 | - - You can also retrieve booking and referal pointers however you can not currently do this by directly integrating with - the National Record Locator, you must instead onboard to the [Booking and Referral - FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) + | Category and system code (snomed) | Type and system code (snomed) | Notes | + |------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Mental health crisis plan ([736253002](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736253002)) | | + | 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)) | | + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Contingency plan ([325691000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=325691000000100)) | | + | 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)) | | + | 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)) | | + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Emergency health care plan ([887701000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887701000000100)) | | + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Advance care plan ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004)) | | + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Treatment escalation plan ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008)) | | + | 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)) | | + | Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Lloyd George record folder ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101)) | | + | 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)) | | + | Clinical note ([823651000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=823651000000106)) | Summary record ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109)) |This pointer type is being used for International Patient Summaries. | + | 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)) |This pointer type is being used for the in-context launch pilot. Please see the 'retrieval formats and mechanisms' for more information. | + + You can also onboard to the Booking and Referral - FHIR API which supports the sharing of appointment pointers. + + | Category and system code (snomed) | Type and system code (snomed) | Notes | + |------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| + | Record artifact ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008)) | Appointment ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101)) | | + + ### As a Consumer @@ -111,13 +120,14 @@ info: | Records & Stakeholders | Lists record types shared on the NRL and stakeholders who are providing, consuming or both providing and consuming the records. | | Purpose & Lawful Basis | Describes the purpose and lawful basis for the sharing of records with the stakeholders. | | End User Organisations | Lists the organisations using the NRL and indicates which record types an organisation is providing, consuming or both providing and consuming. | - + + For more examples of use, and details on the benefits of using the NRL service, please see our ([service overview page](https://digital.nhs.uk/services/national-record-locator#about-this-service)). + ## API status and roadmap This API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses). - To see our roadmap, or to suggest, comment or vote on features for this API, see our - [interactive product backlog](https://nhs-digital-api-management.featureupvote.com/?tag=national-record-locator-api). + Our roadmap can be found on our [service overview page](https://digital.nhs.uk/services/national-record-locator/roadmap). If you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support). @@ -248,6 +258,74 @@ info: + ## Retrieval Formats and Mechanisms + + Some pointers point you to records that are not digitally available to be retrieved from source. In these cases, links to websites with contact details for the record owner are provided. + + If records exist, NRL will signpost you to where you can find them and how to retrieve them. Often this information is supplemented with how to contact the organisation who authored them. + You can then use another service to retrieve the record directly from source (from the organisation who holds the record). NRL is not involved in this transaction. + + Most NRL pointers point to unstructured PDFs that are retrievable via the Spine Secure Proxy. + + Some unstructured PDFs that are too large to be sharded via the Spine Secure Proxy, are retrievable via the National Data Repository. + + We are currently exploring supporting pointers to structured data. As part of this journey, we are piloting 'in-context launch' pointers, which users can use as a 'deep link' in to a record application, + like the Greater Manchester Care Record. + + | Type and system code (snomed) | Retrieval formats (what) | Retrieval mechanism (how) | + | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | + | 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) | public website | + | Mental health crisis plan ([736253002](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736253002)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form ([1382601000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1382601000000107))| [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | Contingency plan ([325691000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=325691000000100)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | End of life care plan ([736373009](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736373009)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | End of life care coordination summary ([861421000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=861421000000109)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | Emergency health care plan ([887701000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887701000000100)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | Advance care plan ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | Treatment escalation plan ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | 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) | public website | + | Personalised Care and Support Plan ([2181441000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=2181441000000107))| [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | Lloyd George record folder ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101)) | unstructured PDF | [National Document Repository](https://digital.nhs.uk/developer/api-catalogue/national-document-repository) | + | 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) | public website | + | Royal College of Physicians NEWS2 (National Early Warning Score 2) chart ([1363501000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1363501000000100))| [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | Summary record ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) | public website | + | Summary record ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109)) | [unstructured PDF](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | [SSP](https://webarchive.nationalarchives.gov.uk/ukgwa/20250306000638/https://developer.nhs.uk/apis/nrl/retrieval_ssp.html) | + | Clinical summary ([887181000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887181000000106)) | [contact details](https://webarchive.nationalarchives.gov.uk/ukgwa/20250307105422/https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) | public website | + | Clinical summary ([887181000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887181000000106)) | application | in-context launch | + + + + ## Record content + + In addition to the format that content is available in, the content of records generally falls into two 'stability' categories. + + Some pointers will point to 'static' records. Records will usually be static if the pointer has been provided by the authoring end user organisation. + They can also be static in cases where a proxy has that data persisted in a data store. In these cases, providers typically create a pointer when a record is created, + and update the pointer every time that record is updated. Static records are often records with a limited lifespan. + + Other pointers will point to 'dynamic' records. Records will usually be dynamic if the pointer is being provided by a proxy, and the record content is being co-authored + by multiple end user organisations. In these cases, providers typically create a pointer when a record is created. Even when the record is updated, the pointer, including the retrieval URL on it, + will remain the same. When a consumer retrieves the record, the provider will construct the record on the fly, with the most up to date information for the patient. + This is also more common where a record exists for the life of the patient. + + ## Pointer maintenance + + The overhead of pointer maintenance is dependent on whether the type of record being pointed to exists for the life of a patient, or has a shorter lifespan. + + If the type of record will exist for the life of the patient (for example, clinical summaries), pointer maintenance is minimal. You will create a pointer when the patient is born, + or enters a provider's area of responsibility. You will delete the pointer when the patient dies. + + If the type of record will exist for a limited lifespan (for example, care plans), providers may need to update their pointers as patients records become active and expire. + + Providers are responsible for the upkeep of their pointers. This includes, but is not limited to, deleting pointers when a patient has died. + ## Related APIs NRL is primarily concerned with the registering and retrieval of pointers. As per the [registry/repository pattern] (https://digital.nhs.uk/developer/architecture/integration-patterns-book/patterns#registry-repository), following the retrieval of a pointer, the retrieval of an associated document/record may take place. In some circumstances information (or documents) are held in disparate systems. The registry-repository pattern resolves this by providing pointers with details that can be used to contact the organisation where the record is held, or directly retrieve the record from source, if authorised to do so. Most documents NRL pointers point to are retrievable using the Spine Secure Proxy [(SSP)](https://digital.nhs.uk/services/gp-connect/develop-gp-connect-services/integrate-with-spine/spine-secure-proxy). For example, all pointers of the category 'care plan' currently point to unstructured PDF documents, retrievable using SSP. @@ -280,6 +358,26 @@ info: For a consumer to retrieve information via the SSP, the consumer MUST percent encode the content.attachment.url property from the NRL pointer and prefix it with the SSP server URL as follows: GET https://[proxy_server]/[percent_encoded_provider_endpoint_url] For example: GET https://[proxy_server]/https%3A%2F%2Fp1.nhs.uk%2FMentalHealthCrisisPlans%2Fda2b6e8a-3c8f-11e8-baae-6c3be5a609f5. + ## National Document Repository (NDR) + + The National Document Repository (NDR) is a central place where digital patient documents can be accessed and stored by frontline services. Use this API to access, store and manage digital Lloyd George patient records. + + This API has different access modes, which give you access to different functionalities. + + Depending on your access mode you can: + + retrieve for a patient’s Lloyd George record + + You can onboard to the National Document Repository via the Digital Onboarding Service. + + ## In-context launch + + This retrieval pattern is currently in pilot. + + The first iteration will enable ambulance paramedics to launch the Greater Manchester Care Record from The National Care Record Service. NCRS will use CIS2 to generate an "In-Context Launch" specific access token that can be used to grant access to a third-party ECR (Electronic Care Record) system. The third-party ECR will verify the access token using CIS2 (system to system) and, if the requester has the appropriate role assigned to the access token (as an OAuth scope) allow the requester to view a patient's care record in the ECR application. This will allow users of NCRS to view patient records in third-party ECR systems. + + After the initial pilot in Greater Manchester, we will be exploring launching different types of record from different consuming applications, + ## Auditing This section outlines the audit and provenance requirements for data exchanged over NRL interfaces. @@ -345,6 +443,9 @@ info: | Trace ID | The consumer-generated ID of the retrieval request. This is only used for requests via the SSP and is for use in the Ssp-TraceID HTTP request header. | | User ID | The requesting_user from JWT. This is not mandatory where the request is completed as a non-interactive process. | + ## Frequently Asked Questions + + Answers to frequently asked questions can be found on the [developer community](https://developer.community.nhs.uk/c/national-record-locator-nrl/52). ## Change log