Medical Alert

MedicalAlert

archived_at
string or null <date-time>
created_at
string <date-time>
deleted_at
string or null <date-time>
id
string <int64>
object
name
string [ 1 .. 255 ] characters
object
updated_at
string <date-time>
{}

List medical alerts

get/medical_alerts
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
deleted_at date-time
updated_at date-time
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 medical alert
post/medical_alerts
SecuritybasicAuth 
Request 
Request Body schema: application/json
name
string  [ 1 .. 255 ] characters 
 
patient_id
string <int64> 
patient id


 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "name": "string",
  • "patient_id": "1"
}
Response samples 
application/json
{}
Get medical alert
get/medical_alerts/{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




deleted_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}
Update medical alert
patch/medical_alerts/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
name
string  [ 1 .. 255 ] characters 
 
patient_id
string <int64> 
patient id


 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "name": "string",
  • "patient_id": "1"
}
Response samples 
application/json
{}
Archive medical alertDeprecated
delete/medical_alerts/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


Request samples 
Archive medical alert
post/medical_alerts/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples 
List medical alerts for patient
get/patients/{patient_id}/medical_alerts
SecuritybasicAuth 
Request 
path Parameters
patient_id
required
string <int64> 
 
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




deleted_at
date-time




updated_at
date-time





 
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
{}