API docs by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:Download

subscription-controller

createSubscription

Subscribe to receive updates from an EHR

Authorizations:
bearer-key
Request Body schema: application/json
required
source
string
name
string
description
string
object (Webhook)
channels
Array of strings
filters
Array of strings
hints
Array of strings

Responses

Request samples

Content type
application/json
{
  • "source": "string",
  • "name": "string",
  • "description": "string",
  • "webhook": {
    },
  • "channels": [
    ],
  • "filters": [
    ],
  • "hints": [
    ]
}

pauseSubscription

Pause Subscription

Authorizations:
bearer-key
path Parameters
id
required
string
Request Body schema: application/json
required
status
string
Enum: "ACTIVE" "PAUSED" "DELETED"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

getEventsForSubscription

Get all events for a subscription

Authorizations:
bearer-key
path Parameters
id
required
string
query Parameters
status
string
Enum: "SUCCESS" "PENDING" "FAIL" "SENDING"
before
string
after
string
iterator
string
channel
string
Enum: "FHIR_PLUS_PLUS" "XHO"

Responses

deleteSubscription

Delete subscription

Authorizations:
bearer-key
path Parameters
id
required
string

Responses

ping-pong-webhook-test-controller

stimulate

Subscribe to receive updates from an EHR

Authorizations:
bearer-key
Request Body schema: application/json
required
instanceId
string
channel
string
eventType
string
sourceId
string

Responses

Request samples

Content type
application/json
{
  • "instanceId": "string",
  • "channel": "string",
  • "eventType": "string",
  • "sourceId": "string"
}

pong

Subscribe to receive updates from an EHR

Authorizations:
bearer-key
Request Body schema: application/json
required
instanceId
string
channel
string
eventType
string
sourceId
string

Responses

Request samples

Content type
application/json
{
  • "instanceId": "string",
  • "channel": "string",
  • "eventType": "string",
  • "sourceId": "string"
}

event-type-controller

getAllEventTypes

Get a list of all supported events

Authorizations:
bearer-key
query Parameters
entityType
string

Responses

createEventType

Add a new event type to the system

Authorizations:
bearer-key
Request Body schema: application/json
required
type
required
string
description
required
string
trigger
required
object (JSONObject)
entityType
required
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "description": "string",
  • "trigger": { },
  • "entityType": "string",
  • "status": "string"
}

getEventTypes

Get a list of all supported events

Authorizations:
bearer-key

Responses

getEventsTypes

Get a list of all supported events

Authorizations:
bearer-key

Responses

stats-controller

getSubscriptionStats

Pause Subscription

Authorizations:
bearer-key
path Parameters
id
required
string
query Parameters
to
string
from
string

Responses

getStats

Get Stats for a instance

Authorizations:
bearer-key
query Parameters
to
string
from
string

Responses

getUsage

Responses

event-controller

listEvents

Get a list of all events

Authorizations:
bearer-key
query Parameters
status
string
Enum: "SUCCESS" "PENDING" "FAIL" "SENDING"
before
string
after
string
eventType
string
limit
string
offset
string
channel
string
Enum: "FHIR_PLUS_PLUS" "XHO"
header Parameters
x-source-id
required
string

Responses

chanel-controller

listChannels

Get a list of all available channels

Authorizations:
bearer-key

Responses