v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

support-activity

Get a single support-activity

Get support-activity data by id

get/support-activities/{id}

Path parameters

idinteger required

Example:1

Response

Object with support-activity data.

idinteger required

Support activity id

patientIdinteger required

Patient id

practitionerIdinteger required

The practitioner id of this support activity

serviceIdinteger required

The service id of this support activity

locationIdinteger required

The location id of this support activity

caseIdinteger nullable required

The case id of this support activity

notestring nullable required

Note for the support activity

itemCodestring nullable required

Item code for the support activity

repeatIdstring nullable required

An recurring support activity will have this repeat id

recurringRulestring nullable required

The rule for recurring support activity

unitstring nullable required

The support activity unit

pricingnumber nullable required

The support activity unit price, in dollar

quantitynumber nullable required

The support activity quantity

doNotInvoiceboolean nullable

Whether this support activity patient will not be invoiced

invoiceIdinteger nullable required

Invoice id of this support activity patient

archivedboolean nullable

Whether the support activity has been archived

Example response

{
  "id": 1,
  "patientId": 1,
  "practitionerId": 1,
  "serviceId": 1,
  "locationId": 1,
  "caseId": 1,
  "note": "Some notes",
  "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
  "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
  "pricing": 193.99,
  "quantity": 193.99,
  "invoiceId": 1
}