ornament API

Getting Started
Creating a Patient Profile
Digitization of Laboratory Analyses
Ornament Interpretation Engine
Ornament API Sandbox
Contact Support

Accounting API

Patient account
- Create a patient profilepost

File API

Fileset
Filegroup

Image Set API

Imageset
- Create new imageset from filesetpost

Health Advisor API

Health Conditions
- Profile Health Conditionsget

Medical Data API

Biomarkers
- Get Profile Biomarkersget
- Get Profile Biomarker By IDget
Profile

Thesaurus API

Digest
Biomarkers
- Get Biomarker Categoriesget
- Biomarkers V1 1post
Biomaterials
- Get Biomaterials dataget
Diseases
- Diseasespost
Human Parts
- Get Human Partsget
Medical Exams
- Medical Examspost
Medication
- Get Medication by Titleget
- Get Medications by IDspost
Substances
- Get Substancesget
Popular Labs
- Get Popular Labsget
Healer Specialities
- Get Healer Specialitiesget
Measurement Units
- Get Measurement Unitsget
Messenger Types
- Get Messenger Typesget

ornament API

Getting Started
Creating a Patient Profile
Digitization of Laboratory Analyses
Ornament Interpretation Engine
Ornament API Sandbox
Contact Support

Accounting API

Patient account
- Create a patient profilepost

File API

Fileset
Filegroup

Image Set API

Imageset
- Create new imageset from filesetpost

Health Advisor API

Health Conditions
- Profile Health Conditionsget

Medical Data API

Biomarkers
- Get Profile Biomarkersget
- Get Profile Biomarker By IDget
Profile

Thesaurus API

Digest
Biomarkers
- Get Biomarker Categoriesget
- Biomarkers V1 1post
Biomaterials
- Get Biomaterials dataget
Diseases
- Diseasespost
Human Parts
- Get Human Partsget
Medical Exams
- Medical Examspost
Medication
- Get Medication by Titleget
- Get Medications by IDspost
Substances
- Get Substancesget
Popular Labs
- Get Popular Labsget
Healer Specialities
- Get Healer Specialitiesget
Measurement Units
- Get Measurement Unitsget
Messenger Types
- Get Messenger Typesget

Biomarkers V1 1

post https://api.ornament.health/thesaurus-api/public/v1.1/biomarkers

Get biomarker list with measurement unit synonyms:

lang: "RU" - russian title, russian synonyms
lang: "RU+EN" - russian title, russian+english synonyms
lang: "EN+RU" - english title, russian+english synonyms
lang: "EN" - english title, english synonyms
digest: "str" - Value for checking data immutability

URL Expired

The URL for this request expired after 30 days.

Body Params

lang

string

required

length between 2 and 5

Localisation language name (or a combination of languages)

digest

string

Biomarkers hexdigest

limited

boolean

Defaults to false

Return limited biomarkers list (LIMITED_MARKERS_LIST)

Responses

Response body

object

needToUpdate

boolean

required

Shows whether there are no changes on the server and the saved copy of the directory on the client is up to date.

digest

string

required

Hash string that shows whether the client data need to be updated.

biomarkers

array of objects

Biomarkers list

biomarkers

object

integer

required

Biomarker ID

title

string

required

Biomarker Title

synonyms

array of objects

required

Synonyms used for Biomarker description

synonyms*

object

title

string

required

Synonym Title

language

string

required

Language

possibleValueMax

number

Maximum Possible Value

possibleValueMin

number

Minimum Possible Value

isAllowAutounit

boolean

required

If true, you can use the auto substitution logic for the current unit based on the entered values.

biomaterialId

integer

Biomaterial ID

substanceId

integer

Substance ID

displayCategoryId

integer

required

Biomarker Category ID. Used for sorting the list and displaying the biomarker category.

pregnancyCorrelation

integer

required

Pregnancyc orrelation

sortOrder

integer

isPaid

boolean

required

Defaults to false

Shows whether the biomarker is available for users with a subscription.

articleId

integer

Article ID

unitsFactors

array of arrays of integers

required

The unit multiplier against the system unit. It is used in the application when sending a submission manually, for example (1st element is unit id, 2nd is a factor, [[27, 1000000.0], [30, 1000000.0]]).

unitsFactors*

array of integers

400

Bad request

404

Not found

Response body

object

detail

array of objects

HTTP validation details

detail

object

loc

array

required

Location

loc*

msg

string

required

Message

type

string

required

Error Type

Updated 12 months ago

Get Biomarker Categories

Biomaterials

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.ornament.health/thesaurus-api/public/v1.1/biomarkers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 12 months ago

Get Biomarker Categories

Biomaterials

Did this page help you?

ornament API
Getting Started
Errors
Biomarkers
Preparing test results for processing
Glossary
Obtaining API Key
Creating a Patient Profile
Digitization of Laboratory Analyses
Recognition Results
Subscribe to the Digitization Completion Event
Send the file set for digitization
Upload the group of files
Create a File Set
Ornament Interpretation Engine
Ornament API Sandbox
Contact Support

Accounting API
Patient account
Create a patient profilepost

File API
Fileset
Submit the file set for processingpost
Get fileset data by fileset IDget
Download the fileget
Create a file setpost
Get the fileset by PIDget
Filegroup
Delete file from the group by IDdelete
Delete a file group by the group IDdelete
Create a group of filespost
Upload a file to the existing file grouppost

Image Set API
Imageset
Create new imageset from filesetpost

Health Advisor API
Health Conditions
Profile Health Conditionsget

Medical Data API
Biomarkers
Get Profile Biomarker By IDget
Get Profile Biomarkersget
Profile
Get Profile Diseasesget
Get Images from the Profile Imagesetspost
Get Profile Submission By Sidget
Get Profile Submissions dataget
Add Linked Profile Reporting Favoritepost
Get Linked Profile Reporting Favoriteget

Thesaurus API
Digest
Biomarkers
Biomarkers V1 1post
Get Biomarker Categoriesget
Biomaterials
Get Biomaterials dataget
Diseases
Diseasespost
Human Parts
Get Human Partsget
Medical Exams
Medical Examspost
Medication
Get Medications by IDspost
Get Medication by Titleget
Substances
Get Substancesget
Popular Labs
Get Popular Labsget
Healer Specialities
Get Healer Specialitiesget
Measurement Units
Get Measurement Unitsget
Messenger Types
Get Messenger Typesget

ornament API
Getting Started
Errors
Biomarkers
Preparing test results for processing
Glossary
Obtaining API Key
Creating a Patient Profile
Digitization of Laboratory Analyses
Recognition Results
Subscribe to the Digitization Completion Event
Send the file set for digitization
Upload the group of files
Create a File Set
Ornament Interpretation Engine
Ornament API Sandbox
Contact Support

Accounting API
Patient account
Create a patient profilepost

File API
Fileset
Submit the file set for processingpost
Get fileset data by fileset IDget
Download the fileget
Create a file setpost
Get the fileset by PIDget
Filegroup
Delete file from the group by IDdelete
Delete a file group by the group IDdelete
Create a group of filespost
Upload a file to the existing file grouppost

Image Set API
Imageset
Create new imageset from filesetpost

Health Advisor API
Health Conditions
Profile Health Conditionsget

Medical Data API
Biomarkers
Get Profile Biomarker By IDget
Get Profile Biomarkersget
Profile
Get Profile Diseasesget
Get Images from the Profile Imagesetspost
Get Profile Submission By Sidget
Get Profile Submissions dataget
Add Linked Profile Reporting Favoritepost
Get Linked Profile Reporting Favoriteget

Thesaurus API
Digest
Biomarkers
Biomarkers V1 1post
Get Biomarker Categoriesget
Biomaterials
Get Biomaterials dataget
Diseases
Diseasespost
Human Parts
Get Human Partsget
Medical Exams
Medical Examspost
Medication
Get Medications by IDspost
Get Medication by Titleget
Substances
Get Substancesget
Popular Labs
Get Popular Labsget
Healer Specialities
Get Healer Specialitiesget
Measurement Units
Get Measurement Unitsget
Messenger Types
Get Messenger Typesget

200Successful Response

422Validation Error