EZDERM

Fetch encounter progress note pdf

Download one encounter's progress note PDF, regardless of status.

POSThttps://api.ontross.com/api/integrations/ezderm/fetch-encounter-progress-note-pdf

Request Fields

input.patient_id

string

required

EZDerm patient UUID to verify against the encounter.

Example

"3f2504e0-4f89-11d3-9a0c-0305e82c3301"

input.encounter_id

string

required

Encounter UUID from list-patient-encounters, preserving its original letter case.

Example

"C72A6148-3D9E-4B05-AF61-8E297CD430B2"

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

Verified patient UUID.

Example

"b93d4826-78a1-4c5e-9f02-3a6d7e814bc0"

encounter_id

string

Verified encounter UUID, preserving its original letter case.

Example

"C72A6148-3D9E-4B05-AF61-8E297CD430B2"

mime_type

string

Progress note PDF media type.

Example

"application/pdf"

size

integer

PDF size in bytes.

Example

18432

content_base64

string

PDF bytes encoded as base64 text.

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ezderm/fetch-encounter-progress-note-pdf \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"patient_id":"3f2504e0-4f89-11d3-9a0c-0305e82c3301","encounter_id":"C72A6148-3D9E-4B05-AF61-8E297CD430B2"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
    "encounter_id": "C72A6148-3D9E-4B05-AF61-8E297CD430B2"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient_id": "b93d4826-78a1-4c5e-9f02-3a6d7e814bc0",
    "encounter_id": "C72A6148-3D9E-4B05-AF61-8E297CD430B2",
    "mime_type": "application/pdf",
    "size": 18432,
    "content_base64": "JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyA+PgplbmRvYmoKdHJhaWxlcgo8PCAvUm9vdCAxIDAgUiA+PgolJUVPRgo="
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}