Glossary

The glossary below contains a list of main terms and their explanation.

TermDescription
API keyAccess token used to authenticate requests to Ornament APIs (retrieved from Ornament Pro → Account → Developer tools).
BiomarkerA biological characteristic that can be objectively measured, including the result of a specific medical test (e.g. glucose level, protein presence in blood plasma).
Biomarker categoryClassification group for biomarkers, available via the Thesaurus API.
BiomaterialBiological specimen or sample type associated with a biomarker measurement.
Custom reference rangePartner-defined reference ranges that may override default Ornament reference values.
Default unitCanonical internal measurement unit used by Ornament for a biomarker.
DigitizationProcess of converting uploaded medical documents into structured medical data.
Digitization completion eventWebhook event fired when processing finishes (e.g. NEW_SUBMISSION, REJECT_IMAGESET, SPLIT_IMAGESET).
File groupA logical unit inside a fileset representing one document package; must follow an allowed upload template (e.g. images, PDF, XML, JSON).
FilesetA container linked to a profile for uploading documents for digitization; may contain one or more file groups.
IID (Imageset ID)Unique identifier of an imageset used in digitization and webhook payloads.
ImagesetA set of images/files for which digitization is carried out. One imageset describes one laboratory test (e.g. complete blood count) or a complex of tests performed by one laboratory on one date.
Linked profileA profile relationship concept used in the Accounting API to represent connected user profiles.
Measurement unitUnit entity returned by the Thesaurus API describing how biomarker values are measured.
Original unitMeasurement unit from the source document associated with the original value.
Original valueRaw value as it appears in the source document before normalization.
PID (Profile ID)Unique identifier of a user or patient profile used to retrieve medical data such as submissions and biomarkers.
Production environmentLive environment using production API base URLs intended for real integrations.
Recognition resultsStructured data produced after digitization, including biomarkers, values, units, and reference ranges.
Reference valuesRange of biomarker values considered normal or optimal; may vary depending on age, gender, chronic conditions, pregnancy, and other factors.
Sandbox environmentTesting environment using sandbox API base URLs; automatic digitization is disabled, but sample pre-digitized files are available.
SEID (Submission Entry ID)Unique identifier of a single biomarker measurement entry within a submission.
SID (Submission ID)Unique identifier of a submission created from an imageset.
SubmissionIn the Ornament system, a submission is a set of biomarkers and their values obtained as a result of digitizing an imageset.
Thesaurus APIDictionary-style API providing standardized entities such as biomarkers, units, diseases, and biomaterials.
WebhookHTTP callback sent to a partner endpoint to notify about digitization lifecycle events.