api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Test

Diagnostic Test - Delete

Back to top

Delete a specific diagnostic test

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

Success response

Success response - Success 200

Name Type Description
id string
createdBy string

account uid
createdAt number

timestamp

Default value: currentTime
type string Allowed values: laboratory,radiology
account string

account uid
facility string

facility id
name string

test name
description string
disclaimer string
printTemplate string
printTemplateDetails object

embedded snapshot of the template (on create)

Extracted properties

  • template
  • items
  • meta
section string

for grouping
sectionCode string

code of section fixture, if used
isConfidential boolean

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

uid of default whitelisted account uids
hl7IdentifierCod string

hl7 identifier code
hl7IdentifierSys string

hl7 identifier code's system
technicianLabel string
hideTechnician boolean
hidePathologist boolean
hideSonologist boolean
hideRadiologist boolean
hideCardiologist boolean
hiddenAt number

timestamp
hiddenBy string

Success response example

Success response example - Success-Response:

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

Diagnostic Test - Find

Back to top

Get list of diagnostic tests

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

Success response

Success response - Success 200

Name Type Description
diagnosticTests object[]

array of diagnosticTest
diagnosticTests.id string
diagnosticTests.createdBy string

account uid
diagnosticTests.createdAt number

timestamp

Default value: currentTime
diagnosticTests.type string Allowed values: laboratory,radiology
diagnosticTests.account string

account uid
diagnosticTests.facility string

facility id
diagnosticTests.name string

test name
diagnosticTests.description string
diagnosticTests.disclaimer string
diagnosticTests.printTemplate string
diagnosticTests.printTemplateDetails object

embedded snapshot of the template (on create)

Extracted properties

  • template
  • items
  • meta
diagnosticTests.section string

for grouping
diagnosticTests.sectionCode string

code of section fixture, if used
diagnosticTests.isConfidential boolean

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

uid of default whitelisted account uids
diagnosticTests.hl7IdentifierCod string

hl7 identifier code
diagnosticTests.hl7IdentifierSys string

hl7 identifier code's system
diagnosticTests.technicianLabel string
diagnosticTests.hideTechnician boolean
diagnosticTests.hidePathologist boolean
diagnosticTests.hideSonologist boolean
diagnosticTests.hideRadiologist boolean
diagnosticTests.hideCardiologist boolean
diagnosticTests.hiddenAt number

timestamp
diagnosticTests.hiddenBy 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 Test - Get

Back to top

Get a specific diagnostic test

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

Success response

Success response - Success 200

Name Type Description
id string
createdBy string

account uid
createdAt number

timestamp

Default value: currentTime
type string Allowed values: laboratory,radiology
account string

account uid
facility string

facility id
name string

test name
description string
disclaimer string
printTemplate string
printTemplateDetails object

embedded snapshot of the template (on create)

Extracted properties

  • template
  • items
  • meta
section string

for grouping
sectionCode string

code of section fixture, if used
isConfidential boolean

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

uid of default whitelisted account uids
hl7IdentifierCod string

hl7 identifier code
hl7IdentifierSys string

hl7 identifier code's system
technicianLabel string
hideTechnician boolean
hidePathologist boolean
hideSonologist boolean
hideRadiologist boolean
hideCardiologist boolean
hiddenAt number

timestamp
hiddenBy string

Success response example

Success response example - Success-Response:

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

Diagnostic Test - Patch

Back to top

Update diagnostic test

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

timestamp

Default value: currentTime
name string optional
description string optional
disclaimer string optional
printTemplate string optional
section string optional
sectionCode string optional
isConfidential boolean optional
isWhitelisted boolean optional
whitelist string[] optional
hl7IdentifierCod string optional
hl7IdentifierSys string optional
technicianLabel string optional
hideTechnician boolean optional
hidePathologist boolean optional
hideSonologist boolean optional
hideRadiologist boolean optional
hideCardiologist boolean optional

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-tests/<diagnostic-test-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
createdBy string

account uid
createdAt number

timestamp

Default value: currentTime
type string Allowed values: laboratory,radiology
account string

account uid
facility string

facility id
name string

test name
description string
disclaimer string
printTemplate string
printTemplateDetails object

embedded snapshot of the template (on create)

Extracted properties

  • template
  • items
  • meta
section string

for grouping
sectionCode string

code of section fixture, if used
isConfidential boolean

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

uid of default whitelisted account uids
hl7IdentifierCod string

hl7 identifier code
hl7IdentifierSys string

hl7 identifier code's system
technicianLabel string
hideTechnician boolean
hidePathologist boolean
hideSonologist boolean
hideRadiologist boolean
hideCardiologist boolean
hiddenAt number

timestamp
hiddenBy string

Success response example

Success response example - Success-Response:

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

Diagnostic Test - Post

Back to top

Create diagnostic test

POST /diagnostic-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 string optional

timestamp

Default value: currentTime
type string Allowed values: laboratory,radiology
account string optional

account uid
facility string optional

facility id
name string
description string optional
disclaimer string optional
printTemplate string optional
section string optional
sectionCode string optional
isConfidential boolean optional
isWhitelisted boolean optional
whitelist string[] optional
hl7IdentifierCod string optional
hl7IdentifierSys string optional
technicianLabel string optional
hideTechnician boolean optional
hidePathologist boolean optional
hideSonologist boolean optional
hideRadiologist boolean optional
hideCardiologist boolean optional
measures object[] optional

DiagnosticMeasure object - operator

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-tests" \
  -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
createdBy string

account uid
createdAt number

timestamp

Default value: currentTime
type string Allowed values: laboratory,radiology
account string

account uid
facility string

facility id
name string

test name
description string
disclaimer string
printTemplate string
printTemplateDetails object

embedded snapshot of the template (on create)

Extracted properties

  • template
  • items
  • meta
section string

for grouping
sectionCode string

code of section fixture, if used
isConfidential boolean

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

uid of default whitelisted account uids
hl7IdentifierCod string

hl7 identifier code
hl7IdentifierSys string

hl7 identifier code's system
technicianLabel string
hideTechnician boolean
hidePathologist boolean
hideSonologist boolean
hideRadiologist boolean
hideCardiologist boolean
hiddenAt number

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