Describes the FHIR R5 capabilities of the SENAITE FHIR API when operating as the server (API provider). Covers the lab request and results workflow and the instrument integration workflow.

The transaction-response Bundle returned by the server after successfully processing a SenaiteRequestBundle. One entry is returned per entry in the request, in the same order. Each entry carries the server-assigned fullUrl and a response status. No resource body or request element is included.

A transaction Bundle used to submit a laboratory service request to SENAITE. The ServiceRequest is the backbone of the Bundle. All referenced resources (Patient, Encounter, Practitioner, Location, Organization, Specimen) must be included as entries so the server can resolve intra-Bundle references. Resource instances may not yet exist on the server; entries use POST so the server creates them and assigns logical IDs.

Represents the JSON Patch body used to cancel (revoke) a SenaiteServiceRequest. Sent as a PATCH to /ServiceRequest/{id}. Contains exactly one operation: replace /status with revoked.

The OperationOutcome returned with a 409 Conflict when a ServiceRequest cannot be revoked, for example because results have already been published in SENAITE.

The ServiceRequest resource returned by the server in the 200 OK response body after a successful cancellation PATCH. Identical to SenaiteServiceRequest but with status fixed to revoked and meta.versionId required to confirm the update was applied.

This is the results for the lab test requested by the ServiceRequest - as such it requires a basedOn link to the Service Request. It may contain either the pdf file in presentedForm or the quantitative results as Observations in results.

This resource is used to capture the location in which the Service Request was made

A single quantitative result produced by an instrument and pushed to SENAITE or made available within a SenaiteDiagnosticReport bundle.

• code (LOINC) identifies the specific analyte, matched against ServiceRequest.orderDetail codes.
• basedOn links the result back to the originating ServiceRequest.
• device optionally identifies the instrument that produced the result.

Used to specify the Organization who makes a SenaiteServiceRequest. Usually via an SenaiteEncounter.

Demographic details of the patient

The Practitioner that orders the test.

This will be an incoming lab request. It relies on references to:

• Specimen: to handle the related specimen details.
• Subject: The patient
• Encounter: Determining where and when the request originated.
• Requester: The practitioner who made the request.

This is the specimen to accompany the ServiceRequest

Transaction bundle containing patient, organization, location, practitioner, encounter, specimen, and service request resources for a liver panel test order.

Transaction response bundle for the liver panel service request, containing created resource IDs.

OperationOutcome returned when a ServiceRequest references an unknown LOINC panel code, causing transaction rollback.

Parameters resource for cancelling a liver panel service request using JSON Patch operations.

Represents a laboratory instrument that produces results in SENAITE. Used to identify the source instrument of an Observation, supporting multi-device labs and enabling per-instrument QC and audit trails. If SENAITE does not recognise the device identifier it will be created using the supplied fields.

Chemistry analyser used for liver panel and general biochemistry panels.

Haematology analyser used for full blood count panels.

Albumin result pushed by the Roche Cobas c502 for the liver panel ServiceRequest.

Alkaline phosphatase result pushed by the Roche Cobas c502 for the liver panel ServiceRequest.

Alanine aminotransferase result pushed by the Roche Cobas c502 for the liver panel ServiceRequest.

Aspartate aminotransferase result pushed by the Roche Cobas c502 for the liver panel ServiceRequest.

Hemoglobin result pushed by the Sysmex XN-1000 for the CBC ServiceRequest.

Platelet count pushed by the Sysmex XN-1000 for the CBC ServiceRequest.

Red blood cell count pushed by the Sysmex XN-1000 for the CBC ServiceRequest.

Total bilirubin result pushed by the Roche Cobas c502 for the liver panel ServiceRequest.

White blood cell count pushed by the Sysmex XN-1000 for the CBC ServiceRequest.

If the date of birth is unknown to a high degree of precision

DiagnosticReport for a Full Blood Count (CBC) panel with references to component Observations and an attached PDF.

DiagnosticReport for a urinalysis panel represented as a PDF attached in presentedForm.

Finished encounter associated with a visit to the outpatient lab, referencing the lab location and service provider.

A finished outpatient encounter occurring at a GP Office.

Location representing the General Hospital outpatient laboratory used by the examples.

Observation resource for hemoglobin measurement in blood.

Observation resource for platelet count in blood.

Observation resource for red blood cell count in blood.

Observation resource for white blood cell count in blood.

Organization resource representing the Microbiology laboratory including contact details and address.

Patient resource for Alex Miller used in examples, containing basic demographics and identifier.

Patient resource for Jane Doe with an estimated birth date indicated by the EstimatedDateBirth extension.

Practitioner resource for John Smith used in examples.

Practitioner resource for Kim Nguyen used in examples.

ServiceRequest for a Full Blood Count (CBC) panel including order details for component tests and specimen reference.

ServiceRequest for a urinalysis panel including multiple orderDetail codes for individual urine tests.

Specimen representing a urine specimen collected at the specified date/time.

Specimen representing a collected venous blood specimen used for CBC testing.