Get Profile Submissions data

get https://api.ornament.health/medical-data-api/public/v1.0/profile/submissions

Returns the profile submissions by PID.

Responses

Response body

object

total

integer

required

Total number of submissions whose data are contained in the response.

submissions

array of objects

required

Array of the submission objects. It also includes array of their values (lines).

submissions*

object

pid

string

required

The ID of the profile whose data is being requested.

sid

string

required

UUID of the submission

date

integer

required

UNIX timestamp of the submission date

hasDate

boolean

required

Flag for the presence of date on the submitted document

isDeleted

boolean

required

If true, the record was deleted.

originImagesetId

integer

Original imageset ID

comment

string

Comments

laboratory

object

Submission Laboratory

examTypeObjectId

integer

ID of the Examination type object

entries

array of objects

required

Submission List

entries*

object

seid

string

required

UUID of the submission entry

value

string

required

Biomarker value in internal units of measurement

rowOrder

integer

required

ID of the original Imageset, used for sorting of lines

biomarkerId

integer

required

Biomarker ID, used for retrieving the name of the biomarker for display

originalValue

string

required

Biomarker Original value

originalUnitId

integer

required

Biomarker measurement unit ID

mcdDiseases

array of objects

required

Diseases in ICD nomenclature

mcdDiseases*

object

integer

required

Submission Disease ID

title

string

required

Title for Submission Disease

confirmed

boolean

If true, the submission disease is confirmed

medicines

array of objects

required

Medical prescriptions

medicines*

object

integer

required

Submission Medicine ID

title

string

required

Submission Medicine Title

externalDatasource

string

External data source

isPreliminary

boolean

If true, the submission is preliminary (not finalized).

isFinal

boolean

If true, the submission is finalized.

refs

object

required

A set of reference values for the biomarkers in the obtained list of submissions. For each biomarker, there can be one or two ranges of reference values: normal (always) and optimal (may be absent). Normal value is always indicated in common. Optimal value may be indicated in optimal or paidOptimal. The minimum and maximum values can be equal to each other.

400

Bad request

401

Unauthorized

404

Not found

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.ornament.health/medical-data-api/public/v1.0/profile/submissions \
3
     --header 'accept: application/json'

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

application/json

200Successful Response

422Validation Error