Tross
Demo dataBook a demo
NETSMART

Get patient episodes

List a patient's episodes.

POSThttps://preview.ontross.com/api/integrations/netsmart/get-patient-episodes
Request Fields
input.patient_id
string
required
Compass NX client whose chart is read or written, from fetch-appointments.
Example
"433194"
input.system
string
Which Compass NX deployment to call, live or test.
Example
"PROD"
Default
"PROD"
Accepted values
PRODUAT
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
episodes
array
Care episodes on this chart, selectable when filing notes.
episodes[].id
string
Care period identifier used when filing patient notes.
Example
"3"
episodes[].label
string
Display text for a selectable care period.
Example
"Outpatient Behavioral Health"
episodes[].default
boolean
True for the episode Compass NX preselects on forms.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/netsmart/get-patient-episodes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"system":"PROD","patient_id":"433194"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "system": "PROD",
    "patient_id": "433194"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "episodes": [
      {
        "id": "3",
        "label": "Outpatient Behavioral Health",
        "default": true
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}