EZDERM

Fetch patient

Fetch the complete patient chart response without dropping EZDerm fields.

POSThttps://api.ontross.com/api/integrations/ezderm/fetch-patient

Request Fields

input.patient_id

string

required

EZDerm patient UUID returned by list-patients.

Example

"00000000-0000-4000-8000-000000001001"

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

patientInfo

object

Patient demographics, contacts, addresses, and chart settings.

patientInfo.id

string

EZDerm patient UUID.

patientInfo.medicalRecordNumber

string

Human-facing medical record number.

patientInfo.externalMedicalRecordNumber

string

External medical record number, when present.

patientInfo.firstName

string

Patient first name.

patientInfo.middleName

string

Patient middle name.

patientInfo.lastName

string

Patient last name.

patientInfo.previousName

string

Previous patient name, when present.

patientInfo.dateOfBirth

string

Date of birth in EZDerm's original string format.

patientInfo.gender

string

EZDerm gender value, unchanged.

patientInfo.yearsOld

integer

Age calculated by EZDerm.

patientInfo.contactInfoList

array

Phone numbers and email addresses in EZDerm order.

patientInfo.contactInfoList[].id

string

EZDerm contact record identifier.

patientInfo.contactInfoList[].type

object

Contact channel metadata.

patientInfo.contactInfoList[].type.id

string

EZDerm contact type identifier.

patientInfo.contactInfoList[].type.type

string

Contact channel, such as CELL_PHONE, HOME_PHONE, or EMAIL_ADDRESS.

patientInfo.contactInfoList[].value

string

Phone number or email address exactly as EZDerm stores it.

patientInfo.contactInfoList[].active

boolean

Whether this contact entry is active.

patientInfo.contactInfoList[].validity

string

EZDerm contact validity status.

patientInfo.contactInfoList[].verification

string

EZDerm contact verification status.

patientInfo.contactInfoList[].patientSubscriptionStatus

string

Patient messaging subscription status, when present.

patientInfo.address1

object

Primary address, when present.

patientInfo.address1.id

string

EZDerm address record identifier.

patientInfo.address1.streetAddressLn1

string

First street address line.

patientInfo.address1.streetAddressLn2

string

Second street address line, when present.

patientInfo.address1.city

string

City.

patientInfo.address1.state

string

State or province.

patientInfo.address1.zip

string

Postal code.

patientInfo.address1.country

string

Country.

patientInfo.address1.poBox

boolean

Whether the address is a post office box.

patientInfo.address1.active

boolean

Whether the address is active.

patientInfo.address1.dateModified

string

EZDerm modification timestamp, unchanged.

patientInfo.addressInformationInfoList

array

All patient addresses in EZDerm order.

patientInfo.addressInformationInfoList[].id

string

EZDerm address record identifier.

patientInfo.addressInformationInfoList[].streetAddressLn1

string

First street address line.

patientInfo.addressInformationInfoList[].streetAddressLn2

string

Second street address line, when present.

patientInfo.addressInformationInfoList[].city

string

City.

patientInfo.addressInformationInfoList[].state

string

State or province.

patientInfo.addressInformationInfoList[].zip

string

Postal code.

patientInfo.addressInformationInfoList[].country

string

Country.

patientInfo.addressInformationInfoList[].poBox

boolean

Whether the address is a post office box.

patientInfo.addressInformationInfoList[].active

boolean

Whether the address is active.

patientInfo.addressInformationInfoList[].dateModified

string

EZDerm modification timestamp, unchanged.

patientInfo.preferredContact

string

EZDerm preferred contact channel, when present.

patientInfo.preferredLanguageIsoCode

string

Preferred language ISO code.

patientInfo.localeLanguage

string

Locale language.

patientInfo.localeCountry

string

Locale country.

patientInfo.races

array

EZDerm race values.

patientInfo.ethnicities

array

EZDerm ethnicity values.

patientInfo.active

boolean

Whether the patient record is active.

patientInfo.alertCount

integer

Number of patient alerts.

patientInfo.avatarContentLength

integer

Avatar file size in bytes, when present.

patientInfo.avatarMimeType

string

Avatar MIME type, when present.

patientInfo.avatarS3Id

string

EZDerm avatar storage identifier, when present.

patientInfo.bridgePatient

boolean

EZDerm bridge patient flag.

patientInfo.clinicalDecisionSupportRules

array

Clinical decision support rules assigned to the patient.

patientInfo.directServiceEnabled

boolean

Whether direct service is enabled.

patientInfo.documentAccessAllowed

boolean

Whether patient document access is allowed.

patientInfo.errorsFromSquare

boolean

EZDerm Square integration error flag.

patientInfo.fitzpatrickSkinType

integer

Recorded Fitzpatrick skin type code.

patientInfo.hasFhirPermission

boolean

FHIR access permission flag.

patientInfo.hasOnlineStatements

boolean

Whether online statements are available.

patientInfo.lastModifiedSince

string

EZDerm last modified marker, when present.

patientInfo.lastTimePatientPopulatedEzlink

string

Last EZLink population timestamp.

patientInfo.lastTimePatientPopulatedSadio

string

Last Sadio population timestamp.

patientInfo.lazyDmsFolders

boolean

EZDerm document folder loading flag.

patientInfo.marketingAnswer

object

Recorded marketing answer, when present.

patientInfo.medicationHistoryConsent

boolean

Medication history consent flag.

patientInfo.mfaEnabled

boolean

Multi-factor authentication flag.

patientInfo.nonUSA

boolean

Non-US patient flag.

patientInfo.onlineStatementsDefaultDeliveryMethod

string

Default delivery method for online statements.

patientInfo.patientBalanceTotal

integer

Patient balance total as returned by EZDerm.

patientInfo.patientOccupationInfoSet

array

Patient occupation records.

patientInfo.protectionIndicator

string

Patient protection indicator, when present.

patientInfo.publicityCode

string

Patient publicity code, when present.

patientInfo.responsibleForPatients

array

Patients for whom this person is responsible.

patientInfo.stickyNote

string

Patient chart sticky note.

patientInfo.responsiblePersons

array

Responsible persons and emergency contacts as returned by EZDerm.

patientInfo.roleIds

array

EZDerm role identifiers for this patient.

patientInfo.rootDmsFolderId

string

Patient document root folder identifier.

patientInfo.sadioActive

boolean

Sadio integration active flag.

patientInfo.sadioFirstTimeSetupComplete

boolean

Sadio first-time setup completion flag.

patientInfo.sendOnlineStatement

boolean

Whether to send online statements.

patientInfo.sendStatement

boolean

Whether to send statements.

patientInfo.showAlerts

boolean

Whether patient alerts are shown.

patientInfo.squareCustomerId

string

Square customer identifier.

patientInfo.subscriptionStatus

string

Patient subscription status.

patientInfo.updatedName

boolean

EZDerm name update flag.

patientInfo.userName

string

Patient username, when present.

patientInfo.practiceId

string

EZDerm practice identifier.

patientInfo.personId

string

EZDerm person identifier.

patientInfo.groupPatientId

string

EZDerm group patient identifier.

patientInfo.dateCreated

string

EZDerm creation timestamp, unchanged.

patientInfo.dateModified

string

EZDerm modification timestamp, unchanged.

alerts

array

Patient chart alerts.

careTeam

array

Patient care team records.

encounterStatistics

object

Encounter counts and upcoming encounters.

insuranceProfileDescription

array

Insurance descriptions shown on the patient chart.

patientAllergies

array

Patient allergy summaries.

pharmacyInfoList

array

EZDerm pharmacy records associated with the patient.

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ezderm/fetch-patient \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"patient_id":"00000000-0000-4000-8000-000000001001"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patient_id": "00000000-0000-4000-8000-000000001001"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patientInfo": {
      "id": "string",
      "medicalRecordNumber": "string",
      "externalMedicalRecordNumber": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "previousName": "string",
      "dateOfBirth": "2019-08-24",
      "gender": "string",
      "yearsOld": 0,
      "contactInfoList": [
        {
          "id": "string",
          "type": {
            "id": "string",
            "type": "string"
          },
          "value": "string",
          "active": true,
          "validity": "string",
          "verification": "string",
          "patientSubscriptionStatus": "string"
        }
      ],
      "address1": {
        "id": "string",
        "streetAddressLn1": "string",
        "streetAddressLn2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "poBox": true,
        "active": true,
        "dateModified": "2019-08-24"
      },
      "addressInformationInfoList": [
        {
          "id": "string",
          "streetAddressLn1": "string",
          "streetAddressLn2": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "country": "string",
          "poBox": true,
          "active": true,
          "dateModified": "2019-08-24"
        }
      ],
      "preferredContact": "string",
      "preferredLanguageIsoCode": "string",
      "localeLanguage": "string",
      "localeCountry": "string",
      "races": [
        "string"
      ],
      "ethnicities": [
        "string"
      ],
      "active": true,
      "alertCount": 0,
      "avatarContentLength": 0,
      "avatarMimeType": "string",
      "avatarS3Id": "string",
      "bridgePatient": true,
      "clinicalDecisionSupportRules": [
        null
      ],
      "directServiceEnabled": true,
      "documentAccessAllowed": true,
      "errorsFromSquare": true,
      "fitzpatrickSkinType": 0,
      "hasFhirPermission": true,
      "hasOnlineStatements": true,
      "lastModifiedSince": "string",
      "lastTimePatientPopulatedEzlink": "string",
      "lastTimePatientPopulatedSadio": "string",
      "lazyDmsFolders": true,
      "marketingAnswer": {},
      "medicationHistoryConsent": true,
      "mfaEnabled": true,
      "nonUSA": true,
      "onlineStatementsDefaultDeliveryMethod": "string",
      "patientBalanceTotal": 0,
      "patientOccupationInfoSet": [
        null
      ],
      "protectionIndicator": "string",
      "publicityCode": "string",
      "responsibleForPatients": [
        null
      ],
      "stickyNote": "string",
      "responsiblePersons": [
        {}
      ],
      "roleIds": [
        null
      ],
      "rootDmsFolderId": "string",
      "sadioActive": true,
      "sadioFirstTimeSetupComplete": true,
      "sendOnlineStatement": true,
      "sendStatement": true,
      "showAlerts": true,
      "squareCustomerId": "string",
      "subscriptionStatus": "string",
      "updatedName": true,
      "userName": "string",
      "practiceId": "string",
      "personId": "string",
      "groupPatientId": "string",
      "dateCreated": "2019-08-24",
      "dateModified": "2019-08-24"
    },
    "alerts": [
      {}
    ],
    "careTeam": [
      null
    ],
    "encounterStatistics": {},
    "insuranceProfileDescription": [
      "string"
    ],
    "patientAllergies": [
      "string"
    ],
    "pharmacyInfoList": [
      {}
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}