EZDERM

Create patient note

Add a note or alert to a patient's chart.

POSThttps://api.ontross.com/api/integrations/ezderm/create-patient-note

Request Fields

input.patient_id

string

required

EZDerm patient UUID returned by list-patients.

Example

"00000000-0000-4000-8000-000000001001"

input.text

string

required

Note body, stored exactly as sent.

Example

"Eligibility checked\nActive Status\nHealth Plan: Anthem BC PPO"

input.alert

boolean

True files it as an alert, which the chart surfaces more prominently than a plain note.

Example

false

Default

false

input.invitees

array

Staff roles the note is visible to. Every role EZDerm's own dialog invites when omitted.

Example

["CLINICAL_STAFF","BILLER"]

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

note

object

The stored note as EZDerm returned it, including its new id.

note.id

string

Note UUID.

note.text

string

Note body as entered, unmodified.

note.alert

boolean

True when EZDerm shows this note as an alert rather than a plain note.

note.active

boolean

Whether EZDerm still counts the note as active.

note.patientId

string

Patient the note belongs to, when EZDerm includes it.

note.createdById

string

User id that created the note.

note.createdBy

string

Display name of the note's author, when present.

note.modifiedBy

string

Display name of the last editor, when present.

note.dateCreated

string

Creation timestamp in EZDerm's original format.

note.dateModified

string

Last-modified timestamp in EZDerm's original format.

note.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/create-patient-note \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"patient_id":"00000000-0000-4000-8000-000000001001","text":"Eligibility checked\nActive Status\nHealth Plan: Anthem BC PPO","alert":false,"invitees":["CLINICAL_STAFF","BILLER"]},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "00000000-0000-4000-8000-000000001001",
    "text": "Eligibility checked\nActive Status\nHealth Plan: Anthem BC PPO",
    "alert": false,
    "invitees": [
      "CLINICAL_STAFF",
      "BILLER"
    ]
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "note": {
      "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"
}