Retrieve a signed provider note

If you want to access a provider’s note for a patient, you can use this API action to retrieve a list of related documents. Typically, you can use this for: 

  • reading notes to pre-populate a patient’s progress in the EHR system (e.g., natural language processing);
  • performing follow-up services after a patient visit; or
  • using notes for charging for durable medical equipment.

Patient identifier required

To use this API action, you must know the patient identifier. If you don’t, you must locate the appropriate identifier first. Learn how to search for a patient with demographics.

Supported systems

You can use this API action with the Redox FHIR® API.

Talk to a Redoxer

It’s also possible to use the Redox Data Model API for this API action. Talk to a Redoxer to learn about your options if you want to use alternative integration methods.

Your connection's system can return results with their own FHIR® or query-based API. 

Using data on demand

It's possible that your connection's system can't support a query-based data exchange, but they may still be willing to provide results with a push-based method.

However, we understand that you may not want to store all that data—maybe you don't need all possible results and just want to query for what you want when you need it. If so, you can use this API action via our data on demand service, which stores the connection's data so that you can query from Redox "on demand." Learn more about data on demand.

Things you need to know

What's next?

Does this API action seem like a good fit for your unique workflow? If so, let your Redox rep know! You can begin development by downloading the relevant resource schema (which is noted in the relevant action step below), and deciding which data elements you need. Then head over to our Quickstart guide to dive right in.

If you're not engaged with our sales team yet, talk to a Redoxer to get started.

Action steps

Prerequisites

The following actions must be completed before attempting the steps below.

Steps

Retrieve a list of signed provider notes within a date range

We recommend combining this step with the step for retrieving a signed provider note. Here's why you might want to use this combo: If you don't have a specific document ID or enough criteria to narrow your search for a particular note, you could search for a list of potentially related notes instead. You can review the list to see which note is most relevant, then use the document ID to retrieve that note.

For this type of use case, complete this step first, then perform the action step for retrieving a signed provider note.

This table has notes about how to use parameters for this action step specifically, but it's not exhaustive. Refer to the resource schema for more details.

Query parameter
Required for this step
Notes
_elements
Y
We recommend using this FHIR® search parameter to hone the search results that are returned. With this parameter, you can specify a comma-separated list of elements you want to retrieve. We recommend entering subject,masterIdentifier,date,type,context so that you have enough data to identify which note you want from the list without cluttering the results with the actual note contents, which you can retrieve with your next search.
Learn more about FHIR® search parameters.
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying.
date
Y
This specifies when the DocumentReference resource was created for the signed provider note. You can define a date range using _lt and _gt parameters to narrow down the results to the most likely matches.

Your search returns a list of notes with their identifiers, date, context, or other fields you requested. Copy the identifier of the note that looks most relevant to you, then complete the step for retrieving a signed provider note.

Query Response
Open dropdown
Open dropdown

Retrieve a signed provider note

You can complete this step on its own if you already have the document ID for the signed provider note you're searching for. Or, you can complete this as a secondary step after locating the document ID from the step to retrieve a list of document notes within a date range.

This table has notes about how to use parameters for this action step specifically, but it's not exhaustive. Refer to the resource schema for more details.

Query parameter
Required for this step
Notes
identifier
Y
This is the master identifier for the signed provider note that you're searching for.
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying.

Your search returns the specific note you're looking for.

Query Response
Open dropdown
Open dropdown

Retrieve a signed provider note for one encounter

If you want a signed provider note from a specific patient encounter but you don't have the document ID, you can retrieve the relevant note with the encounter ID instead. You can do this step independently of the other two.

This table has notes about how to use parameters for this action step specifically, but it's not exhaustive. Refer to the resource schema for more details.

Query parameter
Required for this step
Notes
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying.
encounter
Y
This is the identifier for the encounter associated with the provider note, which provides context for the signed provider note.

Your search returns the signed note from the specific encounter.

Query Response
Open dropdown
Open dropdown