Communication

Communication

Any of:
archived_at
string or null <date-time>
category
string or null
Value: "Memo"
category_code
integer or null
Enum Value Description
12 Memo
Value: 12
confidential
boolean or null
content
string or null
created_at
string <date-time>
direction_code
integer or null
Enum Value Description
1 Sent
2 Received
Enum: 1 2
direction_description
string or null
Enum: "Received" "Sent"
from
string or null
id
string <int64>
object
object
to
string or null
type
string or null
Enum: "Email" "Other" "Phone call" "SMS"
type_code
integer or null
Enum Value Description
1 SMS
2 Email
3 Phone call
4 Other
Enum: 1 2 3 4
updated_at
string <date-time>
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "category": "Memo",
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "direction_code": 1,
  • "direction_description": "Received",
  • "from": "string",
  • "id": "1",
  • "links": {},
  • "patient": {},
  • "to": "string",
  • "type": "Email",
  • "type_code": 1,
  • "updated_at": "2019-08-24T14:15:22Z"
}

List communications

get/communications
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
id int64
archived_at date-time
created_at date-time
updated_at date-time
category_code integer
patient_id int64
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create memo communication
post/communications
Creating a memo with SMS or email as communication type will not send a communication.


A memo just records that a communication has taken place.


SecuritybasicAuth 
Request 
Request Body schema: application/json
category_code
integer or null




Enum Value
Description





12
Memo





 Value: 12  
confidential
boolean or null
 
content
string or null
 
direction_code
integer or null




Enum Value
Description





1
Sent




2
Received





 Enum: 1 2  
from
string or null
 
patient_id
string <int64> 
patient id


 
to
string or null
 
type_code
integer or null




Enum Value
Description





1
SMS




2
Email




3
Phone call




4
Other





 Enum: 1 2 3 4  
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "direction_code": 1,
  • "from": "string",
  • "patient_id": "1",
  • "to": "string",
  • "type_code": 1
}
Response samples 
application/json
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "category": "Memo",
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "direction_code": 1,
  • "direction_description": "Received",
  • "from": "string",
  • "id": "1",
  • "links": {},
  • "patient": {},
  • "to": "string",
  • "type": "Email",
  • "type_code": 1,
  • "updated_at": "2019-08-24T14:15:22Z"
}
Get communication
get/communications/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
query Parameters
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "category": "Memo",
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "direction_code": 1,
  • "direction_description": "Received",
  • "from": "string",
  • "id": "1",
  • "links": {},
  • "patient": {},
  • "to": "string",
  • "type": "Email",
  • "type_code": 1,
  • "updated_at": "2019-08-24T14:15:22Z"
}
Update memo communication
patch/communications/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
category_code
integer or null




Enum Value
Description





12
Memo





 Value: 12  
confidential
boolean or null
 
content
string or null
 
direction_code
integer or null




Enum Value
Description





1
Sent




2
Received





 Enum: 1 2  
from
string or null
 
patient_id
string <int64> 
patient id


 
to
string or null
 
type_code
integer or null




Enum Value
Description





1
SMS




2
Email




3
Phone call




4
Other





 Enum: 1 2 3 4  
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "direction_code": 1,
  • "from": "string",
  • "patient_id": "1",
  • "to": "string",
  • "type_code": 1
}
Response samples 
application/json
{
  • "archived_at": "2019-08-24T14:15:22Z",
  • "category": "Memo",
  • "category_code": 12,
  • "confidential": true,
  • "content": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "direction_code": 1,
  • "direction_description": "Received",
  • "from": "string",
  • "id": "1",
  • "links": {},
  • "patient": {},
  • "to": "string",
  • "type": "Email",
  • "type_code": 1,
  • "updated_at": "2019-08-24T14:15:22Z"
}
Archive memo communication
post/communications/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples