Tross
Demo dataBook a demo
EZDERM

List assessment options

List assessment templates for an encounter.

POSThttps://preview.ontross.com/api/integrations/ezderm/list-assessment-options
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.encounter_id
string
required
Encounter the request acts on, returned by create-encounter.
Example
"d26f8a40-3b17-4c95-ae82-608c7f0db541"
input.provider_id
string
required
Provider from list-providers, active at that facility.
Example
"6f21a684-4d87-4b10-82ce-93f5d0a71b68"
input.query
string
Text matched against an option's name, procedure tag, and spoken phrase.
Example
"acne"
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
assessment_options
array
Procedure templates this provider used before, filtered by your query.
assessment_options[].id
string
Procedure template identifier retained with its original casing.
Example
"5e2a9c74-18b6-4f03-ad59-7c86b1e4f637"
assessment_options[].name
string
Preferred diagnosis term, falling back to the template's short tag.
Example
"Acne vulgaris"
assessment_options[].snomed_id
integer
SNOMED concept behind the diagnosis, null when EZDerm has none.
Example
399986005
assessment_options[].procedure_tag
string
EZDerm's short tag on the template, often empty.
Example
"Acne"
assessment_options[].description
string
Template's spoken phrase, or empty text when unavailable.
Example
"Acne vulgaris"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/list-assessment-options \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93","encounter_id":"d26f8a40-3b17-4c95-ae82-608c7f0db541","provider_id":"6f21a684-4d87-4b10-82ce-93f5d0a71b68","query":"acne"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
    "encounter_id": "d26f8a40-3b17-4c95-ae82-608c7f0db541",
    "provider_id": "6f21a684-4d87-4b10-82ce-93f5d0a71b68",
    "query": "acne"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "assessment_options": [
      {
        "id": "5e2a9c74-18b6-4f03-ad59-7c86b1e4f637",
        "name": "Acne vulgaris",
        "snomed_id": 399986005,
        "procedure_tag": "Acne",
        "description": "Acne vulgaris"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}