Tross
Demo dataBook a demo
EZDERM

Create encounter

Create a virtual encounter for a patient.

POSThttps://preview.ontross.com/api/integrations/ezderm/create-encounter
Request Fields
input.patient_id
string
required
Patient UUID, resolved from a medical record number by list-patients.
Example
"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"
input.facility_id
string
required
Clinic from list-facilities, which EZDerm also calls practiceId and clinicId.
Example
"a1d93f57-62b8-4e14-9c70-38fb5d2ea150"
input.provider_id
string
required
Provider from list-providers, active at that facility.
Example
"6f21a684-4d87-4b10-82ce-93f5d0a71b68"
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
encounter_id
string
Encounter the request acts on, returned by create-encounter.
Example
"d26f8a40-3b17-4c95-ae82-608c7f0db541"
patient_id
string
Patient UUID, resolved from a medical record number by list-patients.
Example
"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"
facility_id
string
Clinic from list-facilities, which EZDerm also calls practiceId and clinicId.
Example
"a1d93f57-62b8-4e14-9c70-38fb5d2ea150"
provider_id
string
Provider from list-providers, active at that facility.
Example
"6f21a684-4d87-4b10-82ce-93f5d0a71b68"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/create-encounter \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93","facility_id":"a1d93f57-62b8-4e14-9c70-38fb5d2ea150","provider_id":"6f21a684-4d87-4b10-82ce-93f5d0a71b68"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "facility_id": "a1d93f57-62b8-4e14-9c70-38fb5d2ea150",
    "provider_id": "6f21a684-4d87-4b10-82ce-93f5d0a71b68"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "encounter_id": "d26f8a40-3b17-4c95-ae82-608c7f0db541",
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "facility_id": "a1d93f57-62b8-4e14-9c70-38fb5d2ea150",
    "provider_id": "6f21a684-4d87-4b10-82ce-93f5d0a71b68"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}