View procedures
GET {{baseUrl}}/procedures?subdomain={{subdomain}}&location_id={{location_id}}&provider_id=<integer>&patient_id=<integer>&appointment_id=<integer>&page=1&per_page=5
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified location | |
provider_id | string | Filter for specific provider | |
patient_id | string | Filter for specific patient | |
appointment_id | string | Filter for specific appointment | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 300 per page |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"}],"count":"\u003cinteger\u003e"}