Exporting order results from FastFinder via CSV
Workflow 2.5
Purpose of this document
This document describes the default FastFinder Order results CSV export that is available to send details of finalized orders to external systems from FastFinder.
In this document, we will cover the specification of the FastFinder Order results CSV export. In addition, an example is be provided.
Note that this export is only available for workflows that use protocols.
Export specification
When an order is finalized, i.e. the order is completed or the order is failed, a CSV export is automatically generated and stored in the FastFinder tenant storage outbox/orders/results. The file name follows this convention:
Orders_{yyyy}-{MM}-{dd}T{hh}_{mm}_{ss}.csv
where:
- yyyy: the year of the UTC timestamp at which the order results file was created
- MM: the month of the UTC timestamp at which the order results file was created
- dd: the day of the UTC timestamp at which the order results file was created
- hh: the hour of the UTC timestamp at which the order results file was created
- mm: the minutes of the UTC timestamp at which the order results file was created
- ss: the seconds of the UTC timestamp at which the order results file was created
e.g. Orders_2024-09-17T10_16_40.csv (for Sept 17, 2024 at 10:16:40 UTC)
The export can also be downloaded from the Runs archive using the Download link in the Export column. The headers of the CSV file are described below:
Header name | Description |
SampleID | Sample ID of the order |
SampleType | Primary sample type of the order |
TestCode | Test code of the order |
Status | Final state of the order. This can be Completed or Failed. |
CreationDateTimeUTC | Date and time in UTC in ISO format when the order was created |
CompletionDateTimeUTC | Date and time in UTC in ISO format when the order was completed or failed |
FailCode | Failure code that is related to the Cancel with export code, if the status of the order was Failed. Otherwise this is empty |
Future export updates
This CSV file will inevitably grow over time to include more data. To ensure your integrations work smoothly across FastFinder updates, please use column headers to distinguish between different pieces of data as these will never change over time.
Example
Example of an order results file with some completed and a failed order
1 | "SampleID","SampleType","TestCode","Status","CreationDateTimeUTC","CompletionDateTimeUTC","FailCode" |
2 | "S1001","Swab","CMV","Completed","2024-09-16T12:29:47","2024-09-17T10:16:40","" |
3 | "S1001","Swab","RSV","Completed","2024-09-16T12:29:47","2024-09-17T10:16:40","" |
4 | "S1002","Swab","RSV","Failed","2024-09-16T12:29:47","2024-09-17T10:16:40","FailedExtraction" |