Working with FHIR Data
Now that we have gone through all CRUD operations, we can put them together to effectively work with FHIR data. This guide will go through a common healthcare workflow, creating an order for lab tests (a.k.a. ServiceRequest in FHIR) for patients and when the lab test is complete, creating results (a.k.a. Observation and DiagnosticReport in FHIR) that correspond to the original ServiceRequest.
This example will illustrate how to create FHIR objects, how to update them, how to link them, and then how to read them back in bulk. Here is a breakdown of the workflow at a high level:
- Use FHIR batch request to create a
Patientand aServiceRequest.- This will use a conditional to only create the
Patientif it does not already exist. - It will also link the
ServiceRequestto thePatient.
- This will use a conditional to only create the
- Create an
ObservationandDiagnosticReport. - Read back the
DiagnosticReportandObservation.- Use a batch request to read all
Observationresources in one go, versus making multiple requests.
- Use a batch request to read all
Creating the Patient and Service Request
Creating a Patient and a ServiceRequest sounds simple, but there are several nuances. If the Patient already exists, a new one should not be created. We also need to ensure that the ServiceRequest is linked to the correct patient.
Creating Patient
Creating a Patient if one does not exist uses the conditional create logic in FHIR. In this example, a patient has a Medical Record Number or MRN. If that MRN exists, then a new patient should not be created. In a lab workflow, it is common for a lab to serve patients repeatedly. In this case where there is already a patient in the system, it would be incorrect (and confusing) to make a new patient record.
| |
This example uses the MedplumClient from the Medplum SDK to interact with the FHIR API. The createResourceIfNoneExists method is a helper that performs a search before creating the resource.
The behavior of the the Patient.identifier field is important to note. Patient.identifier usually has a reference string or URL that describes which system that identifier came from. Identifiers are a concept in FHIR which describe the context in which that identifier is generated, for example, and identifier could be a Social Security Number (SSN) or be created by a health system for their own internal purposes. Here is an example of an identifier scheme for the Australian Healthcare system.
We recommend that providers put documentation of their identifier system online for interoperability purposes.
Performing an Upsert
In some cases, you may want to update the resource in place if it already exists in the system, in addition to creating it if it doesn't exist yet. This is accomplished via a combined "update" and "insert" operation: an "upsert".
Provide the current version of the resource and a search query, similar to createResourceIfNoneExists().
// An "upsert" (i.e. update/insert) will either update the resource in place if it
// already exists, otherwise is will be created. This is performed in a single,
// transactional request to guarantee data consistency.
const updatedPatient = medplum.upsertResource(patient, 'identifier=' + exampleMrn);
console.log('Patient record updated', updatedPatient);medplum put 'Patient?identifier=<exampleMrn>' <patientResource>curl -X PUT 'https://api.medplum.com/fhir/R4/Patient?identifier=<exampleMrn>' \
-H 'authorization: Bearer $ACCESS_TOKEN' \
-H 'content-type: application/fhir+json' \
-d '<patientResource>'Create the ServiceRequest
Creating a new ServiceRequest also has some nuance to it. ServiceRequests in this context can be thought of as a "requisition for a lab test" and the ServiceRequest.code specifies what test panel is being ordered. Most labs will have a concept of a test menu and that should indicate which labs should be run for this service request.
Note that there are many fields on the requisition, and filling them in with the right data is crucial. This example is minimal for clarity.
| |
If you are using the hosted Medplum service you can see your ServiceRequest objects here. Similarly, you can see Patients here.
Creating the Diagnostic Report
Once the lab test has been completed and the specimens analyzed, it is time to create a diagnostic report - but it is really important to link that diagnostic report back to the Patient and the corresponding ServiceRequest.
To get this to be linked up, you'll need to have the identifiers for the Patient and ServiceRequest that were created in the previous section.
You can then create a diagnostic report using the function below.
Create the Observations
| |
Create Report
| |
This will create a DiagnosticReport that is linked to the ServiceRequest and to the Patient. If you are using hosted Medplum, you can view all DiagnosticReports here.
Next Steps
Now that you have created and linked your FHIR resources, you can:
- Search for these resources using FHIR Search.
- Automate workflows using Bots.
- Visualize the data in a React Application.
Conclusion
Hopefully this simple lab workflow, "ordering a lab" and "getting a lab report" was a good beginner illustration on getting started with FHIR. We welcome your feedback. Please feel free to file issues or submit pull requests.
This sample is based on a service where data is hosted on Medplum, but for those who need the data stored on premise, we do support self-hosting the backend.