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

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution
location_idstring(Required) Used to scope the request to the specified location
provider_idstringFilter for specific provider
patient_idstringFilter for specific patient
appointment_idstringFilter for specific appointment
pagenumberPage number. Starts with page 1
per_pagenumberNumber of results to return per page. Defaults is 5 per page and Max 300 per page

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cboolean\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;error&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;appointment_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;body_site&quot;:&quot;\u003cobject\u003e&quot;,&quot;fee&quot;:{&quot;amount&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;start_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;end_date&quot;:&quot;\u003cdate\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;patient_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;provider_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;appointment_id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;body_site&quot;:&quot;\u003cobject\u003e&quot;,&quot;fee&quot;:{&quot;amount&quot;:&quot;\u003cstring\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;start_date&quot;:&quot;\u003cdate\u003e&quot;,&quot;end_date&quot;:&quot;\u003cdate\u003e&quot;}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}