Skip to main content
API docs by Redocly

Communications (3.0.0)

Channel

Access and Manage Communication Channel metadata

Retrieve Communication Channels

Retrieve a list of Communication channels such as SMS, Email and practice defined options.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (CommunicationChannel)
Array
channel-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
hidden
boolean
system-defined
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "channel-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
      • "name": "Email",
      • "description": "Email",
      • "view-order": 0,
      • "hidden": false,
      • "system-defined": true
      }
    ]
}

Retrieve Communication Channel

Retrieve a single communication channel.

path Parameters
channel-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
channel-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
hidden
boolean
system-defined
boolean

Response samples

Content type
application/json
{
  • "channel-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "name": "Email",
  • "description": "Email",
  • "view-order": 0,
  • "hidden": false,
  • "system-defined": true
}

Type

Access and Manage Communication Type metadata

Retrieve Communication Types

Retrieve a list of Communication types.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (CommunicationType)
Array
type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
hidden
boolean
opt-in
boolean
system-defined
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "type-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
      • "name": "Marketing",
      • "description": "Marketing",
      • "view-order": 0,
      • "hidden": false,
      • "opt-in": true,
      • "system-defined": true
      }
    ]
}

Retrieve Communication Type

Retrieve a single communication type.

path Parameters
type-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
hidden
boolean
opt-in
boolean
system-defined
boolean

Response samples

Content type
application/json
{
  • "type-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "name": "Marketing",
  • "description": "Marketing",
  • "view-order": 0,
  • "hidden": false,
  • "opt-in": true,
  • "system-defined": true
}

Document Template

Access and Manage Document Template

Retrieve Document Templates

Retrieve a list of the metadata for Document Templates

query Parameters
required
object (Pageable)

Pageable parameters

type
string (DocumentTemplateType)
Enum: "ACCOUNT" "DEBT-CHASE" "REMINDER-PATIENT" "FORMULARY" "REMINDER-TREATMENT" "CLINICAL" "PRESCRIPTION" "CONSENT" "MARKETING" "REMINDER-APPOINTMENT" "PAYMENT-LINK"
Example: type=ACCOUNT
location-uuid
string <uuid>
Example: location-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json
Array of objects (DocumentTemplate)
Array
document-template-uuid
string <uuid>
status
string
Enum: "TEMPLATE_AVAILABLE" "TEMPLATE_EDITING" "TEMPLATE_ARCHIVED"
type
string (DocumentTemplateType)
Enum: "ACCOUNT" "DEBT-CHASE" "REMINDER-PATIENT" "FORMULARY" "REMINDER-TREATMENT" "CLINICAL" "PRESCRIPTION" "CONSENT" "MARKETING" "REMINDER-APPOINTMENT" "PAYMENT-LINK"
location-uuid
string <uuid>
file-resource-ref
string <= 100 characters
file-name
string <= 255 characters
date-modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "document-template-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
      • "status": "TEMPLATE_AVAILABLE",
      • "type": "ACCOUNT",
      • "location-uuid": "EA432DE3-33DA-467F-B303-31A4BC0007C3",
      • "file-resource-ref": "html:0BwQa5PqI9QxSeDZUdUxKX0c3VUE",
      • "file-name": "Prescription_Template_01",
      • "date-modified": "2022-01-17T12:09:00Z"
      }
    ]
}

Retrieve Document Template

Retrieve a single document template.

path Parameters
document-template-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
document-template-uuid
string <uuid>
status
string
Enum: "TEMPLATE_AVAILABLE" "TEMPLATE_EDITING" "TEMPLATE_ARCHIVED"
type
string (DocumentTemplateType)
Enum: "ACCOUNT" "DEBT-CHASE" "REMINDER-PATIENT" "FORMULARY" "REMINDER-TREATMENT" "CLINICAL" "PRESCRIPTION" "CONSENT" "MARKETING" "REMINDER-APPOINTMENT" "PAYMENT-LINK"
location-uuid
string <uuid>
file-resource-ref
string <= 100 characters
file-name
string <= 255 characters
date-modified
string <date-time>

Response samples

Content type
application/json
{
  • "document-template-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "status": "TEMPLATE_AVAILABLE",
  • "type": "ACCOUNT",
  • "location-uuid": "EA432DE3-33DA-467F-B303-31A4BC0007C3",
  • "file-resource-ref": "html:0BwQa5PqI9QxSeDZUdUxKX0c3VUE",
  • "file-name": "Prescription_Template_01",
  • "date-modified": "2022-01-17T12:09:00Z"
}

Retrieve Document Template File

Retrieve the file content of a Document Template

path Parameters
document-template-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Headers
Content-Disposition
string

filename

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "messages": [
    • "string"
    ]
}

SMS Template

Access and Manage Sms Templates

Retrieve SMS Templates

Retrieve a list of the metadata for SMS Templates

query Parameters
required
object (Pageable)

Pageable parameters

type
string (SmsTemplateType)
Enum: "ADHOC" "RECALL" "APPOINTMENT-REMINDER" "MARKETING" "CLIENT" "MOBILE-EDITION-APPT" "COMPLIANCE-REMINDER" "PAYMENT"
Example: type=PAYMENT

Responses

Response Schema: application/json
Array of objects (SmsTemplate)
Array
sms-template-uuid
string <uuid>
template-content
string <= 1024 characters
date-modified
string <date-time>
type
string (SmsTemplateType)
Enum: "ADHOC" "RECALL" "APPOINTMENT-REMINDER" "MARKETING" "CLIENT" "MOBILE-EDITION-APPT" "COMPLIANCE-REMINDER" "PAYMENT"

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "sms-template-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
      • "template-content": "this is a template text",
      • "date-modified": "2022-01-17T12:09:00Z",
      • "type": "PAYMENT"
      }
    ]
}

Retrieve SMS Template

Retrieve a single SMS template.

path Parameters
sms-template-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
sms-template-uuid
string <uuid>
template-content
string <= 1024 characters
date-modified
string <date-time>
type
string (SmsTemplateType)
Enum: "ADHOC" "RECALL" "APPOINTMENT-REMINDER" "MARKETING" "CLIENT" "MOBILE-EDITION-APPT" "COMPLIANCE-REMINDER" "PAYMENT"

Response samples

Content type
application/json
{
  • "sms-template-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "template-content": "this is a template text",
  • "date-modified": "2022-01-17T12:09:00Z",
  • "type": "PAYMENT"
}

Document

Access and Manage Document

Create a document entry

Upload a document to the system which is stored in the google drive and record is created

Request Body schema: multipart/form-data
required
file
required
string <binary>
required
object (CreateDocumentRequest)

Responses

Response Schema: application/json
document-folder-uuid
string <uuid>
document-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "document-folder-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "document-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026"
}

Retrieve a list of Documents metadata

Retrieve the metadata for Document

query Parameters
required
object (Pageable)

Pageable parameters

document-folder-uuid
string <uuid>
Example: document-folder-uuid=E91E735F-2F22-4DEB-A072-D76B28A9818E
location-uuid
string <uuid>
Example: location-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json
Array of objects (Document)
Array
document-uuid
string <uuid>
document-folder-uuid
string <uuid>
file-name
string <= 255 characters
file-resource-ref
string <= 100 characters
date-created
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "document-uuid": "0C86886B-2E3A-4F42-AD5A-8EEEB1AB3EB5",
      • "document-folder-uuid": "E8A38B3B-90BE-4E92-BC3B-A1977902E245",
      • "file-name": "VET_ANIMAL_12903840_1150792771796.pdf",
      • "file-resource-ref": "html:0BwQa5PqI9QxSeDZUdUxKX0c3VUE",
      • "date-created": "2022-01-17T12:09:00Z"
      }
    ]
}

Retrieve Document

Retrieve a single document metadata.

path Parameters
document-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
document-uuid
string <uuid>
document-folder-uuid
string <uuid>
file-name
string <= 255 characters
file-resource-ref
string <= 100 characters
date-created
string <date-time>

Response samples

Content type
application/json
{
  • "document-uuid": "0C86886B-2E3A-4F42-AD5A-8EEEB1AB3EB5",
  • "document-folder-uuid": "E8A38B3B-90BE-4E92-BC3B-A1977902E245",
  • "file-name": "VET_ANIMAL_12903840_1150792771796.pdf",
  • "file-resource-ref": "html:0BwQa5PqI9QxSeDZUdUxKX0c3VUE",
  • "date-created": "2022-01-17T12:09:00Z"
}

Retrieve documents

Retrieve a list of documents related to communication log

path Parameters
log-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D

Responses

Response Schema: application/json
document-folder-uuid
string <uuid>
document-uuid
Array of strings <uuid> [ items <uuid > ]

Response samples

Content type
application/json
{
  • "document-folder-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "document-uuid": [
    • "EA432DE3-33DA-467F-B303-31A4BC0007C3"
    ]
}

Log

Access and Manage Communication Logs

Create log entry

Create a communication log entry

Request Body schema: application/json
required
contact-uuid
required
string <uuid>
communication-channel-uuid
required
string <uuid>
patient-uuid
string <uuid>
communication-type-uuid
string <uuid>
location-uuid
required
string <uuid>
log-entry
required
string [ 1 .. 7000 ] characters
sent-date
string <date-time>
sent-by-third-party
boolean
third-party-name
string <= 200 characters
third-party-reference
string <= 200 characters
document-folder-uuid
string <uuid>
content-description
string <= 7000 characters
content-message
string <= 620 characters
content-recipient
string <= 250 characters
content-recipient-cc
string <= 250 characters
content-subject
string <= 80 characters
content-reference
string <= 20 characters
service-provider-response-code
string <= 180 characters
service-provider-status
string <= 50 characters
service-provider-delivered
boolean
service-provider-reference
string <= 255 characters
sender-contact-uuid
string <uuid>
error-message
string <= 200 characters
document-template-uuid
string <uuid>

Responses

Response Schema: application/json
log-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "contact-uuid": "3C4A1FAA-7696-4DD7-8F9C-15399EF6B196",
  • "communication-channel-uuid": "79CDE714-B8FF-48F1-9CE8-6608BB01D4AB",
  • "patient-uuid": "C70EB2C0-0CB4-43FA-A9BE-CA3DE34E3E3D",
  • "communication-type-uuid": "23ACE7CA-B1C9-49FF-8084-19D73CEF0051",
  • "location-uuid": "EA432DE3-33DA-467F-B303-31A4BC0007C3",
  • "log-entry": "Patient reminder sent",
  • "sent-date": "2022-01-17T12:09:00Z",
  • "sent-by-third-party": false,
  • "third-party-name": "string",
  • "third-party-reference": "string",
  • "document-folder-uuid": "5453E7D7-966B-4AF9-8E78-0E93257FCBD0",
  • "content-description": "string",
  • "content-message": "string",
  • "content-recipient": "string",
  • "content-recipient-cc": "string",
  • "content-subject": "string",
  • "content-reference": "string",
  • "service-provider-response-code": "string",
  • "service-provider-status": "string",
  • "service-provider-delivered": true,
  • "service-provider-reference": "string",
  • "sender-contact-uuid": "5453E7D7-966B-4AF9-8E78-0E93257FCBD0",
  • "error-message": "string",
  • "document-template-uuid": "97fd484a-0b5d-4b27-b6ca-cdd621b81508"
}

Response samples

Content type
application/json
{
  • "log-uuid": "EB9E4D19-06C0-438E-AF58-74BCF0219160"
}

Retrieve log entries

Retrieve a list of Log entries.

query Parameters
required
object (Pageable)

Pageable parameters

search-term
string
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals
search-field
string (CommunicationLogSearchField)
Default: "content-message"
Enum: "content-recipient" "content-description" "content-message" "log-entry"
Example: search-field=equals
contact-uuid
string <uuid>
Example: contact-uuid=3BA55574-8FB3-4DEF-94F8-80CF390FFA3D
patient-uuid
string <uuid>
Example: patient-uuid=3BA55574-8FB3-4DEF-94F8-80CF390FFA3D
communication-channel-uuid
string <uuid>
Example: communication-channel-uuid=3BA55574-8FB3-4DEF-94F8-80CF390FFA3D
communication-type-uuid
string <uuid>
Example: communication-type-uuid=3BA55574-8FB3-4DEF-94F8-80CF390FFA3D
log-date-start
string <date-time>
Example: log-date-start=2021-07-01T00:00:00.00Z
log-date-end
string <date-time>
Example: log-date-end=2021-07-02T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (CommunicationLog)
Array
communication-log-uuid
string <uuid>
contact-uuid
string <uuid>
patient-uuid
string <uuid>
log-entry
string
communication-channel-uuid
string <uuid>
communication-type-uuid
string <uuid>
log-date
string <date-time>
location-uuid
string <uuid>
third-party-reference
string
sent-by-third-party
boolean
third-party-name
string
document-folder-uuid
string <uuid>
content-description
string
content-message
string
content-recipient
string
content-subject
string
content-reference
string
service-provider-response-code
string
service-provider-status
string
service-provider-delivered
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "communication-log-uuid": "EB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "contact-uuid": "CF9E4D19-06C0-438E-AF58-74BCF0219160",
      • "patient-uuid": "ZB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "log-entry": "string",
      • "communication-channel-uuid": "ZB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "communication-type-uuid": "ZB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "log-date": "2021-01-07T15:50:00.00Z",
      • "location-uuid": "ZB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "third-party-reference": "string",
      • "sent-by-third-party": true,
      • "third-party-name": "string",
      • "document-folder-uuid": "ZB9E4D19-06C0-438E-AF58-74BCF0219160",
      • "content-description": "string",
      • "content-message": "string",
      • "content-recipient": "string",
      • "content-subject": "string",
      • "content-reference": "string",
      • "service-provider-response-code": "string",
      • "service-provider-status": "string",
      • "service-provider-delivered": true
      }
    ]
}

Create Communication Log Status

Create a Communication Log Status

path Parameters
log-uuid
required
string <uuid>
Example: 3BA55574-8FB3-4DEF-94F8-80CF390FFA3D
Request Body schema: application/json
required
recipient
required
string [ 1 .. 100 ] characters
status
required
string [ 1 .. 50 ] characters
status-message
string [ 0 .. 4000 ] characters
status-date
required
string <date-time>

Responses

Response Schema: application/json
log-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "recipient": "user@somewhere.com",
  • "status": "string",
  • "status-message": "string",
  • "status-date": "2022-01-17T12:09:00Z"
}

Response samples

Content type
application/json
{
  • "log-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026"
}