Care tasks activity logs

Create care task activity log

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

idanyRequired

Unique identifier for the activity log

Example: 12345

careTaskIdanyRequired

ID of the associated care task

Example: 1

careTaskPatientIdanyRequired

ID of the care task patient

Example: 100

activityDateTimeanyRequired

Date and time of the activity

Default: 2026-02-06T10:48:23.644ZExample: 2023-05-01T12:00:00Z

descriptionanyRequired

Description of the activity

Example: Patient completed exercise routine

userActionanyRequired

User action for the activity

Example: COMPLETED

attributesanyRequired

Additional attributes for the activity log

Default: {}Example: {"key":"value"}

financialEntryIdanyRequired

ID of the financial entry

Example: 100

valueanyRequired

Value associated with the activity

Example: 1

unitanyRequired

Unit associated with the activity

Example: STEPS

Responses

200Success

application/json

201

Created successfully

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

post

/api/patients/{patientId}/care-tasks-activity-logs

HTTPcURLJavaScriptPython

POST /api/patients/{patientId}/care-tasks-activity-logs HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "id": "12345",
  "careTaskId": 1,
  "careTaskPatientId": 100,
  "activityDateTime": "2023-05-01T12:00:00Z",
  "description": "Patient completed exercise routine",
  "userAction": "COMPLETED",
  "attributes": {
    "key": "value"
  },
  "financialEntryId": 100,
  "value": "1",
  "unit": "STEPS"
}

{
  "id": "12345",
  "patientId": 1001,
  "patientExternalId": "EXT12345",
  "careTaskId": 1,
  "internalTaskId": "TASK001",
  "careTaskPatientId": 2001,
  "activityDateTime": "2023-01-01T00:00:00Z",
  "completed": true,
  "dayOfWeek": "MONDAY",
  "dueDate": "2023-01-02T00:00:00Z",
  "description": "Patient completed exercise",
  "userAction": "DONE",
  "endDate": "2023-01-03T00:00:00Z",
  "attributes": {
    "key": "value"
  },
  "careTaskActivityLogFile": [],
  "careTask": {},
  "financialEntryId": 12345,
  "value": "1",
  "unit": "STEPS"
}

Update care task activity log

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

activityIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

idanyRequired

Unique identifier for the activity log

Example: 12345

careTaskIdanyRequired

ID of the associated care task

Example: 1

careTaskPatientIdanyRequired

ID of the care task patient

Example: 100

activityDateTimeanyRequired

Date and time of the activity

Default: 2026-02-06T10:48:23.644ZExample: 2023-05-01T12:00:00Z

descriptionanyRequired

Description of the activity

Example: Patient completed exercise routine

userActionanyRequired

User action for the activity

Example: COMPLETED

attributesanyRequired

Additional attributes for the activity log

Default: {}Example: {"key":"value"}

financialEntryIdanyRequired

ID of the financial entry

Example: 100

valueanyRequired

Value associated with the activity

Example: 1

unitanyRequired

Unit associated with the activity

Example: STEPS

Responses

200Success

application/json

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

put

/api/patients/{patientId}/care-tasks-activity-logs/{activityId}

HTTPcURLJavaScriptPython

PUT /api/patients/{patientId}/care-tasks-activity-logs/{activityId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 250

{
  "id": "12345",
  "careTaskId": 1,
  "careTaskPatientId": 100,
  "activityDateTime": "2023-05-01T12:00:00Z",
  "description": "Patient completed exercise routine",
  "userAction": "COMPLETED",
  "attributes": {
    "key": "value"
  },
  "financialEntryId": 100,
  "value": "1",
  "unit": "STEPS"
}

{
  "id": "12345",
  "patientId": 1001,
  "patientExternalId": "EXT12345",
  "careTaskId": 1,
  "internalTaskId": "TASK001",
  "careTaskPatientId": 2001,
  "activityDateTime": "2023-01-01T00:00:00Z",
  "completed": true,
  "dayOfWeek": "MONDAY",
  "dueDate": "2023-01-02T00:00:00Z",
  "description": "Patient completed exercise",
  "userAction": "DONE",
  "endDate": "2023-01-03T00:00:00Z",
  "attributes": {
    "key": "value"
  },
  "careTaskActivityLogFile": [],
  "careTask": {},
  "financialEntryId": 12345,
  "value": "1",
  "unit": "STEPS"
}

Delete care task activity log

delete

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

activityIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

delete

/api/patients/{patientId}/care-tasks-activity-logs/{activityId}

HTTPcURLJavaScriptPython

DELETE /api/patients/{patientId}/care-tasks-activity-logs/{activityId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

{
  "id": "12345",
  "patientId": 1001,
  "patientExternalId": "EXT12345",
  "careTaskId": 1,
  "internalTaskId": "TASK001",
  "careTaskPatientId": 2001,
  "activityDateTime": "2023-01-01T00:00:00Z",
  "completed": true,
  "dayOfWeek": "MONDAY",
  "dueDate": "2023-01-02T00:00:00Z",
  "description": "Patient completed exercise",
  "userAction": "DONE",
  "endDate": "2023-01-03T00:00:00Z",
  "attributes": {
    "key": "value"
  },
  "careTaskActivityLogFile": [],
  "careTask": {},
  "financialEntryId": 12345,
  "value": "1",
  "unit": "STEPS"
}