You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* [Personalised Care and Support Plan]("http://snomed.info/sct|2181441000000107")
43
-
44
-
You can also retrieve booking and referal pointers however you can not currently do this by directly integrating with
45
-
the National Record Locator, you must instead onboard to the [Booking and Referral - FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir)
46
-
47
-
### As a Consumer
48
-
49
-
Consumers can use this API to:
50
-
51
-
* search for pointers, restricted to a single Patient at a time
52
-
* read a specific pointer
53
-
* operations are restricted to document types agreed during the [onboarding](#api-description__onboarding) process
54
-
55
-
### What has changed?
56
-
57
-
This service is a replacement for the existing
58
-
[National Record Locator (NRL)](https://digital.nhs.uk/services/national-record-locator), and has the following
59
-
changes:
60
-
61
-
* upgraded from FHIR STU3 to R4.
62
-
* improved performance and scalability.
63
-
* improved onboarding experience.
64
-
* 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.
65
-
* greater flexibility, by wider support of the [FHIR R4 DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource.
66
-
* the application only supports json type FHIR, not XML (which is also valid FHIR)
67
-
68
-
### Data availability, timing and quality
69
-
70
-
Pointers are available to be consumed almost immediately after they have been produced by the provider.
71
-
72
-
## Who can use this API
73
-
74
-
This 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
75
-
too far with your development. You must demonstrate you have a valid use case as part of digital onboarding.
76
-
77
-
You must have the capability to verify NHS numbers by one of the following mechanisms:
78
-
79
-
* full PDS Spine compliant system
80
-
* Spine Mini Service PDS (SMSP)
81
-
82
-
Connecting parties must have an appointed Clinical Safety Officer and undertake a Clinical Safety Assessment.
83
-
84
-
You can not use this API to retrieve documents, however you should be prepared to retrieve in PDF or Unstructured
85
-
formats.
86
-
87
-
In order to retrieve a document, consumers must be able to interact with the National Record Locator and the Spine
88
-
Secure Proxy (SSP).
89
-
90
-
You can only use this API if your consuming application is only accessible using a valid NHS Smartcard for all users
91
-
or a system that uses an authentication method supported by
92
-
[NHS Care NHS Care Identity Service 2 (NHS CIS2)](https://digital.nhs.uk/services/identity-and-access-management/nhs-care-identity-service-2).
93
-
94
-
You must do this before you can go live (see ‘[Onboarding](#api-description__onboarding)’ below).
95
-
96
-
## API status and roadmap
97
-
98
-
This API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).
99
-
100
-
To see our roadmap, or to suggest, comment or vote on features for this API, see our
You do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.
125
-
126
-
In particular:
127
-
128
-
* resource names are capitalised and singular, and use US spellings, for example `Organization` not `organisations`
129
-
* array names are singular, for example `entry` not `entries` for address lines
130
-
* data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object
131
-
132
-
There 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.
133
-
134
-
## Network access
135
-
136
-
This 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).
137
-
138
-
For more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).
139
-
140
-
## Security and authorisation
141
-
142
-
This API uses the following access modes:
143
-
144
-
* [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)
145
-
146
-
## Errors
147
-
148
-
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
149
-
150
-
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
151
-
* 400 to 499 if it failed because of a client error by your application
152
-
* 500 to 599 if it failed because of an error on our server
153
-
154
-
Errors specific to each API 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.
155
-
156
-
## Open source
157
-
158
-
You might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:
| NRL v3 API | Source code for the core API and sandbox | [GitHub repo](https://github.com/NHSDigital/nrlf) |
163
-
| NRL v3 Producer API | Source code for the producer API proxy and specification. | [GitHub repo](https://github.com/NHSDigital/nrl-producer-api) |
164
-
| NRL v3 Consumer API | Source code for the consumer API proxy and specification. | [GitHub repo](https://github.com/NHSDigital/nrl-consumer-api) |
165
-
| Lambda Pipeline Package | Source code for the lambda pipeline utility | [GitHub repo](https://github.com/NHSDigital/nrlf-lambda-pipeline) |
166
-
| Lambda Logging Package | Source code for the lambda logging utility | [GitHub repo](https://github.com/NHSDigital/nrlf-lambda-logging) |
167
-
168
-
We currently don't have any open source client libraries or sample code 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).
169
-
170
-
The 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).
* is open access, so does not allow you to test authorisation
186
-
187
-
For details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the
188
-
documentation for each endpoint.
189
-
190
-
Alternatively, you can try out the sandbox using our Postman collection:
191
-
192
-
Right click the icon and save link as... to save the Postman collection to your device
193
-
194
-
[](https://github.com/NHSDigital/NRLF/raw/main/postman_collection.json)
195
-
196
-
### Integration testing
197
-
198
-
Our [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):
199
-
200
-
* is for formal integration testing
201
-
* includes authorisation
202
-
203
-
It also includes ready-to-use test data and scenarios. For details [contact us](https://digital.nhs.uk/developer/help-and-support).
204
-
205
-
For more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).
206
-
207
-
## Onboarding
208
-
209
-
You 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.
210
-
211
-
As 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.
212
-
213
-
Information 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-consumer-fhir/onboarding-support-information).
214
-
215
-
To 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).
<div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break"><p class="nhsd-t-body">To get started, sign in or create a <a href="http://onboarding.prod.api.platform.nhs.uk/">developer account</a>, then select 'product onboarding'.</p></div>
228
-
</div>
229
-
</div>
230
-
</div>
231
-
232
-
## Change log
233
-
234
-
For details of how this API has changed over time, see the [change log](https://github.com/NHSDigital/NRLF/blob/main/CHANGELOG.md).
0 commit comments