api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Order_Test

Diagnostic Order Test - Delete

Back to top

Delete a specific diagnostic order test. Can only delete non-finalized items

DELETE /diagnostic-order-tests/: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-order-tests/<diagnostic-order-test-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
order string

diagnostic order id
test string

diagnostic test id
invoiceItem string

invoice item id used to pay for this test
reports string[]

reports this test is included in
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
section string

from diagnostic test
sectionCode string

from diagnostic test
reason string
requestingPhysician string
medicalRecordOrder string
service string

reference to Service#id that has been used to bill this test
tags string[]
printTemplateValue string
resultsClaimedAt number
resultsClaimedBy string
confirmedAt number
confirmedBy string
completedAt number
completedBy string
verifiedAt number
verifiedBy string
finalizedAt number
finalizedBy string
cancelledAt number
cancelledBy string
sentOutAt number
sentOutBy string
sentOutTo string
receivedAt number
receivedBy string
isConfidential boolean

flag to not generate medical records
isWhitelisted boolean
whitelist string[]

uid of default whitelisted account uids
disclaimer string
remarks string
estimatedReleaseAt number
technician string
specimen string
specimenNote string
specimenCollectedAt number
specimenHarvestMethod string
pathologist string

doc uid
pathologistFee number
pathologistFeeType string Allowed values: amount,percentage
results object[]
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string
sonologist string

doc uid
sonologistFee number
sonologistFeeType string Allowed values: amount,percentage
radiologist string

doc uid
radiologistFee number
radiologistFeeType string Allowed values: amount,percentage
cardiologist string

doc uid
cardiologistFee number
cardiologistFeeType string Allowed values: amount,percentage
report string
attachmentURLs string[]
resultsRedacted boolean

$resultsRedacted - [virtual] flag for results redaction

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Diagnostic Order Test - Find

Back to top

Get list of diagnostic order tests

GET /diagnostic-order-tests

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-order-tests" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
diagnosticOrderTests object[]

array of diagnosticOrderTest
diagnosticOrderTests.id string
diagnosticOrderTests.createdAt number
diagnosticOrderTests.createdBy string
diagnosticOrderTests.order string

diagnostic order id
diagnosticOrderTests.test string

diagnostic test id
diagnosticOrderTests.invoiceItem string

invoice item id used to pay for this test
diagnosticOrderTests.reports string[]

reports this test is included in
diagnosticOrderTests.type string Allowed values: laboratory,radiology
diagnosticOrderTests.facility string
diagnosticOrderTests.patient string

px id
diagnosticOrderTests.encounter string

encounter id
diagnosticOrderTests.section string

from diagnostic test
diagnosticOrderTests.sectionCode string

from diagnostic test
diagnosticOrderTests.reason string
diagnosticOrderTests.requestingPhysician string
diagnosticOrderTests.medicalRecordOrder string
diagnosticOrderTests.service string

reference to Service#id that has been used to bill this test
diagnosticOrderTests.tags string[]
diagnosticOrderTests.printTemplateValue string
diagnosticOrderTests.resultsClaimedAt number
diagnosticOrderTests.resultsClaimedBy string
diagnosticOrderTests.confirmedAt number
diagnosticOrderTests.confirmedBy string
diagnosticOrderTests.completedAt number
diagnosticOrderTests.completedBy string
diagnosticOrderTests.verifiedAt number
diagnosticOrderTests.verifiedBy string
diagnosticOrderTests.finalizedAt number
diagnosticOrderTests.finalizedBy string
diagnosticOrderTests.cancelledAt number
diagnosticOrderTests.cancelledBy string
diagnosticOrderTests.sentOutAt number
diagnosticOrderTests.sentOutBy string
diagnosticOrderTests.sentOutTo string
diagnosticOrderTests.receivedAt number
diagnosticOrderTests.receivedBy string
diagnosticOrderTests.isConfidential boolean

flag to not generate medical records
diagnosticOrderTests.isWhitelisted boolean
diagnosticOrderTests.whitelist string[]

uid of default whitelisted account uids
diagnosticOrderTests.disclaimer string
diagnosticOrderTests.remarks string
diagnosticOrderTests.estimatedReleaseAt number
diagnosticOrderTests.technician string
diagnosticOrderTests.specimen string
diagnosticOrderTests.specimenNote string
diagnosticOrderTests.specimenCollectedAt number
diagnosticOrderTests.specimenHarvestMethod string
diagnosticOrderTests.pathologist string

doc uid
diagnosticOrderTests.pathologistFee number
diagnosticOrderTests.pathologistFeeType string Allowed values: amount,percentage
diagnosticOrderTests.results object[]
diagnosticOrderTests.results.id string Default value: auto-generated-id,
diagnosticOrderTests.results.note string
diagnosticOrderTests.results.value any
diagnosticOrderTests.results.values any[]
diagnosticOrderTests.results.sivalue any
diagnosticOrderTests.results.sivalues any[]
diagnosticOrderTests.results.analyzer string
diagnosticOrderTests.results.test string

test id
diagnosticOrderTests.results.testName string
diagnosticOrderTests.results.measure string

measure id
diagnosticOrderTests.results.measureName string
diagnosticOrderTests.imageLocation string
diagnosticOrderTests.sonologist string

doc uid
diagnosticOrderTests.sonologistFee number
diagnosticOrderTests.sonologistFeeType string Allowed values: amount,percentage
diagnosticOrderTests.radiologist string

doc uid
diagnosticOrderTests.radiologistFee number
diagnosticOrderTests.radiologistFeeType string Allowed values: amount,percentage
diagnosticOrderTests.cardiologist string

doc uid
diagnosticOrderTests.cardiologistFee number
diagnosticOrderTests.cardiologistFeeType string Allowed values: amount,percentage
diagnosticOrderTests.report string
diagnosticOrderTests.attachmentURLs string[]
diagnosticOrderTests.resultsRedacted boolean

$resultsRedacted - [virtual] flag for results redaction

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 Order Test - Get

Back to top

Get a specific diagnostic order test

GET /diagnostic-order-tests/: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-order-tests/<diagnostic-order-test-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
order string

diagnostic order id
test string

diagnostic test id
invoiceItem string

invoice item id used to pay for this test
reports string[]

reports this test is included in
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
section string

from diagnostic test
sectionCode string

from diagnostic test
reason string
requestingPhysician string
medicalRecordOrder string
service string

reference to Service#id that has been used to bill this test
tags string[]
printTemplateValue string
resultsClaimedAt number
resultsClaimedBy string
confirmedAt number
confirmedBy string
completedAt number
completedBy string
verifiedAt number
verifiedBy string
finalizedAt number
finalizedBy string
cancelledAt number
cancelledBy string
sentOutAt number
sentOutBy string
sentOutTo string
receivedAt number
receivedBy string
isConfidential boolean

flag to not generate medical records
isWhitelisted boolean
whitelist string[]

uid of default whitelisted account uids
disclaimer string
remarks string
estimatedReleaseAt number
technician string
specimen string
specimenNote string
specimenCollectedAt number
specimenHarvestMethod string
pathologist string

doc uid
pathologistFee number
pathologistFeeType string Allowed values: amount,percentage
results object[]
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string
sonologist string

doc uid
sonologistFee number
sonologistFeeType string Allowed values: amount,percentage
radiologist string

doc uid
radiologistFee number
radiologistFeeType string Allowed values: amount,percentage
cardiologist string

doc uid
cardiologistFee number
cardiologistFeeType string Allowed values: amount,percentage
report string
attachmentURLs string[]
resultsRedacted boolean

$resultsRedacted - [virtual] flag for results redaction

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Diagnostic Order Test - Patch

Back to top

Update diagnostic order test

PATCH /diagnostic-order-tests/: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 Default value: currentTime
invoiceItem string optional

invoice item id used to pay for this test
reports string[] optional

reports this test is included in
tags string[] optional
printTemplateValue string optional
sentOutTo string optional
isConfidential boolean optional

flag to not generate medical records
isWhitelisted boolean optional
whitelist string[] optional

uid of default whitelisted account uids
disclaimer string optional
remarks string optional
estimatedReleaseAt number optional
technician string optional
specimen string optional
specimenNote string optional
specimenCollectedAt number optional
specimenHarvestMethod string optional
pathologist string optional

doc uid
pathologistFee number optional
pathologistFeeType string optional Allowed values: amount,percentage
results object[] optional
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string optional
sonologist string optional

doc uid
sonologistFee number optional
sonologistFeeType string optional Allowed values: amount,percentage
radiologist string optional

doc uid
radiologistFee number optional
radiologistFeeType string optional Allowed values: amount,percentage
cardiologist string optional

doc uid
cardiologistFee number optional
cardiologistFeeType string optional Allowed values: amount,percentage
report string optional
attachmentURLs string[] optional
claimResults boolean optional

operators
confirm boolean optional

operators $confirm
receive boolean optional

operators
complete boolean optional

operators
verify boolean optional

operators
finalize boolean optional

operators
cancel boolean optional

operators
sendOut boolean/string optional

operators

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-order-tests/<diagnostic-order-test-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "cancel": true
  }'

Parameters examples

json - Request-Example

{
  "cancel": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
order string

diagnostic order id
test string

diagnostic test id
invoiceItem string

invoice item id used to pay for this test
reports string[]

reports this test is included in
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
section string

from diagnostic test
sectionCode string

from diagnostic test
reason string
requestingPhysician string
medicalRecordOrder string
service string

reference to Service#id that has been used to bill this test
tags string[]
printTemplateValue string
resultsClaimedAt number
resultsClaimedBy string
confirmedAt number
confirmedBy string
completedAt number
completedBy string
verifiedAt number
verifiedBy string
finalizedAt number
finalizedBy string
cancelledAt number
cancelledBy string
sentOutAt number
sentOutBy string
sentOutTo string
receivedAt number
receivedBy string
isConfidential boolean

flag to not generate medical records
isWhitelisted boolean
whitelist string[]

uid of default whitelisted account uids
disclaimer string
remarks string
estimatedReleaseAt number
technician string
specimen string
specimenNote string
specimenCollectedAt number
specimenHarvestMethod string
pathologist string

doc uid
pathologistFee number
pathologistFeeType string Allowed values: amount,percentage
results object[]
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string
sonologist string

doc uid
sonologistFee number
sonologistFeeType string Allowed values: amount,percentage
radiologist string

doc uid
radiologistFee number
radiologistFeeType string Allowed values: amount,percentage
cardiologist string

doc uid
cardiologistFee number
cardiologistFeeType string Allowed values: amount,percentage
report string
attachmentURLs string[]
resultsRedacted boolean

$resultsRedacted - [virtual] flag for results redaction

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Diagnostic Order Test - Post

Back to top

Create diagnostic order test

POST /diagnostic-order-tests

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 Default value: currentTime
order string

diagnostic order id
test string

diagnostic test id
invoiceItem string optional

invoice item id used to pay for this test
reports string[] optional

reports this test is included in
service string optional

reference to Service#id that has been used to bill this test
tags string[] optional
printTemplateValue string optional
sentOutTo string optional
isConfidential boolean optional

flag to not generate medical records
isWhitelisted boolean optional
whitelist string[] optional

uid of default whitelisted account uids
disclaimer string optional
remarks string optional
estimatedReleaseAt number optional
technician string optional
specimen string optional
specimenNote string optional
specimenCollectedAt number optional
specimenHarvestMethod string optional
pathologist string optional

doc uid
pathologistFee number optional
pathologistFeeType string optional Allowed values: amount,percentage
results object[] optional
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string optional
sonologist string optional

doc uid
sonologistFee number optional
sonologistFeeType string optional Allowed values: amount,percentage
radiologist string optional

doc uid
radiologistFee number optional
radiologistFeeType string optional Allowed values: amount,percentage
cardiologist string optional

doc uid
cardiologistFee number optional
cardiologistFeeType string optional Allowed values: amount,percentage
report string optional
attachmentURLs string[] optional

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-order-tests" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "order": "diagnostic-order-id",
    "test": "diagnostic-test-id"
  }'

Parameters examples

json - Request-Example

{
  "order": "diagnostic-order-id",
  "test": "diagnostic-test-id"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
order string

diagnostic order id
test string

diagnostic test id
invoiceItem string

invoice item id used to pay for this test
reports string[]

reports this test is included in
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
section string

from diagnostic test
sectionCode string

from diagnostic test
reason string
requestingPhysician string
medicalRecordOrder string
service string

reference to Service#id that has been used to bill this test
tags string[]
printTemplateValue string
resultsClaimedAt number
resultsClaimedBy string
confirmedAt number
confirmedBy string
completedAt number
completedBy string
verifiedAt number
verifiedBy string
finalizedAt number
finalizedBy string
cancelledAt number
cancelledBy string
sentOutAt number
sentOutBy string
sentOutTo string
receivedAt number
receivedBy string
isConfidential boolean

flag to not generate medical records
isWhitelisted boolean
whitelist string[]

uid of default whitelisted account uids
disclaimer string
remarks string
estimatedReleaseAt number
technician string
specimen string
specimenNote string
specimenCollectedAt number
specimenHarvestMethod string
pathologist string

doc uid
pathologistFee number
pathologistFeeType string Allowed values: amount,percentage
results object[]
results.id string Default value: auto-generated-id,
results.note string
results.value any
results.values any[]
results.sivalue any
results.sivalues any[]
results.analyzer string
results.test string

test id
results.testName string
results.measure string

measure id
results.measureName string
imageLocation string
sonologist string

doc uid
sonologistFee number
sonologistFeeType string Allowed values: amount,percentage
radiologist string

doc uid
radiologistFee number
radiologistFeeType string Allowed values: amount,percentage
cardiologist string

doc uid
cardiologistFee number
cardiologistFeeType string Allowed values: amount,percentage
report string
attachmentURLs string[]
resultsRedacted boolean

$resultsRedacted - [virtual] flag for results redaction

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""