api-docs v5.116.0

API Docs

Table of contents

HL7_Message

HL7 Message - Find

Back to top

Get list of hl7 messages

GET /hl7-messages

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

Success response

Success response - Success 200

Name Type Description
hl7Messages object[]

array of hl7Message
hl7Messages.id string
hl7Messages.direction string Allowed values: inbound,outbound
hl7Messages.message string

raw hl7 message
hl7Messages.messageType string

raw hl7 message type
hl7Messages.organization string

sending/receiving organization
hl7Messages.analyzer string

analyzer id the message is from/for
hl7Messages.order string

order the message is for

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "direction": "inbound"
  },
  {
    "id": "id-2",
    "direction": "outbound"
  }
]

HL7 Message - Get

Back to top

Get a specific hl7 message

GET /hl7-messages/: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/hl7-messages/<hl7-message-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
direction string Allowed values: inbound,outbound
message string

raw hl7 message
messageType string

raw hl7 message type
organization string

sending/receiving organization
analyzer string

analyzer id the message is from/for
order string

order the message is for

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "direction": "inbound"
}

results matching ""

    No results matching ""