api-docs v5.116.0

API Docs

Table of contents

Diagnostic_Analyzer

Diagnostic Analyzer - Delete

Back to top

Delete a specific diagnostic analyzer

DELETE /diagnostic-analyzers/: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-analyzers/<diagnostic-analyzer-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
facility string
name string
description string
hl7Host string

[SENDING] the machine's TCP host address
hl7Port string

[SENDING] the machine's TCP port
hl7Version string

the hl7 version it can accept
hl7SendingFacility string

[RECEIVING] the hl7 MSH-3
hl7SendingApplication string

[RECEIVING] the hl7 MSH-4
hl7ReceivingFacility string

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string

[SENDING] the hl7 MSH-6

Success response example

Success response example - Success-Response:

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

Diagnostic Analyzer - Find

Back to top

Get list of diagnostic analyzers

GET /diagnostic-analyzers

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

Success response

Success response - Success 200

Name Type Description
diagnosticAnalyzers[] object[]

array of diagnosticAnalyzer
diagnosticAnalyzers.id string
diagnosticAnalyzers.createdAt number

timestamp

Default value: currentTime
diagnosticAnalyzers.createdBy string

account uid
diagnosticAnalyzers.facility string
diagnosticAnalyzers.name string
diagnosticAnalyzers.description string
diagnosticAnalyzers.hl7Host string

[SENDING] the machine's TCP host address
diagnosticAnalyzers.hl7Port string

[SENDING] the machine's TCP port
diagnosticAnalyzers.hl7Version string

the hl7 version it can accept
diagnosticAnalyzers.hl7SendingFacility string

[RECEIVING] the hl7 MSH-3
diagnosticAnalyzers.hl7SendingApplication string

[RECEIVING] the hl7 MSH-4
diagnosticAnalyzers.hl7ReceivingFacility string

[SENDING] the hl7 MSH-5
diagnosticAnalyzers.hl7ReceivingApplication string

[SENDING] the hl7 MSH-6

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

Back to top

Get a specific diagnostic analyzer

GET /diagnostic-analyzers/: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-analyzers/<diagnostic-analyzer-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
facility string
name string
description string
hl7Host string

[SENDING] the machine's TCP host address
hl7Port string

[SENDING] the machine's TCP port
hl7Version string

the hl7 version it can accept
hl7SendingFacility string

[RECEIVING] the hl7 MSH-3
hl7SendingApplication string

[RECEIVING] the hl7 MSH-4
hl7ReceivingFacility string

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string

[SENDING] the hl7 MSH-6

Success response example

Success response example - Success-Response:

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

Diagnostic Analyzer - Patch

Back to top

Update diagnostic analyzer

PATCH /diagnostic-analyzers/: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
id string optional
name string
description string optional
hl7Host string optional

[SENDING] the machine's TCP host address
hl7Port string optional

[SENDING] the machine's TCP port
hl7Version string optional

the hl7 version it can accept

Default value: 2.3
hl7SendingFacility string optional

[RECEIVING] the hl7 MSH-3

Default value: facility
hl7SendingApplication string optional

[RECEIVING] the hl7 MSH-4

Default value: id
hl7ReceivingFacility string optional

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string optional

[SENDING] the hl7 MSH-6
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

curl "https://yourdomain.com/diagnostic-analyzers/<diagnostic-analyzer-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "description": "some description"
  }'

Parameters examples

json - Request-Example

{
  "description": "some description"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
facility string
name string
description string
hl7Host string

[SENDING] the machine's TCP host address
hl7Port string

[SENDING] the machine's TCP port
hl7Version string

the hl7 version it can accept
hl7SendingFacility string

[RECEIVING] the hl7 MSH-3
hl7SendingApplication string

[RECEIVING] the hl7 MSH-4
hl7ReceivingFacility string

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string

[SENDING] the hl7 MSH-6

Success response example

Success response example - Success-Response:

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

Diagnostic Analyzer - Post

Back to top

Create diagnostic analyzer

POST /diagnostic-analyzers

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
id string optional
facility string
name string
description string optional
hl7Host string optional

[SENDING] the machine's TCP host address
hl7Port string optional

[SENDING] the machine's TCP port
hl7Version string optional

the hl7 version it can accept

Default value: 2.3
hl7SendingFacility string optional

[RECEIVING] the hl7 MSH-3

Default value: facility
hl7SendingApplication string optional

[RECEIVING] the hl7 MSH-4

Default value: id
hl7ReceivingFacility string optional

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string optional

[SENDING] the hl7 MSH-6
createdAt number optional

timestamp

Default value: currentTime

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "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
facility string
name string
description string
hl7Host string

[SENDING] the machine's TCP host address
hl7Port string

[SENDING] the machine's TCP port
hl7Version string

the hl7 version it can accept
hl7SendingFacility string

[RECEIVING] the hl7 MSH-3
hl7SendingApplication string

[RECEIVING] the hl7 MSH-4
hl7ReceivingFacility string

[SENDING] the hl7 MSH-5
hl7ReceivingApplication string

[SENDING] the hl7 MSH-6

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