api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Package

Diagnostic Package - Delete

Back to top

Delete a specific diagnostic package

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
type string Allowed values: laboratory,radiology
account string

account uid for account-owned
facility string

facility id. fixture if null
name string

test name
description string
tests string[]
tags string[]

can be prefixed (e.g., restriction::uid::)

Success response example

Success response example - Success-Response:

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

Diagnostic Package - Find

Back to top

Get list of diagnostic packages

GET /diagnostic-packages

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

Success response

Success response - Success 200

Name Type Description
diagnosticPackages object[]

array of diagnosticPackage
diagnosticPackages.id string
diagnosticPackages.createdAt number

timestamp

Default value: currentTime
diagnosticPackages.createdBy string

account uid
diagnosticPackages.type string Allowed values: laboratory,radiology
diagnosticPackages.account string

account uid for account-owned
diagnosticPackages.facility string

facility id. fixture if null
diagnosticPackages.name string

test name
diagnosticPackages.description string
diagnosticPackages.tests string[]
diagnosticPackages.tags string[]

can be prefixed (e.g., restriction::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 Package - Get

Back to top

Get a specific diagnostic package

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
type string Allowed values: laboratory,radiology
account string

account uid for account-owned
facility string

facility id. fixture if null
name string

test name
description string
tests string[]
tags string[]

can be prefixed (e.g., restriction::uid::)

Success response example

Success response example - Success-Response:

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

Diagnostic Package - Patch

Back to top

Update diagnostic package

PATCH /diagnostic-packages/: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
type string optional Allowed values: laboratory,radiology
name string

test name
description string optional
tests string[]
tags string[] optional

can be prefixed (e.g., restriction::uid::)
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-packages/<diagnostic-package-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "laboratory"
  }'

Parameters examples

json - Request-Example

{
  "type": "laboratory"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
type string Allowed values: laboratory,radiology
account string

account uid for account-owned
facility string

facility id. fixture if null
name string

test name
description string
tests string[]
tags string[]

can be prefixed (e.g., restriction::uid::)

Success response example

Success response example - Success-Response:

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

Diagnostic Package - Post

Back to top

Create diagnostic package

POST /diagnostic-packages

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

account uid for account-owned
facility string optional

facility id. fixture if null
name string

test name
description string optional
tests string[]
tags string[] optional

can be prefixed (e.g., restriction::uid::)
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "type": "radiology",
  "facility": "facility-id",
  "name": "some name"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
type string Allowed values: laboratory,radiology
account string

account uid for account-owned
facility string

facility id. fixture if null
name string

test name
description string
tests string[]
tags string[]

can be prefixed (e.g., restriction::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 ""