api-docs v5.116.0
API Docs
Table of contents
Diagnostic_Measure
Diagnostic Measure - Delete
Delete a specific diagnostic measure
DELETE /diagnostic-measures/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Examples
Example usage:
curl "https://yourdomain.com/diagnostic-measures/<diagnostic-measure-id>" \
-X DELETE \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
| Name | Type | Description |
|---|---|---|
| id | string |
|
| createdAt | number |
|
| createdBy | string |
|
| account | string |
|
| facility | string |
|
| test | string |
|
| name | string |
|
| set | string |
|
| sets | string[] |
|
| description | string |
|
| type | string |
Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
|
| unit | string |
|
| siunit | string |
|
| referenceRanges | object[] |
|
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
|
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
|
| hl7IdentifierSys | string |
|
| numericBreakdownMin | number |
|
| numericBreakdownMax | number |
|
| section | any |
for medical test |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "id-1",
"createdAt": 1564661697125,
"createdBy": "some-uid"
}
Diagnostic Measure - Find
Get list of diagnostic measures
GET /diagnostic-measures
Headers - Header
| Name | Type | Description |
|---|---|---|
| Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Examples
Example usage:
curl "https://yourdomain.com/diagnostic-measures" \
-X GET \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
| Name | Type | Description |
|---|---|---|
| diagnosticAnalyzers | object[] |
array of diagnosticAnalyzer |
| diagnosticAnalyzers.id | string |
|
| diagnosticAnalyzers.createdAt | number |
|
| diagnosticAnalyzers.createdBy | string |
|
| diagnosticAnalyzers.account | string |
|
| diagnosticAnalyzers.facility | string |
|
| diagnosticAnalyzers.test | string |
|
| diagnosticAnalyzers.name | string |
|
| diagnosticAnalyzers.set | string |
|
| diagnosticAnalyzers.sets | string[] |
|
| diagnosticAnalyzers.description | string |
|
| diagnosticAnalyzers.type | string |
Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| diagnosticAnalyzers.choices | string[] |
|
| diagnosticAnalyzers.unit | string |
|
| diagnosticAnalyzers.siunit | string |
|
| diagnosticAnalyzers.referenceRanges | object[] |
|
| diagnosticAnalyzers.referenceRanges.id | string |
Default value: auto-generated-id |
| diagnosticAnalyzers.referenceRanges.min | number |
|
| diagnosticAnalyzers.referenceRanges.minPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.referenceRanges.max | number |
|
| diagnosticAnalyzers.referenceRanges.maxPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.referenceRanges.simin | number |
|
| diagnosticAnalyzers.referenceRanges.siminPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.referenceRanges.simax | number |
|
| diagnosticAnalyzers.referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| diagnosticAnalyzers.referenceRanges.ageMin | number |
|
| diagnosticAnalyzers.referenceRanges.ageMax | number |
|
| diagnosticAnalyzers.panicRanges | object[] |
|
| diagnosticAnalyzers.panicRanges.min | number |
|
| diagnosticAnalyzers.panicRanges.minPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.panicRanges.max | number |
|
| diagnosticAnalyzers.panicRanges.maxPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.panicRanges.simin | number |
|
| diagnosticAnalyzers.panicRanges.siminPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.panicRanges.simax | number |
|
| diagnosticAnalyzers.panicRanges.simaxPrecision | number |
significant places after the decimal point |
| diagnosticAnalyzers.panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| diagnosticAnalyzers.panicRanges.ageMin | number |
|
| diagnosticAnalyzers.panicRanges.ageMax | number |
|
| diagnosticAnalyzers.hl7IdentifierCod | string |
|
| diagnosticAnalyzers.hl7IdentifierSys | string |
|
| diagnosticAnalyzers.numericBreakdownMin | number |
|
| diagnosticAnalyzers.numericBreakdownMax | number |
|
| diagnosticAnalyzers.section | any |
for medical test |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
[
{
"id": "id-1",
"createdAt": 1564661697125,
"createdBy": "some-uid"
},
{
"id": "id-2",
"createdAt": 1564661697125,
"createdBy": "some-uid"
}
]
Diagnostic Measure - Get
Get a specific diagnostic measure
GET /diagnostic-measures/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Examples
Example usage:
curl "https://yourdomain.com/diagnostic-measures/<diagnostic-measure-id>" \
-X GET \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
| Name | Type | Description |
|---|---|---|
| id | string |
|
| createdAt | number |
|
| createdBy | string |
|
| account | string |
|
| facility | string |
|
| test | string |
|
| name | string |
|
| set | string |
|
| sets | string[] |
|
| description | string |
|
| type | string |
Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
|
| unit | string |
|
| siunit | string |
|
| referenceRanges | object[] |
|
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
|
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
|
| hl7IdentifierSys | string |
|
| numericBreakdownMin | number |
|
| numericBreakdownMax | number |
|
| section | any |
for medical test |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "id-1",
"createdAt": 1564661697125,
"createdBy": "some-uid"
}
Diagnostic Measure - Patch
Update diagnostic measure
PATCH /diagnostic-measures/:id
Headers - Header
| Name | Type | Description |
|---|---|---|
| Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| createdAt | number |
optional |
| name | string |
|
| set | string |
optional |
| sets | string[] |
optional |
| description | string |
optional |
| type | string |
optional Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
optional |
| unit | string |
optional |
| siunit | string |
optional |
| referenceRanges | object[] |
optional |
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
optional |
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
optional |
| hl7IdentifierSys | string |
optional |
| numericBreakdownMin | number |
optional |
| numericBreakdownMax | number |
optional |
| section | any |
optional for medical test |
Examples
Example usage:
curl "https://yourdomain.com/diagnostic-measures/<diagnostic-measure-id>" \
-X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-api-token>" \
-d '{
"description": "some description"
}'
Parameters examples
json - Request-Example
{
"description": "some description"
}
Success response
Success response - Success 200
| Name | Type | Description |
|---|---|---|
| id | string |
|
| createdAt | number |
|
| createdBy | string |
|
| account | string |
|
| facility | string |
|
| test | string |
|
| name | string |
|
| set | string |
|
| sets | string[] |
|
| description | string |
|
| type | string |
Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
|
| unit | string |
|
| siunit | string |
|
| referenceRanges | object[] |
|
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
|
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
|
| hl7IdentifierSys | string |
|
| numericBreakdownMin | number |
|
| numericBreakdownMax | number |
|
| section | any |
for medical test |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "id-1",
"createdAt": 1564661697125,
"createdBy": "some-uid"
}
Diagnostic Measure - Post
Create diagnostic measure
POST /diagnostic-measures
Headers - Header
| Name | Type | Description |
|---|---|---|
| Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
| Name | Type | Description |
|---|---|---|
| createdAt | number |
optional |
| account | string |
optional |
| facility | string |
optional |
| test | string |
|
| name | string |
|
| set | string |
optional |
| sets | string[] |
optional |
| description | string |
optional |
| type | string |
optional Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
optional |
| unit | string |
optional |
| siunit | string |
optional |
| referenceRanges | object[] |
optional |
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
optional |
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
optional |
| hl7IdentifierSys | string |
optional |
| numericBreakdownMin | number |
optional |
| numericBreakdownMax | number |
optional |
| section | any |
optional for medical test |
Examples
Example usage:
curl "https://yourdomain.com/diagnostic-measures" \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-api-token>" \
-d '{
"test": "some-test",
"name": "some name"
}'
Parameters examples
json - Request-Example
{
"test": "some-test",
"name": "some name"
}
Success response
Success response - Success 200
| Name | Type | Description |
|---|---|---|
| id | string |
|
| createdAt | number |
|
| createdBy | string |
|
| account | string |
|
| facility | string |
|
| test | string |
|
| name | string |
|
| set | string |
|
| sets | string[] |
|
| description | string |
|
| type | string |
Allowed values: numeric,posneg,text,html,multiplechoice,checklist,numeric-breakdown |
| choices | string[] |
|
| unit | string |
|
| siunit | string |
|
| referenceRanges | object[] |
|
| referenceRanges.id | string |
Default value: auto-generated-id |
| referenceRanges.min | number |
|
| referenceRanges.minPrecision | number |
significant places after the decimal point |
| referenceRanges.max | number |
|
| referenceRanges.maxPrecision | number |
significant places after the decimal point |
| referenceRanges.simin | number |
|
| referenceRanges.siminPrecision | number |
significant places after the decimal point |
| referenceRanges.simax | number |
|
| referenceRanges.simaxPrecision | number |
significant places after the decimal point |
| referenceRanges.sex | string |
Default value: all Allowed values: all,male,female |
| referenceRanges.ageMin | number |
|
| referenceRanges.ageMax | number |
|
| panicRanges | object[] |
|
| panicRanges.min | number |
|
| panicRanges.minPrecision | number |
significant places after the decimal point |
| panicRanges.max | number |
|
| panicRanges.maxPrecision | number |
significant places after the decimal point |
| panicRanges.simin | number |
|
| panicRanges.siminPrecision | number |
significant places after the decimal point |
| panicRanges.simax | number |
|
| panicRanges.simaxPrecision | number |
significant places after the decimal point |
| panicRanges.sex | string |
Default value: all Allowed values: all,male,female |
| panicRanges.ageMin | number |
|
| panicRanges.ageMax | number |
|
| hl7IdentifierCod | string |
|
| hl7IdentifierSys | string |
|
| numericBreakdownMin | number |
|
| numericBreakdownMax | number |
|
| section | any |
for medical test |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "id-1",
"createdAt": 1564661697125,
"createdBy": "some-uid"
}