{"openapi":"3.0.0","info":{"contact":{"email":"api.management@nhs.net","name":"NHS Digital API Management","url":"https://digital.nhs.uk/developer/help-and-support"},"description":"## Overview\n\nThe National Record Locator (NRL) enables organisations to share patient data nationwide. Rather than storing the\ndata itself, it is used to share pointers to the data, held in provider systems. It acts as an index and not a data\nrepository. Each document pointer is defined using the\n[FHIR R4 DocumentReference](https://hl7.org/fhir/R4/documentreference.html) standard.\n\n![National Record Locator](https://raw.githubusercontent.com/NHSDigital/nrlf-public-resources/main/images/proxies/specification/nrl-provider-consumer.png)\n\nUsers of the service fall into the categories of:\n\n* producers - capable of creating and managing pointers\n* consumers - capable of searching and reading pointers\n\nThe service removes the need for organisations to create duplicate copies of information across systems and\norganisations, by enabling access to up-to-date information directly from the source.\n\nIt can be used to store and publish pointers to patient data held in health systems across England and to look up\nwhere relevant patient data is held.\n\nA 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. \n\nFor 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),\n\nThere is a growing list of health and social care organisations authorised to share records using NRL, and presently\nthe pointers are classified into the following categories and types:\n\n| Category and system code (snomed) | Type and system code | Notes |\n|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Mental health crisis plan ([736253002](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736253002)) | |\n| 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)) | |\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Contingency plan ([325691000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=325691000000100)) | |\n| 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)) | |\n| 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)) | |\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Emergency health care plan ([887701000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887701000000100)) | |\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Advance care plan ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004)) | |\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Treatment escalation plan ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008)) | |\n| 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)) | |\n| Care Plan ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000)) | Lloyd George record folder ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101)) | |\n| 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)) | |\n| 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. |\n| Record artifact ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008)) | Appointment ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101)) | |\n| 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. |\n| Clinical document ([423876004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=423876004)) | About me ([1515851000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1515851000000101)) | |\n| Clinical document ([423876004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=423876004)) | Hospital Discharge to Assess Plan ([HDTAP](https://github.com/NHSDigital/nrlf-public-resources/blob/main/fhir/NRLF-RecordType-CodeSystem.json)) | |\n\nYou can also retrieve booking and referral pointers however you can not currently do this by directly integrating with\nthe 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)\n\n| Category and system code (snomed) | Type and system code | Notes |\n|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| Record artifact ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008)) | Appointment ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101)) | |\n\n\n### As a producer\n\nProducers can use this API to:\n\n* create pointers, restricted to document types agreed during the [onboarding](#api-description__onboarding) process\n* replace your pointers with a newer versions, superseding the old one\n* update the metadata associated with your pointers\n* delete pointers\n* search all pointers you created\n* read any pointer you created\n\n### What has changed?\n\nThis service is a replacement for the existing\n[National Record Locator (NRL)](https://digital.nhs.uk/services/national-record-locator), and has the following\nchanges:\n\n* upgraded from FHIR STU3 to R4.\n* improved performance and scalability.\n* improved onboarding experience.\n* authenticated using [signed JWT](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) rather than mTLS.\n* greater flexibility, by wider support of the [FHIR R4 DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource.\n* the application only supports json type FHIR, not XML\n\nPlease see our ([summary of differences](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v2.8.0/migrating-from-the-nrl-v2.8.-api-to-the-nrl-v3.0.-api])) for more information.\n\n### Data availability, timing and quality\n\nPointers are immediately available to authorised providers and consumers after successful creation.\n\n## Who can use this API\n\nThis API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go\ntoo far with your development. You must demonstrate you have a valid use case as part of digital onboarding.\n\nYou must have the capability to verify NHS numbers by one of the following mechanisms:\n\n * full PDS Spine compliant system\n * Spine Mini Service PDS (SMSP)\n\nConnecting parties must have an appointed Clinical Safety Officer and undertake a Clinical Safety Assessment.\n\nYou must do this before you can go live (see '[Onboarding](#api-description__onboarding)' below).\n\n ## Controller Catalogue\n\nThe purpose of the Controller Catalogue is to document the health and social care organisations authorised to share records using the National Record Locator (NRL) service.\n\nAny requests to share information via NHS England services, the source and consumer of that information, are reviewed by the Interoperability Working Group (IWG) and a recommendation provided by the group as to the appropriate sharing pattern(s) and sharing capability(ies) which meet end user needs. Where NRL is the recommended capability, the controller catalogue will be updated to reflect this.\n\nThe [Controller Catalogue](https://github.com/NHSDigital/nrlf-public-resources/raw/main/controller-catalogue/nrl-authorised-organisations-and-actors-catalogue.xlsx) is made up of the following sections:\n\n|Section|Description|\n|-------|-----------|\n| Records & Stakeholders | Lists record types shared on the NRL and stakeholders who are providing, consuming or both providing and consuming the records. |\n| Purpose & Lawful Basis | Describes the purpose and lawful basis for the sharing of records with the stakeholders. |\n| End User Organisations | Lists the organisations using the NRL and indicates which record types an organisation is providing, consuming or both providing and consuming. |\n\nFor 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).\n\n## API status and roadmap\n\nThis API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\nOur roadmap can be found on our [service overview page](https://digital.nhs.uk/services/national-record-locator/roadmap).\n\nIf you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Service level\n\nThis API is a gold service, meaning it is operational and supported 24 hours a day, 365 days a year.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\n\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\n\nIt conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/), except that it does not support the [capabilities](http://hl7.org/fhir/R4/http.html#capabilities) interaction.\n\nIt includes some country-specific FHIR extensions, which conform to [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [fhir.r4.ukcore.stu1 0.5.1](https://simplifier.net/packages/fhir.r4.ukcore.stu1/0.5.1).\n\nDraft FHIR resources specific to this API can be found [here](https://github.com/NHSDigital/nrlf-public-resources/blob/main/fhir).\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.\n\nIn particular:\n\n* resource names are capitalised and singular, and use US spellings, for example `Organization` not `organisations`\n* array names are singular, for example `entry` not `entries` for address lines\n* data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object\n\nThere are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\n\n## Network access\n\nThis API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\n\nThis API uses the following access modes:\n\n* [Application-restricted RESTful API - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)\n\n## Errors\n\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nErrors specific to each operation are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\nPlease note that HEAD requests are not supported by this API, so they will return a 405 Method Not Allowed error.\n\n## Open source\n\nWe currently don't have any open source resources for this API. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/107439/client-libraries-and-reference-implementations).\n\nThe source code for the PDS FHIR back end (the Core Spine source code) is not currently in the open. If you think this would be useful, you can [upvote the suggestion on our Interactive Product Backlog](https://nhs-digital-api-management.featureupvote.com/suggestions/466692/open-source-core-spine-including-pds-eps-scr-and-more).\n\n## Environments and testing\n\n| Environment | Base URL |\n| ----------------- | ---------------------------------------------------------------------- |\n| Sandbox | `https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/` |\n| Integration test | `https://int.api.service.nhs.uk/record-locator/producer/FHIR/R4/` |\n| Production | `https://api.service.nhs.uk/record-locator/producer/FHIR/R4/` |\n\n### Sandbox testing\n\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):\n\n* is for early developer testing\n* only covers a limited set of scenarios\n* is open access, so does not allow you to test authorisation\n\nFor details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.\n\nAlternatively, you can try out the sandbox using our Postman collection:\n\nRight click the icon and save link as... to save the Postman collection to your device\n\n[![Right click and save link as...](https://run.pstmn.io/button.svg)](https://github.com/NHSDigital/nrlf-public-resources/raw/main/postman/postman_collection.json)\n\n### Integration testing\n\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):\n\n* is for formal integration testing\n* includes authorisation\n\nIt also includes ready-to-use test data and scenarios. For details [contact us](https://digital.nhs.uk/developer/help-and-support).\n\nFor more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).\n\n## Onboarding\n\nYou need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it's worth planning well ahead.\n\nAs part of this process, you need to demonstrate that you can manage risks and that your software conforms technically with the requirements for this API.\n\nInformation on this page might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-producer-fhir/onboarding-support-information) or the [Digital Onboarding Service (DOS) onboarding page](https://digital.nhs.uk/services/national-record-locator/nrl-onboarding-guidance)\n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding#using-the-digital-onboarding-portal).\n\n
\n
\n
\n
\n \n \"\"\n \n
\n
\n
\n

To get started, sign in or create a developer account, then select 'product onboarding'.

\n
\n
\n
\n\n## Retrieval Formats and Mechanisms\n\nSome 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. \n\nIf 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.\n\nMost NRL pointers point to unstructured PDFs that are retrievable via the Spine Secure Proxy. \n\nSome unstructured PDFs that are too large to be shared via the Spine Secure Proxy, are retrievable via the National Data Repository.\n\nWe 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 applications, like the Greater Manchester Care Record. \n\n| Type and system code (snomed) | Retrieval formats (what) | Retrieval mechanism (how) |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------- |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| 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) |\n| 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 |\n| Clinical summary ([887181000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887181000000106)) | application | in-context launch |\n\n\n## Record content\n\nIn addition to the format that content is available in, the content of records generally falls into two 'stability' categories. \n\nSome 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.\n\nOther 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. \n\n##Pointer maintenance\n\nThe 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.\n\nIf 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. \n\nIf 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.\n\nProviders are responsible for the upkeep of their pointers. This includes, but is not limited to, deleting pointers when a patient has died.\n\n## Related APIs\n\nNRL 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.\nYou can also refer to the [NRL Content Stability](https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability) for information on the stability of the content of a target document or record linked by an NRL pointers.\nTo connect to the Spine Secure Proxy (SSP), you will need:\n* An ASID for your organisation\n* A FQDN and CSR for your endpoint/application\n* Document Content Permissions for your ASID\n* Internet Catbag Permissions for SSP (if your endpoint is internet facing)\n\nIf you have any questions on how to get an FQDN or how to generate a CSR, please email [ITOC](mailto:itoc.supportdesk@nhs.net). An example FQDN would be spine.example.record-locator.nhs.uk\n\nPlease note that for third-party suppliers, in production, your FQDN will need to match the format of nrl-ODSCODE.ORGNAME.thirdparty.nhs.uk.\n\nIn order to get an ASID, please complete this [form](https://digital.nhs.uk/services/path-to-live-environments/path-to-live-forms/combined-endpoint-and-service-registration-request). \nYou will need to tick \"create an endpoint including certificate\" in section 2, use FQDN in section 3 and section 4, tick 'CMA endpoint' in section 5 (manufacturer's details are not mandatory here), and leave sections 6 and 7 blank.\nYou should receive an email with your ASID and generated Certificate upon completing this form.\n\nOnce you have done this, you will need to ask for the 'internet' Catbag (if your endpoint is internet facing) and 'Document Content' interaction permissions to be added to your ASID. You can request these permissions by emailing [ITOC](mailto:itoc.supportdesk@nhs.net).\n\n## Spine Secure Proxy (SSP)\n\nInformation 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.\nThe 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.\n\n**Note:** When creating pointers, providers MUST NOT prefix the pointer URL property with the SSP server URL, and MUST NOT percent encode it. In other words, consumers are fully responsible for constructing the Spine proxy URL from the pointer URL.\nProviders MUST NOT include any patient-identifiable data (PID), such as the NHS number, within the retrieval URL.\nYou can also populate the [NRL Content Stability](https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability) section of a pointer/document reference with information on the stability of the content of a target document or record linked by an NRL pointers.\n\n##National Document Repository (NDR)\n\nThe 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.\n\nThis API has different access modes, which give you access to different functionalities.\n\nDepending on your access mode you can:\n* retrieve for a patient’s Lloyd George record\n\nYou can onboard to the National Document Repository via the Digital Onboarding Service.\n\n## In-context launch\n\nThis retrieval pattern is currently in pilot. \n\nThe first iteration will enable ambulance paramedics to launch the Greater Manchester Care Record from The National Care Record Service. \nNCRS 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. \nThe 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.\n\nAfter the initial pilot in Greater Manchester, we will be exploring launching different types of record from different consuming applications.\n\n## Auditing\n\n### Overview\nThis section outlines the audit and provenance requirements for data exchanged over NRL interfaces.\nBoth Providers and Consumers MUST maintain a full audit trail of all requests sent to, and responses received from, the NRL API. Providers MUST keep an audit trail of requests received from consumers (to retrieve records/documents etc) and their corresponding responses.\nIt is not necessary for a provider to keep an audit trail of the response payload returned to consumers. However, providers MUST be able to provide details of the record returned if requested for medico-legal purposes. Audit logs must be retained in line with organisational retention policies and NHS data governance requirements. Logs must be provided to NHS England on request for the purposes of investigation, assurance, or conformance checking.\nAdditionally, the NRL is responsible for logging all requests and responses that flows through its services. Providers can request access to audit log information held by NHS England for any pointers they own or manage.\n\nTwo types of audit trail data may be requested:\n* All audit trails for a given patient, identified by their NHS number.\n* All audit trails for all pointers owned by the provider.\nIn either case, the provider is only permitted to view the audit trail information for pointers that it owns and manages.\n\n### Access Token (JWT)\n\nProviders and Consumers MUST generate and supply a valid JWT access token with every request they initiate. This token must be supplied via the standard Authorization HTTP header for auditing purposes.\nAny request submitted without an Authorization header that meets the specified JWT requirements will be rejected.\nRefer to the JSON Web Token Guidance for detailed specifications.\n\n### Audit Logs\n\nThis section describes the audit logging requirements that a Provider must record in their respective audit logs.\nFor detailed definitions of each referenced element, refer to the Audit Log Attributes section below.\n\n**Provider Pointer Maintenance**\nProviders MUST record and store the following information in audit logs for each NRL maintenance interaction (POST, PATCH, DELETE):\n\n**For requests to the NRL**\n* ASID\n* HTTP Request Body (For POST and PATCH only)\n* HTTP Request URL\n* HTTP Verb\n* ODS Code\n* NHS Number\n* Request Datetime\n* User ID (if supplied)\n\n**For responses from the NRL**\n* HTTP Response Body\n* HTTP Status Code\n* Pointer Logical ID\n* Response Datetime\n\n**Audit Log Attributes**\nThe table below defines each audit log attribute and identifies the source from which its value must be obtained.\n| Attribute | Source |\n|------------|---------|\n| ASID | The requesting_system from JWT. Use only the ASID portion, for example: https://fhir.nhs.uk/Id/accredited-system\\|[ASID]. |\n| HTTP Request Body | HTTP request body (where applicable, i.e. POST or PATCH). |\n| HTTP Request URL | The URL of the NRL service taht was called. |\n| HTTP Response Body | The body of the response message returned. |\n| HTTP Status Code | Describes the response outcome: 2xx (Success), 4xx or 5xx (Failure). |\n| HTTP Verb | POST, PATCH, GET, OR DELETE. |\n| NHS number | The patient identifier used in the pointer subject reference (for example, https://fhir.nhs.uk/Id/nhs-number) or in a search query parameter. |\n| ODS Code | The requesting_organization from JWT (only the ODSCode portion is required, for example, https://fhir.nhs.uk/Id/ods-organization-code\\|[odsCode]). |\n| Pointer Logical ID | The logical ID of the pointer (generated by the NRL), contained in the Location response header. |\n| Request Datetime | Timestamp when the audit log entry was created. |\n| Response Datetime | Timestamp when the response was received from the NHS England service. |\n| User ID | The requesting_user from JWT. This is not mandatory where the request is completed as a non-interactive process. |\n\n\n## Frequently Asked Questions\n\nAnswers to frequently asked questions can be found on the [developer community](https://developer.community.nhs.uk/c/national-record-locator-nrl/52).\n","license":{"name":"MIT"},"title":"National Record Locator Producer - FHIR API","version":"1.0.0"},"servers":[{"description":"Sandbox environment.","url":"https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4"},{"description":"Integration test environment.","url":"https://int.api.service.nhs.uk/record-locator/producer/FHIR/R4"},{"description":"Production environment.","url":"https://api.service.nhs.uk/record-locator/producer/FHIR/R4"}],"paths":{"/DocumentReference":{"get":{"description":"Search through document pointers.\n\nResults are restricted to pointers you created, but can be further filtered by `subject`, `category`, and `type`.\n\nThis operation is also available as a http POST, which is the preferred method (see below).\n","operationId":"searchDocumentReference","parameters":[{"examples":{"none":{"summary":"None","value":""},"valid_1":{"summary":"Valid #1","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"},"valid_2":{"summary":"Valid #2","value":"https://fhir.nhs.uk/Id/nhs-number|9999999999"},"invalid":{"summary":"Unknown","value":"https://fhir.nhs.uk/Id/nhs-number|9000000001"}},"explode":true,"in":"query","name":"subject:identifier","required":true,"schema":{"$ref":"#/components/schemas/RequestQuerySubject"},"style":"form"},{"examples":{"none":{"summary":"None","value":""},"SNOMED_CODES_MENTAL_HEALTH_CRISIS_PLAN":{"summary":"Mental health crisis plan","value":"http://snomed.info/sct|736253002"},"SNOMED_CODES_EMERGENCY_HEALTH_CARE_PLAN":{"summary":"Emergency health care plan","value":"http://snomed.info/sct|887701000000100"},"SNOMED_CODES_END_OF_LIFE_CARE_COORDINATION_SUMMARY":{"summary":"End of Life Care Coordination Summary","value":"http://snomed.info/sct|861421000000109"},"SNOMED_CODES_RESPECT_FORM":{"summary":"ReSPECT form","value":"http://snomed.info/sct|1382601000000107"},"SNOMED_CODES_NEWS2_CHART":{"summary":"Royal College of Physicians NEWS2 chart","value":"http://snomed.info/sct|1363501000000100"},"SNOMED_CODES_CONTINGENCY_PLAN":{"summary":"Contingency plan","value":"http://snomed.info/sct|325691000000100"},"SNOMED_CODES_END_OF_LIFE_CARE_PLAN":{"summary":"End of life care plan","value":"http://snomed.info/sct|736373009"},"SNOMED_CODES_LLOYD_GEORGE_RECORD_FOLDER":{"summary":"Lloyd George record folder","value":"http://snomed.info/sct|16521000000101"},"SNOMED_CODES_ADVANCE_CARE_PLAN":{"summary":"Advance care plan","value":"http://snomed.info/sct|736366004"},"SNOMED_CODES_TREATMENT_ESCALATION_PLAN":{"summary":"Treatment escalation plan","value":"http://snomed.info/sct|735324008"},"SNOMED_CODES_SUMMARY_RECORD":{"summary":"Summary record","value":"http://snomed.info/sct|824321000000109"},"SNOMED_CODES_PERSONALISED_CARE_AND_SUPPORT_PLAN":{"summary":"Personalised Care and Support Plan","value":"http://snomed.info/sct|2181441000000107"},"SNOMED_CODES_APPOINTMENT":{"summary":"Appointment","value":"http://snomed.info/sct|749001000000101"},"SNOMED_CODES_SHCR":{"summary":"Clinical summary","value":"http://snomed.info/sct|887181000000106"},"invalid":{"summary":"Unknown","value":"http://snomed.info/sct|410970009"}},"explode":true,"in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/RequestQueryType"},"style":"form"},{"examples":{"none":{"summary":"None","value":""},"SNOMED_CODES_CARE_PLAN":{"summary":"Care plan","value":"http://snomed.info/sct|734163000"},"SNOMED_CODES_OBSERVATIONS":{"summary":"Observations","value":"http://snomed.info/sct|1102421000000108"},"SNOMED_CODES_CLINICAL_NOTE":{"summary":"Clinical note","value":"http://snomed.info/sct|823651000000106"},"SNOMED_CODES_DIAGNOSTIC_STUDIES_REPORT":{"summary":"Diagnostic studies report","value":"http://snomed.info/sct|721981007"},"SNOMED_CODES_DIAGNOSTIC_PROCEDURE":{"summary":"Diagnostic procedure","value":"http://snomed.info/sct|103693007"},"SNOMED_CODES_RECORD_ARTIFACT":{"summary":"Record artifact","value":"http://snomed.info/sct|419891008"},"SNOMED_CODES_RECORD_HEADINGS":{"summary":"Record headings","value":"http://snomed.info/sct|716931000000107"},"invalid":{"summary":"Unknown","value":"http://snomed.info/sct|410970009"}},"explode":true,"in":"query","name":"category","required":false,"schema":{"$ref":"#/components/schemas/RequestQueryCategory"},"style":"form"},{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"Bundle","type":"searchset","total":2,"entry":[{"resource":{"resourceType":"DocumentReference","id":"Y05868-1834567891","masterIdentifier":{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2004.3.7"},"identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1134"}],"status":"current","docStatus":"preliminary","type":{"coding":[{"system":"http://snomed.info/sct","code":"1363501000000100","display":"Royal College of Physicians NEWS2 (National Early Warning Score 2) chart"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"1102421000000108","display":"Observations"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}},"date":"2022-12-22T11:45:41+11:00","author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"authenticator":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"8HV66"}},"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"securityLabel":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-Confidentiality","code":"V","display":"very restricted"}]}],"content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/PhysicianNote.pdf","creation":"2022-12-22T09:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"event":[{"coding":[{"system":"http://snomed.info/sct","code":"445627002","display":"Assessment using adult early warning scoring system"}]}],"period":{"start":"2022-12-20T09:00:41+11:00","end":"2022-12-20T09:45:41+11:00"},"facilityType":{"coding":[{"system":"http://snomed.info/sct","code":"46111000","display":"Secondary care hospital"}]},"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"409971007","display":"Emergency medical services"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}}},{"resource":{"resourceType":"DocumentReference","id":"Y05868-837826318432","masterIdentifier":{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7"},"identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}],"status":"current","docStatus":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"861421000000109","display":"End of life care coordination summary"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"734163000","display":"Care plan"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}},"date":"2022-12-21T10:45:41+11:00","author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"description":"Example DocRef for EOL care coordination summary","content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf","title":"EOL care coordination plan summary","creation":"2022-12-21T10:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"395092004","display":"Specialist palliative care"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}}}]},"schema":{"$ref":"#/components/schemas/Bundle"}}},"description":"successful response","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/CorrelationId"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"INVALID_PARAMETER","display":"Invalid parameter"}]},"diagnostics":"Invalid query parameter"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n| 403 | ACCESS_DENIED_LEVEL | Access has been denied because you need higher level permissions |\n| 404 | RESOURCE_NOT_FOUND | Resource not found |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Retrieve document pointers (GET)"},"post":{"description":"Create new pointers, or Supersede existing ones.\n\nTo create a document pointer you must ensure:\n\n* the body must be a valid [FHIR R4 DocumentReference](https://hl7.org/fhir/R4/documentreference.html)\n* `subject` MUST be a `Patient` reference using a valid NHS number. e.g.\n ```\n \"subject\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9999999999\"\n }\n },\n ```\n* `custodian` MUST be an `Organization` reference using a valid ODS code, agreed during [onboarding](#api-description__onboarding). e.g.\n ```\n \"custodian\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"Y05868\"\n }\n }\n ```\n* `type` MUST match one of the Document Types agreed during [onboarding](#api-description__onboarding). e.g.\n ```\n \"type\": {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"1363501000000100\",\n \"display\": \"Royal College of Physicians NEWS2 (National Early Warning Score 2) chart\"\n }\n ]\n }\n ```\n* `category` MUST indicate the broader class of the Document Type as agreed during [onboarding](#api-description__onboarding). e.g.\n ```\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"1102421000000108\",\n \"display\": \"Observations\"\n }\n ]\n }\n ]\n ```\n* `content` MUST have at least one entry.\n* `content[]` MUST include an `attachment` entry.\n* `content[]` MUST include a `format` entry. (https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode)\n* `content[]` MUST include the content stability extension (https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability).\n* `content[]` SHOULD include the retrieval mechanism extension (https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism).\n* `content[].attachment` MUST include a `url` to the document. For unstructured documents retrieved via SSP, `content[].attachment.url` MUST begin with `ssp://`. `https://` MUST NOT be used where retrieval is intended to occur via the Secure Spine Proxy.\n* `content[].attachment` MUST include a `contentType` and be a valid MIME type. We typically expect `application/pdf` for unstructured documents, `application/fhir+json` for structured data, or `text/html` for contact details.\n* `content[].format` MUST indicate whether the data is structured or not\n* Example of the content section:\n ```\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"url\": \"ssp://provider-ods-code.thirdparty.nhs.uk/path/to/document.pdf\",\n \"creation\": \"2022-12-22T09:45:41+11:00\"\n },\n \"format\": {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode\",\n \"code\": \"urn:nhs-ic:unstructured\"\n \"display\": \"Unstructured Document\"\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability\",\n \"code\": \"static\",\n \"display\": \"Static\"\n }\n ]\n }\n },\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism\",\n \"code\": \"SSP\",\n \"display\": \"Spine Secure Proxy\"\n }\n ]\n }\n }\n ]\n }\n ]\n ```\n* `author` MUST have an entry with an `Organization` reference using a valid ODS code.\n ```\n \"author\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"Y05868\"\n }\n }\n ]\n ```\n* `context` MUST include a `practiceSetting`. If the document is to be accessed via SSP, it must also include a `related` entry containing the ASID, e.g.\n ```\n \"context\": {\n \"practiceSetting\": {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"788002001\",\n \"display\": \"Adult mental health service\"\n }\n ]\n },\n \"related\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhsSpineASID\",\n \"value\": \"230811201350\"\n }\n }\n ]\n }\n ```\n\nTo supersede existing pointers you must further specify:\n\n* at least one existing pointer in the `relatesTo` with a `code` of `replaces`.\n ```\n [\n {\n \"code\": \"replaces\",\n \"target\": {\n \"type\": \"DocumentReference\",\n \"identifier\": {\n \"value\": \"XYZ-1234567890\"\n }\n }\n }\n ]\n ```\n\n* the following fields MUST match the pointers being superseded:\n * `subject`\n * `type`\n\nThis will cause a new pointer to be created and superseded pointers to be deleted. Multiple documents can\nbe superseded.\n\nA globally unique `id` will be generated by NRLF for the newly created pointer. The id will be prefixed with\nthe custodian's ODS code, and can be found in the `location` response header.\n","operationId":"createDocumentReference","parameters":[{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"requestBody":{"$ref":"#/components/requestBodies/DocumentReference"},"responses":{"201":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"information","code":"informational","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/NRLF-ResponseCode","code":"RESOURCE_CREATED","display":"Resource created"}]},"diagnostics":"The document has been created"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Create / Supersede successful response"},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"value","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"INVALID_RESOURCE","display":"Invalid validation of resource"}]},"diagnostics":"Category code is not valid"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 400 | MESSAGE_NOT_WELL_FORMED | Message not well formed |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n| 403 | ACCESS_DENIED_LEVEL | Access has been denied because you need higher level permissions |\n| 404 | RESOURCE_NOT_FOUND | Resource not found |\n| 422 | UNPROCESSABLE_ENTITY | Unprocessable Entity |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Create new, or Supersede existing, document pointers"}},"/DocumentReference/_search":{"post":{"description":"Search through document pointers.\n\nResults are restricted to pointers you created, but can be further filtered by `subject`, `category`, and `type`.\n\nThis operation is also available as a http GET for convenience (see above), but POST is preferred for the\nfollowing reasons:\n\n* query string parameters are visible on the network and in logs, and may have privacy implications for consumers.\n* GET operations can be cached by intermediary network infrastructure, such as CDNs, routers and proxies.\n* URLs have a maximum length of 2,048 characters which complex searches can exceed. NRL does not currently\nexceed this limit, but may evolve in the future.\n","operationId":"searchPostDocumentReference","parameters":[{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestParams"}}}},"responses":{"200":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"Bundle","type":"searchset","total":2,"entry":[{"resource":{"resourceType":"DocumentReference","id":"Y05868-1834567891","masterIdentifier":{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2004.3.7"},"identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1134"}],"status":"current","docStatus":"preliminary","type":{"coding":[{"system":"http://snomed.info/sct","code":"1363501000000100","display":"Royal College of Physicians NEWS2 (National Early Warning Score 2) chart"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"1102421000000108","display":"Observations"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}},"date":"2022-12-22T11:45:41+11:00","author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"authenticator":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"8HV66"}},"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"securityLabel":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-Confidentiality","code":"V","display":"very restricted"}]}],"content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/PhysicianNote.pdf","creation":"2022-12-22T09:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"event":[{"coding":[{"system":"http://snomed.info/sct","code":"445627002","display":"Assessment using adult early warning scoring system"}]}],"period":{"start":"2022-12-20T09:00:41+11:00","end":"2022-12-20T09:45:41+11:00"},"facilityType":{"coding":[{"system":"http://snomed.info/sct","code":"46111000","display":"Secondary care hospital"}]},"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"409971007","display":"Emergency medical services"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}}},{"resource":{"resourceType":"DocumentReference","id":"Y05868-837826318432","masterIdentifier":{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7"},"identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}],"status":"current","docStatus":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"861421000000109","display":"End of life care coordination summary"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"734163000","display":"Care plan"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}},"date":"2022-12-21T10:45:41+11:00","author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"description":"Example DocRef for EOL care coordination summary","content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf","title":"EOL care coordination plan summary","creation":"2022-12-21T10:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"395092004","display":"Specialist palliative care"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}}}]},"schema":{"$ref":"#/components/schemas/Bundle"}}},"description":"Successful response","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/CorrelationId"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"INVALID_PARAMETER","display":"Invalid parameter"}]},"diagnostics":"Invalid query parameter"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n| 403 | ACCESS_DENIED_LEVEL | Access has been denied because you need higher level permissions |\n| 404 | RESOURCE_NOT_FOUND | Resource not found |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Retrieve document pointers (POST)"}},"/DocumentReference/{id}":{"delete":{"description":"Delete a single document pointer that you created.\n","operationId":"deleteDocumentReference","parameters":[{"description":"logical identifier","examples":{"valid":{"summary":"Valid","value":"Y05868-1234567892"},"invalid":{"summary":"Unknown","value":"Y05861-1234567800"}},"explode":false,"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"},"style":"simple"},{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","id":"c6113a50-70bf-436e-b417-7c8024d2e8bf","meta":{"profile":["https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome"]},"issue":[{"severity":"information","code":"informational","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode","code":"RESOURCE_REMOVED","display":"Resource removed"}]},"diagnostics":"Resource removed"}]}}},"description":"Successful response"},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"ACCESS_DENIED","display":"Access Denied"}]},"diagnostics":"The requested document pointer cannot be deleted because it belongs to another organisation"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Delete a single document pointer"},"get":{"description":"Read a single document pointer by specifying the `DocumentReference.id`. Note that you will only be able to\nretrieve document pointers that have been created by the organisation specified in the `ODS-End-User-Organisation-ODS`\nheader, and agreed during [onboarding](#onboarding).\n","operationId":"readDocumentReference","parameters":[{"description":"logical identifier","examples":{"valid":{"summary":"Valid","value":"Y05868-1234567892"},"invalid":{"summary":"Unknown","value":"Y05861-1234567800"}},"explode":false,"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"},"style":"simple"},{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"DocumentReference","id":"Y05868-1234567892","status":"current","docStatus":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"887701000000100","display":"Emergency health care plan"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"734163000","display":"Care plan"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}},"date":"2022-12-22T11:45:41+11:00","author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyCarePlan.pdf","creation":"2022-12-22T09:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"facilityType":{"coding":[{"system":"http://snomed.info/sct","code":"82242000","display":"Children's hospital"}]},"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"224891009","display":"Healthcare services"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}},"schema":{"$ref":"#/components/schemas/DocumentReference"}}},"description":"Successful response","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/CorrelationId"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"forbidden","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"AUTHOR_CREDENTIALS_ERROR","display":"Author credentials error"}]},"diagnostics":"The requested document pointer cannot be read because it belongs to another organisation"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n| 404 | RESOURCE_NOT_FOUND | Resource not found |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Get a single document pointer"},"put":{"description":"Update a single pointer you created.\n\nNote that the following fields cannot be changed with an update operation:\n* `id`\n* `subject`\n* `custodian`\n* `type`\n* `masterIdentifier`\n* `date`\n\nNote that unlike in NRL 2.8, changing the `status` field does NOT delete document pointers. To delete document\npointers use the `DELETE` endpoint.\n","operationId":"updateDocumentReference","parameters":[{"description":"logical identifier","examples":{"valid":{"summary":"Valid","value":"Y05868-1234567892"},"invalid":{"summary":"Unknown","value":"Y05861-1234567800"}},"explode":false,"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"},"style":"simple"},{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}],"requestBody":{"$ref":"#/components/requestBodies/DocumentReference"},"responses":{"200":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","id":"fc39effb-144c-4342-bdf2-4214f0cb728b","meta":{"profile":["https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome"]},"issue":[{"severity":"information","code":"informational","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode","code":"RESOURCE_UPDATED","display":"Resource updated"}]},"diagnostics":"Resource updated"}]}}},"description":"Successful response"},"4XX":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode","version":"1","code":"MESSAGE_NOT_WELL_FORMED","display":"Message not well formed"}]},"diagnostics":"Request body could not be parsed"}]},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| 400 | BAD_REQUEST | Bad Request |\n| 400 | MESSAGE_NOT_WELL_FORMED | Message not well formed |\n| 401 | ACCESS_DENIED | Access Denied |\n| 403 | ACCESS_DENIED | Forbidden |\n| 404 | RESOURCE_NOT_FOUND | Resource not found |\n| 422 | UNPROCESSABLE_ENTITY | Unprocessable Entity |\n\nThe Error Code comes from https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode\n"}},"summary":"Update a single document pointer"}}},"components":{"headers":{"CorrelationId":{"explode":false,"schema":{"description":"The X-Correlation-ID from the request header, if supplied, mirrored back.\n","example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","type":"string"},"style":"simple"},"RequestId":{"explode":false,"schema":{"description":"The X-Request-ID from the request header mirrored back.\n","example":"60E0B220-8136-4CA5-AE46-1D97EF59D068","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}},"parameters":{"id":{"description":"logical identifier","examples":{"valid":{"summary":"Valid","value":"Y05868-1234567892"},"invalid":{"summary":"Unknown","value":"Y05861-1234567800"}},"explode":false,"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/DocumentId"},"style":"simple"},"subject":{"examples":{"none":{"summary":"None","value":""},"valid_1":{"summary":"Valid #1","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"},"valid_2":{"summary":"Valid #2","value":"https://fhir.nhs.uk/Id/nhs-number|9999999999"},"invalid":{"summary":"Unknown","value":"https://fhir.nhs.uk/Id/nhs-number|9000000001"}},"explode":true,"in":"query","name":"subject:identifier","required":true,"schema":{"$ref":"#/components/schemas/RequestQuerySubject"},"style":"form"},"type":{"examples":{"none":{"summary":"None","value":""},"SNOMED_CODES_MENTAL_HEALTH_CRISIS_PLAN":{"summary":"Mental health crisis plan","value":"http://snomed.info/sct|736253002"},"SNOMED_CODES_EMERGENCY_HEALTH_CARE_PLAN":{"summary":"Emergency health care plan","value":"http://snomed.info/sct|887701000000100"},"SNOMED_CODES_END_OF_LIFE_CARE_COORDINATION_SUMMARY":{"summary":"End of Life Care Coordination Summary","value":"http://snomed.info/sct|861421000000109"},"SNOMED_CODES_RESPECT_FORM":{"summary":"ReSPECT form","value":"http://snomed.info/sct|1382601000000107"},"SNOMED_CODES_NEWS2_CHART":{"summary":"Royal College of Physicians NEWS2 chart","value":"http://snomed.info/sct|1363501000000100"},"SNOMED_CODES_CONTINGENCY_PLAN":{"summary":"Contingency plan","value":"http://snomed.info/sct|325691000000100"},"SNOMED_CODES_END_OF_LIFE_CARE_PLAN":{"summary":"End of life care plan","value":"http://snomed.info/sct|736373009"},"SNOMED_CODES_LLOYD_GEORGE_RECORD_FOLDER":{"summary":"Lloyd George record folder","value":"http://snomed.info/sct|16521000000101"},"SNOMED_CODES_ADVANCE_CARE_PLAN":{"summary":"Advance care plan","value":"http://snomed.info/sct|736366004"},"SNOMED_CODES_TREATMENT_ESCALATION_PLAN":{"summary":"Treatment escalation plan","value":"http://snomed.info/sct|735324008"},"SNOMED_CODES_SUMMARY_RECORD":{"summary":"Summary record","value":"http://snomed.info/sct|824321000000109"},"SNOMED_CODES_PERSONALISED_CARE_AND_SUPPORT_PLAN":{"summary":"Personalised Care and Support Plan","value":"http://snomed.info/sct|2181441000000107"},"SNOMED_CODES_APPOINTMENT":{"summary":"Appointment","value":"http://snomed.info/sct|749001000000101"},"SNOMED_CODES_SHCR":{"summary":"Clinical summary","value":"http://snomed.info/sct|887181000000106"},"invalid":{"summary":"Unknown","value":"http://snomed.info/sct|410970009"}},"explode":true,"in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/RequestQueryType"},"style":"form"},"category":{"examples":{"none":{"summary":"None","value":""},"SNOMED_CODES_CARE_PLAN":{"summary":"Care plan","value":"http://snomed.info/sct|734163000"},"SNOMED_CODES_OBSERVATIONS":{"summary":"Observations","value":"http://snomed.info/sct|1102421000000108"},"SNOMED_CODES_CLINICAL_NOTE":{"summary":"Clinical note","value":"http://snomed.info/sct|823651000000106"},"SNOMED_CODES_DIAGNOSTIC_STUDIES_REPORT":{"summary":"Diagnostic studies report","value":"http://snomed.info/sct|721981007"},"SNOMED_CODES_DIAGNOSTIC_PROCEDURE":{"summary":"Diagnostic procedure","value":"http://snomed.info/sct|103693007"},"SNOMED_CODES_RECORD_ARTIFACT":{"summary":"Record artifact","value":"http://snomed.info/sct|419891008"},"SNOMED_CODES_RECORD_HEADINGS":{"summary":"Record headings","value":"http://snomed.info/sct|716931000000107"},"invalid":{"summary":"Unknown","value":"http://snomed.info/sct|410970009"}},"explode":true,"in":"query","name":"category","required":false,"schema":{"$ref":"#/components/schemas/RequestQueryCategory"},"style":"form"},"odsCode":{"description":"ODS Code for Organisation","examples":{"valid":{"summary":"Valid","value":"Y05868"},"invalid":{"summary":"Unknown","value":"XYZ"}},"explode":false,"in":"header","name":"NHSD-End-User-Organisation-ODS","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderOdsCode"},"style":"simple"},"requestId":{"description":"A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"$ref":"#/components/schemas/RequestHeaderRequestId"},"style":"simple"},"correlationId":{"description":"An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nIf you re-send a failed request please re-send this ID in the header.\n\nIt can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"$ref":"#/components/schemas/RequestHeaderCorrelationId"},"style":"simple"}},"requestBodies":{"DocumentReference":{"content":{"application/fhir+json;version=1":{"example":{"resourceType":"DocumentReference","status":"current","docStatus":"final","type":{"coding":[{"system":"http://snomed.info/sct","code":"736253002","display":"Mental health crisis plan"}]},"category":[{"coding":[{"system":"http://snomed.info/sct","code":"734163000","display":"Care plan"}]}],"subject":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9999999999"}},"author":[{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}}],"custodian":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"Y05868"}},"description":"Physical document mental health crisis plan","content":[{"attachment":{"contentType":"application/pdf","language":"en-UK","url":"ssp://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf","title":"Mental health crisis plan report","creation":"2022-12-21T10:45:41+11:00"},"format":{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode","code":"urn:nhs-ic:unstructured","display":"Unstructured Document"},"extension":[{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability","code":"static","display":"Static"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"},{"valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism","code":"SSP","display":"Spine Secure Proxy"}]},"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"}]}],"context":{"event":[{"coding":[{"system":"http://snomed.info/sct","code":"867871000000100","display":"Review of mental health care plan"}]}],"period":{"start":"2022-12-20T09:00:41+11:00","end":"2022-12-20T09:45:41+11:00"},"facilityType":{"coding":[{"system":"http://snomed.info/sct","code":"443750004","display":"Nonacute hospital"}]},"practiceSetting":{"coding":[{"system":"http://snomed.info/sct","code":"788002001","display":"Adult mental health service"}]},"related":[{"identifier":{"system":"https://fhir.nhs.uk/Id/nhsSpineASID","value":"200000000610"}}]}},"schema":{"$ref":"#/components/schemas/DocumentReference"}}},"required":true}},"responses":{"Success":{"content":{"application/fhir+json;version=1":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Success Response","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/CorrelationId"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"Error":{"content":{"application/fhir+json;version=1":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Error Response","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/CorrelationId"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}}},"schemas":{"OperationOutcome":{"properties":{"resourceType":{"enum":["OperationOutcome"],"type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"implicitRules":{"description":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","pattern":"\\S*","type":"string"},"language":{"description":"The base language in which the resource is written.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"text":{"$ref":"#/components/schemas/Narrative"},"issue":{"items":{"$ref":"#/components/schemas/OperationOutcomeIssue"},"minItems":1,"type":"array"}},"required":["issue","resourceType"],"type":"object"},"OperationOutcomeIssue":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"severity":{"description":"Indicates whether the issue indicates a variation from successful processing.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"code":{"description":"Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"details":{"$ref":"#/components/schemas/CodeableConcept"},"diagnostics":{"description":"Additional diagnostic information about the issue.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"location":{"items":{"description":"This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"type":"array"},"expression":{"items":{"description":"A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"type":"array"}},"required":["code","severity"],"type":"object"},"DocumentReference":{"properties":{"resourceType":{"enum":["DocumentReference"],"type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once assigned by the NRL, this value never changes.","pattern":"^(?=.{1,64}$)[A-Za-z0-9\\.]+-[A-Za-z0-9]+[A-Za-z0-9\\_\\-]*$","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"implicitRules":{"description":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","pattern":"\\S*","type":"string"},"language":{"description":"The base language in which the resource is written.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"masterIdentifier":{"$ref":"#/components/schemas/Identifier"},"identifier":{"items":{"$ref":"#/components/schemas/Identifier"},"type":"array"},"status":{"description":"The status of this document reference.","pattern":"^current$","type":"string"},"docStatus":{"description":"The status of the underlying document.","pattern":"^(entered-in-error|amended|preliminary|final)$","type":"string"},"type":{"$ref":"#/components/schemas/TypeCategoryCodeableConcept"},"category":{"items":{"$ref":"#/components/schemas/TypeCategoryCodeableConcept"},"type":"array"},"subject":{"$ref":"#/components/schemas/SubjectReference"},"date":{"description":"When the document reference was created. This will be generated by NRL on pointer creation.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"author":{"items":{"$ref":"#/components/schemas/OdsCodeReference"},"maxItems":1,"minItems":1,"type":"array"},"authenticator":{"$ref":"#/components/schemas/Reference"},"custodian":{"$ref":"#/components/schemas/OdsCodeReference"},"relatesTo":{"items":{"$ref":"#/components/schemas/DocumentReferenceRelatesTo"},"type":"array"},"description":{"description":"Human–readable description of the source document.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"securityLabel":{"items":{"$ref":"#/components/schemas/CodeableConcept"},"type":"array"},"content":{"items":{"$ref":"#/components/schemas/DocumentReferenceContent"},"minItems":1,"type":"array"},"context":{"$ref":"#/components/schemas/DocumentReferenceContext"}},"required":["author","category","content","context","custodian","resourceType","status","subject","type"],"type":"object"},"Bundle":{"properties":{"resourceType":{"enum":["Bundle"],"type":"string"},"id":{"description":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"implicitRules":{"description":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","pattern":"\\S*","type":"string"},"language":{"description":"The base language in which the resource is written.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"identifier":{"$ref":"#/components/schemas/Identifier"},"type":{"description":"Indicates the purpose of this bundle – how it is intended to be used.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"timestamp":{"description":"The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"total":{"description":"If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.","format":"int32","type":"integer"},"link":{"items":{"$ref":"#/components/schemas/BundleLink"},"type":"array"},"entry":{"items":{"$ref":"#/components/schemas/BundleEntry"},"type":"array"},"signature":{"$ref":"#/components/schemas/Signature"}},"required":["resourceType","type"],"type":"object"},"BundleEntry":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"link":{"items":{"$ref":"#/components/schemas/BundleLink"},"type":"array"},"fullUrl":{"description":"The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.","pattern":"\\S*","type":"string"},"resource":{"$ref":"#/components/schemas/DocumentReference"},"search":{"$ref":"#/components/schemas/BundleEntrySearch"},"request":{"$ref":"#/components/schemas/BundleEntryRequest"},"response":{"$ref":"#/components/schemas/BundleEntryResponse"}},"type":"object"},"BundleEntryResponse":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"status":{"description":"The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"location":{"description":"The location header created by processing this operation, populated if the operation returns a location.","pattern":"\\S*","type":"string"},"etag":{"description":"The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"lastModified":{"description":"The date/time that the resource was modified on the server.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"outcome":{"$ref":"#/components/schemas/DocumentReference"}},"required":["status"],"type":"object"},"BundleEntryRequest":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"method":{"description":"In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"url":{"description":"The URL for this entry, relative to the root (the address to which the request is posted).","pattern":"\\S*","type":"string"},"ifNoneMatch":{"description":"If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"ifModifiedSince":{"description":"Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"ifMatch":{"description":"Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"ifNoneExist":{"description":"Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL – what follows the \"?\" (not including the \"?\").","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"required":["method","url"],"type":"object"},"BundleEntrySearch":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"mode":{"description":"Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"score":{"description":"When searching, the server's search ranking score for the entry.","type":"number"}},"type":"object"},"BundleLink":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"relation":{"description":"A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1).","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"url":{"description":"The reference details for the link.","pattern":"\\S*","type":"string"}},"required":["relation","url"],"type":"object"},"DocumentReferenceContext":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"encounter":{"items":{"$ref":"#/components/schemas/Reference"},"type":"array"},"event":{"items":{"$ref":"#/components/schemas/CodeableConcept"},"type":"array"},"period":{"$ref":"#/components/schemas/Period"},"facilityType":{"$ref":"#/components/schemas/CodeableConcept"},"practiceSetting":{"$ref":"#/components/schemas/TypeCategoryCodeableConcept"},"sourcePatientInfo":{"$ref":"#/components/schemas/Reference"},"related":{"items":{"$ref":"#/components/schemas/Reference"},"type":"array"}},"required":["practiceSetting"],"type":"object"},"DocumentReferenceContent":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"attachment":{"$ref":"#/components/schemas/Attachment"},"format":{"$ref":"#/components/schemas/NRLFormatCode"},"extension":{"items":{"$ref":"#/components/schemas/DocumentReferenceContent_extension_inner"},"minItems":1,"type":"array"}},"required":["attachment","extension","format"],"type":"object"},"DocumentReferenceRelatesTo":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"code":{"description":"The type of relationship that this document has with anther document.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"target":{"$ref":"#/components/schemas/Reference"}},"required":["code","target"],"type":"object"},"OdsCodeReference":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"identifier":{"$ref":"#/components/schemas/OdsCodeIdentifier"},"display":{"description":"Plain text name of the organisation referenced.","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"required":["identifier"],"type":"object"},"SubjectReference":{"description":"The patient to whom the document pertains, referenced by NHS number.","properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"identifier":{"$ref":"#/components/schemas/SubjectIdentifier"}},"required":["identifier"],"type":"object"},"OdsCodeIdentifier":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"use":{"description":"The purpose of this identifier.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"system":{"description":"Must be the ODS code URL.","enum":["https://fhir.nhs.uk/Id/ods-organization-code"],"type":"string"},"value":{"description":"The ODS code of the organisation.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"period":{"$ref":"#/components/schemas/Period"}},"required":["system","value"],"type":"object"},"SubjectIdentifier":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"use":{"description":"The purpose of this identifier.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"system":{"description":"Must be the NHS number URL.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"Must be a valid NHS number.","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"required":["system","value"],"type":"object"},"Attachment":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"contentType":{"description":"Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"language":{"description":"The human language of the content. The value can be any valid value according to BCP 47.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"data":{"description":"The actual data of the attachment – a sequence of bytes, base64 encoded.","pattern":"(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+","type":"string"},"url":{"description":"A location where the data can be accessed.","pattern":"\\S*","type":"string"},"size":{"description":"The number of bytes of data that make up this attachment (before base64 encoding, if that is done).","format":"int32","type":"integer"},"hash":{"description":"The calculated hash of the data using SHA–1. Represented using base64.","pattern":"(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+","type":"string"},"title":{"description":"A label or set of text to display in place of the data.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"creation":{"description":"The date that the attachment was first created.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?","type":"string"}},"required":["contentType","url"],"type":"object"},"CodeableConcept":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"coding":{"items":{"$ref":"#/components/schemas/Coding"},"type":"array"},"text":{"description":"A human language representation of the concept.","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"type":"object"},"TypeCategoryCodeableConcept":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"coding":{"items":{"$ref":"#/components/schemas/TypeCategoryCoding"},"type":"array"},"text":{"description":"A human language representation of the concept.","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"required":["coding"],"type":"object"},"Coding":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"system":{"description":"The identification of the code system that defines the meaning of the symbol in the code.","pattern":"\\S*","type":"string"},"version":{"description":"The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"code":{"description":"A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"display":{"description":"A representation of the meaning of the code in the system, following the rules of the system.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"userSelected":{"description":"Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays).","type":"boolean"}},"type":"object"},"TypeCategoryCoding":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"system":{"description":"The URL of the system that defines the code.","enum":["http://snomed.info/sct"],"type":"string"},"version":{"description":"The version of the code system which was used when choosing this code.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"code":{"description":"The code value in the syntax defined by the system.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"display":{"description":"The textual representation of the meaning of the code in the system, following the rules of the system.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"userSelected":{"description":"Indicates whether this coding was chosen by a user directly – e.g. off a pick list of codes or displays.","type":"boolean"}},"required":["code","display","system"],"type":"object"},"Extension":{"properties":{"valueCodeableConcept":{"$ref":"#/components/schemas/CodeableConcept"},"url":{"description":"The reference details for the link.","pattern":"\\S*","type":"string"}},"type":"object"},"ContentStabilityExtension":{"allOf":[{"$ref":"#/components/schemas/Extension"},{"properties":{"url":{"enum":["https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"],"type":"string"},"valueCodeableConcept":{"$ref":"#/components/schemas/ContentStabilityExtensionValueCodeableConcept"}},"required":["url","valueCodeableConcept"],"type":"object"}]},"ContentStabilityExtensionValueCodeableConcept":{"allOf":[{"$ref":"#/components/schemas/CodeableConcept"},{"properties":{"coding":{"items":{"$ref":"#/components/schemas/ContentStabilityExtensionCoding"},"maxItems":1,"minItems":1,"type":"array"}},"required":["coding"],"type":"object"}]},"ContentStabilityExtensionCoding":{"allOf":[{"$ref":"#/components/schemas/Coding"},{"properties":{"system":{"enum":["https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability"],"type":"string"},"code":{"description":"Indicates whether or not the content is dynamically generated at the time of the request.","enum":["static","dynamic"],"type":"string"},"display":{"enum":["Static","Dynamic"],"type":"string"}},"required":["code","display","system"],"type":"object"}]},"NRLRetrievalMechanismExtension":{"allOf":[{"$ref":"#/components/schemas/Extension"},{"properties":{"url":{"enum":["https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism"],"type":"string"},"valueCodeableConcept":{"$ref":"#/components/schemas/NRLRetrievalMechanismExtensionValueCodeableConcept"}},"required":["url","valueCodeableConcept"],"type":"object"}]},"NRLRetrievalMechanismExtensionValueCodeableConcept":{"allOf":[{"$ref":"#/components/schemas/CodeableConcept"},{"properties":{"coding":{"items":{"$ref":"#/components/schemas/NRLRetrievalMechanismExtensionCoding"},"maxItems":1,"minItems":1,"type":"array"}},"required":["coding"],"type":"object"}]},"NRLRetrievalMechanismExtensionCoding":{"allOf":[{"$ref":"#/components/schemas/Coding"},{"properties":{"system":{"enum":["https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism"],"type":"string"},"code":{"enum":["SSP","Direct","LDR","InContext"],"type":"string"},"display":{"enum":["Spine Secure Proxy","Direct","Large Document Retrieval","Direct using In-Context"],"type":"string"}},"required":["code","display","system"],"type":"object"}]},"NRLFormatCode":{"allOf":[{"$ref":"#/components/schemas/Coding"},{"properties":{"system":{"description":"The system URL for the NRLF Format Code.","enum":["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"],"type":"string"},"code":{"description":"The code representing the format of the document.","enum":["urn:nhs-ic:record-contact","urn:nhs-ic:unstructured"],"type":"string"},"display":{"description":"The display text for the code.","enum":["Contact details (HTTP Unsecured)","Unstructured Document"],"type":"string"}},"required":["code","display","system"],"type":"object"}]},"Identifier":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"use":{"description":"The purpose of this identifier.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"type":{"$ref":"#/components/schemas/CodeableConcept"},"system":{"description":"Establishes the namespace for the value – that is, a URL that describes a set values that are unique.","pattern":"\\S*","type":"string"},"value":{"description":"The portion of the identifier typically relevant to the user and which is unique within the context of the system.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"period":{"$ref":"#/components/schemas/Period"},"assigner":{"$ref":"#/components/schemas/Reference"}},"type":"object"},"Period":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"start":{"description":"The start of the period. The boundary is inclusive.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?","type":"string"},"end":{"description":"The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?","type":"string"}},"type":"object"},"Quantity":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"value":{"description":"The value of the measured amount. The value includes an implicit precision in the presentation of the value.","type":"number"},"comparator":{"description":"How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"unit":{"description":"A human–readable form of the unit.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"system":{"description":"The identification of the system that provides the coded form of the unit.","pattern":"\\S*","type":"string"},"code":{"description":"A computer processable form of the unit in some unit representation system.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"}},"type":"object"},"Reference":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"reference":{"description":"A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.","pattern":"[ \\r\\n\\t\\S]+","type":"string"},"type":{"description":"The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).","pattern":"\\S*","type":"string"},"identifier":{"$ref":"#/components/schemas/Identifier"},"display":{"description":"Plain text narrative that identifies the resource in addition to the resource reference.","pattern":"[ \\r\\n\\t\\S]+","type":"string"}},"type":"object"},"Signature":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"type":{"items":{"$ref":"#/components/schemas/Coding"},"minItems":1,"type":"array"},"when":{"description":"When the digital signature was signed.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"who":{"$ref":"#/components/schemas/Reference"},"onBehalfOf":{"$ref":"#/components/schemas/Reference"},"targetFormat":{"description":"A mime type that indicates the technical format of the target resources signed by the signature.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"sigFormat":{"description":"A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"data":{"description":"The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.","pattern":"(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+","type":"string"}},"required":["type","when","who"],"type":"object"},"Meta":{"properties":{"id":{"description":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"versionId":{"description":"The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.","pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"lastUpdated":{"description":"When the resource last changed – e.g. when the version changed.","pattern":"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))","type":"string"},"source":{"description":"A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.","pattern":"\\S*","type":"string"},"profile":{"items":{"description":"A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url).","pattern":"\\S*","type":"string"},"type":"array"},"security":{"items":{"$ref":"#/components/schemas/Coding"},"type":"array"},"tag":{"items":{"$ref":"#/components/schemas/Coding"},"type":"array"}},"type":"object"},"Narrative":{"properties":{"id":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"status":{"description":"The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.","pattern":"[^\\s]+(\\s[^\\s]+)*","type":"string"},"div":{"description":"The actual narrative content, a stripped down version of XHTML.","type":"string"}},"required":["div","status"],"type":"object"},"DocumentId":{"pattern":"[A-Za-z0-9\\-\\.]{1,64}","type":"string"},"RequestPathParams":{"properties":{"id":{"$ref":"#/components/schemas/DocumentId"}},"required":["id"],"type":"object"},"RequestHeader":{"properties":{"odsCode":{"$ref":"#/components/schemas/RequestHeaderOdsCode"}},"required":["odsCode"],"type":"object"},"RequestParams":{"properties":{"subject:identifier":{"$ref":"#/components/schemas/RequestQuerySubject"},"type":{"$ref":"#/components/schemas/RequestQueryType"},"category":{"$ref":"#/components/schemas/RequestQueryCategory"}},"required":["subject:identifier"],"type":"object"},"RequestQuerySubject":{"example":"https://fhir.nhs.uk/Id/nhs-number|9000000017","pattern":"^https\\:\\/\\/fhir\\.nhs\\.uk\\/Id\\/nhs-number\\|(\\d+)$","type":"string"},"RequestQueryType":{"example":"http://snomed.info/sct|736253002","type":"string"},"RequestQueryCategory":{"example":"http://snomed.info/sct|734163000","type":"string"},"RequestHeaderOdsCode":{"type":"string"},"RequestHeaderRequestId":{"example":"60E0B220-8136-4CA5-AE46-1D97EF59D068","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"RequestHeaderCorrelationId":{"example":"11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA","type":"string"},"DocumentReferenceContent_extension_inner":{"description":"Additional extensions which include Content Stability and Retrieval Mechanism.","oneOf":[{"$ref":"#/components/schemas/ContentStabilityExtension"},{"$ref":"#/components/schemas/NRLRetrievalMechanismExtension"},{"$ref":"#/components/schemas/Extension"}]}}}}