Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Example using the product deployed for GitHub pull request 15:

The public sandbox ("Try this API") endpoints come with:

* Pre-loaded data: see [cron/seed_sandbox/data/document-pointer.json](https://github.com/NHSDigital/NRLF/blob/main/cron/seed_sandbox/data/document-pointer.json)
* Pre-loaded data
* Pre-configured organization permissions: [ConnectionMetadata.SetRequestHeaders.js](proxies/sandbox/apiproxy/resources/jsc/ConnectionMetadata.SetRequestHeaders.js)

Developers should make sure that these align according to any user journeys that they envisage.
Expand Down
22 changes: 5 additions & 17 deletions specification/record-locator/producer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ info:
| Record artifact ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008)) | Appointment ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101)) | |
| Record headings ([716931000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=716931000000107)) | Clinical summary ([887181000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=887181000000106)) | This pointer type is being used for the in-context launch pilot. Please see the 'retrieval formats and mechanisms' for more information. |
| Clinical document ([423876004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=423876004)) | About me ([1515851000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1515851000000101)) | |
| Clinical document ([423876004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=423876004)) | Hospital Discharge to Assess Plan ([HDTAP](https://github.com/NHSDigital/NRLF/tree/develop/resources/fhir/NRLF-RecordType-CodeSystem.json)) | |
| 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)) | |

You can also retrieve booking and referral pointers however you can not currently do this by directly integrating with
the National Record Locator, you must instead onboard to the [Booking and Referral - FHIR API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir)
Expand Down Expand Up @@ -109,7 +109,7 @@ info:

Any 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.

The [Controller Catalogue](https://github.com/NHSDigital/NRLF/raw/develop/resources/nrl-authorised-organisations-and-actors-catalogue.xlsx) is made up of the following sections:
The [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:

|Section|Description|
|-------|-----------|
Expand Down Expand Up @@ -141,7 +141,7 @@ info:

It 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).

Draft FHIR resources specific to this API can be found [here](https://github.com/NHSDigital/NRLF/blob/develop/resources/fhir).
Draft FHIR resources specific to this API can be found [here](https://github.com/NHSDigital/nrlf-public-resources/blob/main/fhir).

You do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.

Expand Down Expand Up @@ -178,15 +178,7 @@ info:

## Open source

You might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:

| Resource | Description | Links |
|---------------------------|-----------------------------------------------------------|-------------------------------------------------------------------|
| NRL v3 API | Source code for the core API and sandbox | [GitHub repo](https://github.com/NHSDigital/nrlf) |
| NRL v3 Producer API | Source code for the producer API proxy and specification. | [GitHub repo](https://github.com/NHSDigital/nrl-producer-api) |
| NRL v3 Consumer API | Source code for the consumer API proxy and specification. | [GitHub repo](https://github.com/NHSDigital/nrl-consumer-api) |

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).
We 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).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

best to avoid apostrophes for formal documentation 👍


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).

Expand All @@ -212,7 +204,7 @@ info:

Right click the icon and save link as... to save the Postman collection to your device

[![Right click and save link as...](https://run.pstmn.io/button.svg)](https://github.com/NHSDigital/NRLF/raw/develop/postman_collection.json)
[![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)

### Integration testing

Expand Down Expand Up @@ -423,10 +415,6 @@ info:
## Frequently Asked Questions

Answers to frequently asked questions can be found on the [developer community](https://developer.community.nhs.uk/c/national-record-locator-nrl/52).

## Change log

For details of how this API has changed over time, see the [release history](https://github.com/NHSDigital/NRLF/releases)

version: 1.0.0
license:
Expand Down
Loading