api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Order

Diagnostic Order - Delete

Back to top

Delete a specific diagnostic order

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

Success response

Success response - Success 200

Name Type Description
id string
createdBy string
createdAt number
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
requestingPhysician string
reason string
diagnosis string

icd10 fixture id
order string

medical order this order was made from (for linking)
remarks string

Success response example

Success response example - Success-Response:

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

Diagnostic Order - Find

Back to top

Get list of diagnostic orders

GET /diagnostic-orders

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

Success response

Success response - Success 200

Name Type Description
diagnosticOrders object[]

array of diagnosticOrder
diagnosticOrders.id string
diagnosticOrders.createdBy string
diagnosticOrders.createdAt number
diagnosticOrders.type string Allowed values: laboratory,radiology
diagnosticOrders.facility string
diagnosticOrders.patient string

px id
diagnosticOrders.encounter string

encounter id
diagnosticOrders.requestingPhysician string
diagnosticOrders.reason string
diagnosticOrders.diagnosis string

icd10 fixture id
diagnosticOrders.order string

medical order this order was made from (for linking)
diagnosticOrders.remarks string

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

Back to top

Get a specific diagnostic order

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

Success response

Success response - Success 200

Name Type Description
id string
createdBy string
createdAt number
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
requestingPhysician string
reason string
diagnosis string

icd10 fixture id
order string

medical order this order was made from (for linking)
remarks string

Success response example

Success response example - Success-Response:

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

Diagnostic Order - Patch

Back to top

Update diagnostic order

PATCH /diagnostic-orders/: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
encounter string optional

encounter id
requestingPhysician string optional
reason string optional
diagnosis string optional

icd10 fixture id
order string optional

medical order this order was made from (for linking)
remarks string optional
cancel boolean optional

operator

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-orders/<diagnostic-order-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
createdBy string
createdAt number
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
requestingPhysician string
reason string
diagnosis string

icd10 fixture id
order string

medical order this order was made from (for linking)
remarks string

Success response example

Success response example - Success-Response:

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

Diagnostic Order - Post

Back to top

Create diagnostic order

POST /diagnostic-orders

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
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string optional

encounter id
requestingPhysician string optional
reason string optional
diagnosis string optional

icd10 fixture id
order string optional

medical order this order was made from (for linking)
remarks string optional
tests any optional

operator

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-orders" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "radiology",
    "facility": "facility-id",
    "patient": "px-uid"
  }'

Parameters examples

json - Request-Example

{
  "type": "radiology",
  "facility": "facility-id",
  "patient": "px-uid"
}

Success response

Success response - Success 200

Name Type Description
id string
createdBy string
createdAt number
type string Allowed values: laboratory,radiology
facility string
patient string

px id
encounter string

encounter id
requestingPhysician string
reason string
diagnosis string

icd10 fixture id
order string

medical order this order was made from (for linking)
remarks string

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