api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Order_Tests_Report

Diagnostic Order Tests Report - Delete

Back to top

Delete a specific diagnostic order

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

org id
items object[]
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
preparedBy string

account uid
preparedFor string

account uid
verifiedAt number

timestamp
verifiedBy string

account uid
pickedUpAt number

timestamp
pickedUpBy string

account uid

Success response example

Success response example - Success-Response:

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

Diagnostic Order Tests Report - Find

Back to top

Get list of diagnostic orders

GET /diagnostic-order-tests-reports

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

Success response

Success response - Success 200

Name Type Description
diagnosticOrderTestReports object[]

array of diagnosticOrderTestReport
diagnosticOrderTestReports.id string
diagnosticOrderTestReports.createdAt number

timestamp
diagnosticOrderTestReports.createdBy string

account uid
diagnosticOrderTestReports.organization string

org id
diagnosticOrderTestReports.items object[]
diagnosticOrderTestReports.items.id string

order test id
diagnosticOrderTestReports.items.test string

diagnostic test id
diagnosticOrderTestReports.items.testName string
diagnosticOrderTestReports.items.reason string
diagnosticOrderTestReports.items.requestingPhysician string
diagnosticOrderTestReports.items.specimen string
diagnosticOrderTestReports.items.specimenNote string
diagnosticOrderTestReports.items.specimenCollectedAt number
diagnosticOrderTestReports.items.sentOutTo string
diagnosticOrderTestReports.items.receivedAt number

for sent out
diagnosticOrderTestReports.items.receivedBy string

for sent out
diagnosticOrderTestReports.items.tags string[]
diagnosticOrderTestReports.items.patient string
diagnosticOrderTestReports.items.service string

service id
diagnosticOrderTestReports.items.serviceName string
diagnosticOrderTestReports.items.invoiceOR string
diagnosticOrderTestReports.items.invoiceItem string

billing-item id
diagnosticOrderTestReports.items.invoiceItemCoverage string
diagnosticOrderTestReports.items.invoiceItemCoverageApprovalCode string
diagnosticOrderTestReports.items.insuranceContract string

insurance-contract id used
diagnosticOrderTestReports.items.insuranceContractInsurerName string
diagnosticOrderTestReports.items.insuranceContractInsurerNo string
diagnosticOrderTestReports.label string
diagnosticOrderTestReports.startAt number

timestamp
diagnosticOrderTestReports.endAt number

timestamp
diagnosticOrderTestReports.preparedAt number

timestamp
diagnosticOrderTestReports.preparedBy string

account uid
diagnosticOrderTestReports.preparedFor string

account uid
diagnosticOrderTestReports.verifiedAt number

timestamp
diagnosticOrderTestReports.verifiedBy string

account uid
diagnosticOrderTestReports.pickedUpAt number

timestamp
diagnosticOrderTestReports.pickedUpBy string

account uid

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 Tests Report - Get

Back to top

Get a specific diagnostic order

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

org id
items object[]
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
preparedBy string

account uid
preparedFor string

account uid
verifiedAt number

timestamp
verifiedBy string

account uid
pickedUpAt number

timestamp
pickedUpBy string

account uid

Success response example

Success response example - Success-Response:

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

Diagnostic Order Tests Report - Patch

Back to top

Update diagnostic order

PATCH /diagnostic-order-tests-reports/: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

timestamp
organization string

org id
items object[] optional Size range: 1..
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string optional
startAt number optional

timestamp
endAt number optional

timestamp
preparedAt number optional

timestamp
preparedBy string optional

account uid
preparedFor string optional

account uid
verifiedAt number optional

timestamp
verifiedBy string optional

account uid
pickedUpAt number optional

timestamp
pickedUpBy string optional

account uid
pickUp boolean optional

$pickUp - operators
verify boolean optional

$verify - operators

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "$pickUp": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

org id
items object[]
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
preparedBy string

account uid
preparedFor string

account uid
verifiedAt number

timestamp
verifiedBy string

account uid
pickedUpAt number

timestamp
pickedUpBy string

account uid

Success response example

Success response example - Success-Response:

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

Diagnostic Order Tests Report - Post

Back to top

Create diagnostic order

POST /diagnostic-order-tests-reports

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

timestamp
organization string

org id
items object[] optional Size range: 1..
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string optional
startAt number optional

timestamp
endAt number optional

timestamp
preparedAt number optional

timestamp
preparedBy string optional

account uid
preparedFor string optional

account uid
verifiedAt number optional

timestamp
verifiedBy string optional

account uid
pickedUpAt number optional

timestamp
pickedUpBy string optional

account uid
query object optional

$query - operators

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "organization": "org-id",
  "label": "some label"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

org id
items object[]
items.id string

order test id
items.test string

diagnostic test id
items.testName string
items.reason string
items.requestingPhysician string
items.specimen string
items.specimenNote string
items.specimenCollectedAt number
items.sentOutTo string
items.receivedAt number

for sent out
items.receivedBy string

for sent out
items.tags string[]
items.patient string
items.service string

service id
items.serviceName string
items.invoiceOR string
items.invoiceItem string

billing-item id
items.invoiceItemCoverage string
items.invoiceItemCoverageApprovalCode string
items.insuranceContract string

insurance-contract id used
items.insuranceContractInsurerName string
items.insuranceContractInsurerNo string
label string
startAt number

timestamp
endAt number

timestamp
preparedAt number

timestamp
preparedBy string

account uid
preparedFor string

account uid
verifiedAt number

timestamp
verifiedBy string

account uid
pickedUpAt number

timestamp
pickedUpBy string

account uid

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 ""