Tross
EZDERM

List patient notes

List a patient's notes and alerts.

POSThttps://api.ontross.com/api/integrations/ezderm/list-patient-notes
Request Fields
input.patient_id
string
required
EZDerm patient UUID returned by list-patients.
Example
"00000000-0000-4000-8000-000000001001"
input.note_type
string
EZDerm note filter, sent as the request's type. ALERTS is the value EZDerm's Alerts filter uses.
Example
"ALERTS"
Default
"ALERTS"
input.offset
integer
How many notes to skip, for paging.
Example
0
Default
0
input.limit
integer
Maximum notes to return, 1000 at most.
Example
1000
Default
1000
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
patient_id
string
Requested EZDerm patient UUID.
Example
"00000000-0000-4000-8000-000000001001"
count
integer
Total notes EZDerm holds for this patient and filter.
Example
12
filtered_count
integer
Notes matching the filter before paging.
Example
12
notes
array
One page of notes, in the order EZDerm returned them.
notes[].id
string
Note UUID.
notes[].text
string
Note body as entered, unmodified.
notes[].alert
boolean
True when EZDerm shows this note as an alert rather than a plain note.
notes[].active
boolean
Whether EZDerm still counts the note as active.
notes[].patientId
string
Patient the note belongs to, when EZDerm includes it.
notes[].createdById
string
User id that created the note.
notes[].createdBy
string
Display name of the note's author, when present.
notes[].modifiedBy
string
Display name of the last editor, when present.
notes[].dateCreated
string
Creation timestamp in EZDerm's original format.
notes[].dateModified
string
Last-modified timestamp in EZDerm's original format.
notes[].invitees
array
Staff roles the note is visible to, in EZDerm's order. A passthrough: charts carry roles the note dialog does not offer, such as PROVIDER.
Example
["CLINICAL_STAFF","BILLER"]
Code
curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ezderm/list-patient-notes \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"patient_id":"00000000-0000-4000-8000-000000001001","note_type":"ALERTS","offset":0,"limit":1000},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": "00000000-0000-4000-8000-000000001001",
    "note_type": "ALERTS",
    "offset": 0,
    "limit": 1000
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient_id": "00000000-0000-4000-8000-000000001001",
    "count": 12,
    "filtered_count": 12,
    "notes": [
      {
        "id": "string",
        "text": "string",
        "alert": true,
        "active": true,
        "patientId": "string",
        "createdById": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "dateCreated": "2019-08-24",
        "dateModified": "2019-08-24",
        "invitees": [
          "CLINICAL_STAFF",
          "BILLER"
        ]
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}