Athena Fetch Patient Treatment Plan

POSThttps://api.ontross.com/api/integrations/athena/fetch-patient-treatment-plan

input

object

required

Input object.

input.org_id

integer

required

Org id

input.department_id

integer

required

Department id

input.patient_id

integer

required

Patient id

auth_id

string

required

Auth id

treatment_plan_summary

object

Treatment-plan audit and review summary.

treatment_plan_summary.added_timestamp

string

ISO-8601 timestamp when the treatment plan was added.

treatment_plan_summary.added_by

string

Name of the user who added the treatment plan.

treatment_plan_summary.review_due_date

string

ISO-8601 treatment-plan review due date.

treatment_plan_summary.last_action_by

string

Name of the user who last changed the treatment plan.

treatment_plan_summary.last_action_timestamp

string

ISO-8601 timestamp of the last treatment-plan change.

concerns_data

array

Treatment-plan concerns and their linked goals.

concerns_data[].id

string

Athena health-concern problem identifier.

concerns_data[].concern

string

Concern or problem name.

concerns_data[].is_active

boolean

Whether the concern is active; Athena marks Achieved concerns as inactive.

concerns_data[].associated_diagnoses

string

Comma-separated diagnosis codes and descriptions.

concerns_data[].as_evidenced_by

string

Symptom, note, or observation supporting the concern.

concerns_data[].goals

array

Names of goals linked to this concern.

concerns_data[].goals_text

string

Pipe-delimited representation of linked goal names.

concerns_data[].added_by

string

Name of the user who added the concern.

concerns_data[].added_at

string

Formatted date and time when the concern was added.

concerns_data[].last_action_by

string

Name of the user who last changed the concern.

concerns_data[].last_action_at

string

Formatted date and time of the last concern change.

concerns_data[].list_menu

boolean

Whether the concern supports row-level menu actions.

client_characteristics

array

Athena patient characteristic observations.

client_characteristics[].ObservationId

string

Athena observation identifier.

client_characteristics[].TypeName

string

Characteristic category, such as Strength, Barrier, or Ability.

client_characteristics[].Summary

string

Characteristic description.

client_characteristics[].Archived

boolean

Whether the observation is archived.

client_characteristics[].HealthConcerns

array

Health concerns linked to the observation.

client_characteristics[].HealthConcerns[].HealthConcernId

string

Athena health-concern identifier.

client_characteristics[].HealthConcerns[].SnomedCode

string

SNOMED code associated with the health concern.

client_characteristics[].Created

string

ISO-8601 timestamp when the observation was created.

client_characteristics[].CreatedBy

object

Created by object.

client_characteristics[].CreatedBy.Id

string

Athena user identifier.

client_characteristics[].CreatedBy.FirstName

string

User first name.

client_characteristics[].CreatedBy.LastName

string

User last name.

client_characteristics[].CreatedBy.Suffix

string

Suffix

client_characteristics[].LastModified

string

Last modified

client_characteristics[].LastModifiedBy

object

Created by object.

client_characteristics[].LastModifiedBy.Id

string

Athena user identifier.

client_characteristics[].LastModifiedBy.FirstName

string

User first name.

client_characteristics[].LastModifiedBy.LastName

string

User last name.

client_characteristics[].LastModifiedBy.Suffix

string

Suffix

goals

array

Treatment-plan goals with independent objective and intervention collections.

goals[].goal_id

string

Athena goal identifier.

goals[].goal_name

string

Goal name.

goals[].description

string

Goal description.

goals[].progress_status

string

Current goal progress status.

goals[].achievement_status

string

Current goal achievement status.

goals[].achievement_status_reason

string

Reason for the achievement status.

goals[].achievement_status_by

string

Name of the user who set the achievement status.

goals[].achievement_status_at

string

Formatted date and time when achievement status was set.

goals[].lifecycle_status

string

Goal lifecycle status.

goals[].is_active

boolean

Whether the goal is active.

goals[].is_priority

boolean

Whether the goal is marked as a priority.

goals[].priority

string

Goal priority.

goals[].patient_goal_statement

string

Goal statement supplied by the patient.

goals[].baseline_description

string

Baseline description for measuring goal progress.

goals[].targeted_concerns

string

Parent treatment plan or health concern.

goals[].start_date

string

Formatted goal start date.

goals[].end_date

string

Formatted goal end date.

goals[].review_date

string

Formatted goal review date.

goals[].medical_codes

array

Medical codes associated with the goal.

goals[].medical_codes[].system

string

Coding system name.

goals[].medical_codes[].code

string

Code value in the specified coding system.

goals[].statuses

array

Status codes associated with the goal.

goals[].statuses[].system

string

Coding system name.

goals[].statuses[].code

string

Code value in the specified coding system.

goals[].modalities

array

Treatment modalities associated with the goal.

goals[].session_settings

array

Session settings associated with the goal.

goals[].target

object

Primary goal target measurement.

goals[].target.measurement_type_id

string

Athena measurement-type identifier.

goals[].target.end_date

string

Formatted target or milestone end date.

goals[].target.values

array

Measurement component values.

goals[].milestones

array

Goal milestone measurements.

goals[].milestones[].measurement_type_id

string

Athena measurement-type identifier.

goals[].milestones[].end_date

string

Formatted target or milestone end date.

goals[].milestones[].values

array

Measurement component values.

goals[].baseline_measurements

array

Baseline measurements for the goal.

goals[].baseline_measurements[].measurement_type_id

string

Athena measurement-type identifier.

goals[].baseline_measurements[].start_date

string

Formatted baseline measurement start date.

goals[].baseline_measurements[].values

array

Baseline measurement component values.

goals[].objectives

array

Objectives linked directly to this goal.

goals[].objectives[].objective_id

string

Athena TaskSchedule identifier for the objective.

goals[].objectives[].objective_name

string

Objective name.

goals[].objectives[].description

string

Objective description.

goals[].objectives[].status

string

Objective status.

goals[].objectives[].priority

string

Objective priority.

goals[].objectives[].note

string

Objective note.

goals[].objectives[].start_date

string

Formatted objective start date.

goals[].objectives[].end_date

string

Formatted objective end date.

goals[].objectives[].added_by

string

Name of the user who added the objective.

goals[].objectives[].added_at

string

Formatted date and time when the objective was added.

goals[].objectives[].last_action_by

string

Name of the user who last changed the objective.

goals[].objectives[].last_action_at

string

Formatted date and time of the last objective change.

goals[].interventions

array

Interventions linked directly to this goal; independent of objectives.

goals[].interventions[].intervention_id

string

Athena ScheduledTask identifier for the intervention.

goals[].interventions[].intervention_name

string

Intervention name.

goals[].interventions[].description

string

Intervention description.

goals[].interventions[].measurement_type

string

Intervention measurement type.

goals[].interventions[].measurement_units

string

Units used to measure the intervention.

goals[].interventions[].duration

integer

Duration

goals[].interventions[].note

string

Intervention note.

goals[].added_by

string

Name of the user who added the goal.

goals[].added_at

string

Formatted date and time when the goal was added.

goals[].last_action_by

string

Name of the user who last changed the goal.

goals[].last_action_at

string

Formatted date and time of the last goal change.

curl --request POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-patient-treatment-plan \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":0,"department_id":0,"patient_id":0},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "org_id": 0,
    "department_id": 0,
    "patient_id": 0
  },
  "auth_id": "auth_uuid_here"
}