Skip to main content

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

Page contents

Overview

NRL
producer
system
NRL...
2. Retrieve pointers
2. Retrieve pointers
Spine
Directory
Service
(SDS)
Spine...
National
Record
Locator
(NRL)
National...
Spine
Secure
Proxy
(SSP)
Spine...
4. Retrieve information
from producer
4. Retrieve information...
NRL
consumer
system

NRL...
3. Look up
provider ASID
3. Look up...
1. Create & manage pointers
1. Create & manage pointers
5. Retrieve information
from producer
5. Retrieve information...
Text is not SVG - cannot display How NRL works with Spine Secure proxy and the Spine Directory Service to retrieve information pointers from producers and give them to consumers.


Use this API to locate and access patient information shared by other healthcare organisations, to support the direct care of those patients, using the National Record Locator (NRL).

As a "provider" or "producer" who holds information about patients, you can:

  • create a pointer in the NRL to your information
  • replace your NRL pointer with a newer pointer, superseding the old one
  • update your NRL pointer status to "entered in error"
  • delete your NRL pointer to this information

As a "consumer" who needs access to the patient information being shared by providers, you can:

  • search for information by parameters including information ID, patient, information provider, information type,  or number of matching results
  • retrieve an NRL pointer and access the information

There is a growing list of health and social care organisations authorised to share records using NRL.


Versions

This API has multiple versions as follows:

Version Status Use case Documentation
Version 3 Beta Provider or producer

National Record Locator - FHIR API v3 - Producer

Version 3 Beta Consumer 

National Record Locator - FHIR API v3 - Consumer

Version 2.8.0 In production Provider and consumer

National Record Locator - FHIR API v2.8.0

Last edited: 23 February 2024 8:13 am