Ezderm List patients

POSThttps://preview.ontross.com/api/integrations/ezderm/list-patients

input.facility_id

string

required

Clinic from list-facilities, which EZDerm also calls practiceId and clinicId.

Example

"a1d93f57-62b8-4e14-9c70-38fb5d2ea150"

input.mrns

array

required

Medical record numbers resolved into patient UUIDs, 3000 maximum per call.

Example

["MOAL3333107","RIVE3333692"]

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"

patients

array

EZDerm patient UUIDs paired with the record numbers that matched.

patients[].patient_id

string

Patient UUID, resolved from a medical record number by list-patients.

Example

"3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93"

patients[].medical_record_number

string

Human-facing chart number returned for the matched patient.

Example

"TEST7842196"

requested_mrn_count

integer

How many record numbers you sent, duplicates included.

Example

4

unique_mrn_count

integer

How many record numbers were left after removing duplicates.

Example

3

unresolved_mrns

array

Record numbers that searched fine but matched no single patient.

failed_mrns

array

Record numbers whose lookup errored, each with its error code.

failed_mrns[].medical_record_number

string

Requested chart number whose lookup encountered an error.

Example

"TEST7842196"

failed_mrns[].error

string

Failure code with any available lookup error details.

Example

"EZDERM_PATIENT_LOOKUP_FAILED"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/list-patients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"facility_id":"a1d93f57-62b8-4e14-9c70-38fb5d2ea150","mrns":["MOAL3333107","RIVE3333692"]},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "facility_id": "a1d93f57-62b8-4e14-9c70-38fb5d2ea150",
    "mrns": [
      "MOAL3333107",
      "RIVE3333692"
    ]
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patients": [
      {
        "patient_id": "3f7a2c18-9b04-4e51-ae6d-5c21f0a7bd93",
        "medical_record_number": "TEST7842196"
      }
    ],
    "requested_mrn_count": 4,
    "unique_mrn_count": 3,
    "unresolved_mrns": [
      "string"
    ],
    "failed_mrns": [
      {
        "medical_record_number": "TEST7842196",
        "error": "EZDERM_PATIENT_LOOKUP_FAILED"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}