Air Doctor (v2.0)

Download OpenAPI specification:Download

Public API for Air Doctor backend

Account Management

Creates or updates the user and returns user's access token

header Parameters

X-Token

string

Example: 351c6476ca9d7d3efb72eb4595d7ce2f4f3d39de52c98ccdb2ef2a87e357aaea4777a3feafe1b32e6a1dbf20374337f7fefc

Access Token

Request Body schema: application/json
required

firstName	string User's first name
lastName	string User's last name
gender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" User's gender
birthday	string <date> User's date of birth
phone	string User's phone number
affiliateId	string If the user was recruited by an affiliate, the affiliate ID
latitude	number <double> Last searched latitude (can be used by Customer Support department)
longitude	number <double> Last searched longitude (can be used by Customer Support department)
location	string Last searched location name (can be used by Customer Support department)
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Last searched location's country (can be used by Customer Support department)
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" Last searched location's state
city	string Last searched location's city
deviceId	string Unique ID of the device (to be able to reuse device record on log-in - log-out - log-back-in)
pushToken	string Push notifications token of the device
deviceOS	string Current device's operating system (for statistical and support purposes)
deviceModel	string Current device's model (for statistical and support purposes)
appVersion	string For native applications, the app version (for statistical and support purposes)
language	string Enum: "ENGLISH" "ENGLISH_UK" "HEBREW" "SPANISH" "GERMAN" "CHINESE" "DUTCH" "FRENCH" "RUSSIAN" "JAPANESE" "ITALIAN" User app's language (used to appropriately translate system emails)
currency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" User app's currency (used to appropriately text engine)
sessionType	string Enum: "API" "IOS" "ANDROID" "MOBILE" "WEB" "EMBEDDED" Requested session type (implicitly controls session expiration)
linkState	string Deep link (if any) for continuation support
email	string User's email (effectively used to login and register)
auxEmail	string Auxiliary user's email (effectively used when logged in with OAuth)
password	string User's desired password (for register or password update)
oldPassword	string User's current (old) password (when the password is being updated, this value must be set)
passwordHint	string Enum: "SET" "CHANGED" "PASSWORD_RESET_REQUESTED" "FACEBOOK" "GOOGLE" "APPLE" "OAUTH2" True, if login information is provided by the Facebook Login SDK
resetPasswordCode	string If the change of the password was as a result of the Password Reset email, this is the reset code (effectively overrides the access token for this operation).
localTimestamp	string <date-time> User's timestamp, used to find out user's local true time zone
localTimeZone	string A string representing the current time zone. Returns the string representing the current time zone based on the user's device.
spokenLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Patient's spoken language, null by default
	object If the user was redirected from external application, identifier click ids
userSource	string Enum: "ORGANIC" "CARD" "ASSISTANCE" "LANDING" "MARKETING" "PARTNER" "ADVICE" "CS" "AFFILIATE" "AD_WEBSITE" "WEB_VIEW" "DIRECT_CLINIC" "WELCOME_EMAIL" User source
oneTimePassword	string One time password.
whatsAppPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether WhatsApp is selected as the preferred method for receiving notifications or not
smsPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether SMS is selected as the preferred method for receiving notifications or not
emailPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether email is selected as the preferred method for receiving notifications or not

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Smith",
"gender": "MALE",
"birthday": "1980-04-28",
"phone": "+972501234567",
"affiliateId": "string",
"latitude": 48.8566,
"longitude": 2.3522,
"location": "Paris",
"country": "FR",
"state": "AL",
"city": "London",
"deviceId": "0123456789abcdef0123456789abcdef",
"pushToken": "0123456789abcdef0123456789abcdef",
"deviceOS": "string",
"deviceModel": "string",
"appVersion": "string",
"language": "ENGLISH",
"currency": "USD",
"sessionType": "WEB",
"linkState": "string",
"email": "test@air-dr.com",
"auxEmail": "test@icloud.com",
"password": "Hello$",
"oldPassword": "Hello?",
"passwordHint": "SET",
"resetPasswordCode": "0123456789abcdef0123456789abcdef",
"localTimestamp": "2019-08-24T14:15:22Z",
"localTimeZone": "Europe/Paris",
"spokenLanguage": "AA",
"identifiers": {"property1": "string",
"property2": "string"
},
"userSource": "ORGANIC",
"oneTimePassword": 123456,
"whatsAppPreference": "TURNED_OFF",
"smsPreference": "TURNED_OFF",
"emailPreference": "TURNED_OFF"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Updates user details, returning minimum information (fast call)

header Parameters

X-Token

string

Example: 351c6476ca9d7d3efb72eb4595d7ce2f4f3d39de52c98ccdb2ef2a87e357aaea4777a3feafe1b32e6a1dbf20374337f7fefc

Access Token

Request Body schema: application/json
required

firstName	string User's first name
lastName	string User's last name
gender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" User's gender
birthday	string <date> User's date of birth
phone	string User's phone number
affiliateId	string If the user was recruited by an affiliate, the affiliate ID
latitude	number <double> Last searched latitude (can be used by Customer Support department)
longitude	number <double> Last searched longitude (can be used by Customer Support department)
location	string Last searched location name (can be used by Customer Support department)
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Last searched location's country (can be used by Customer Support department)
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" Last searched location's state
city	string Last searched location's city
deviceId	string Unique ID of the device (to be able to reuse device record on log-in - log-out - log-back-in)
pushToken	string Push notifications token of the device
deviceOS	string Current device's operating system (for statistical and support purposes)
deviceModel	string Current device's model (for statistical and support purposes)
appVersion	string For native applications, the app version (for statistical and support purposes)
language	string Enum: "ENGLISH" "ENGLISH_UK" "HEBREW" "SPANISH" "GERMAN" "CHINESE" "DUTCH" "FRENCH" "RUSSIAN" "JAPANESE" "ITALIAN" User app's language (used to appropriately translate system emails)
currency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" User app's currency (used to appropriately text engine)
sessionType	string Enum: "API" "IOS" "ANDROID" "MOBILE" "WEB" "EMBEDDED" Requested session type (implicitly controls session expiration)
linkState	string Deep link (if any) for continuation support
email	string User's email (effectively used to login and register)
auxEmail	string Auxiliary user's email (effectively used when logged in with OAuth)
password	string User's desired password (for register or password update)
oldPassword	string User's current (old) password (when the password is being updated, this value must be set)
passwordHint	string Enum: "SET" "CHANGED" "PASSWORD_RESET_REQUESTED" "FACEBOOK" "GOOGLE" "APPLE" "OAUTH2" True, if login information is provided by the Facebook Login SDK
resetPasswordCode	string If the change of the password was as a result of the Password Reset email, this is the reset code (effectively overrides the access token for this operation).
localTimestamp	string <date-time> User's timestamp, used to find out user's local true time zone
localTimeZone	string A string representing the current time zone. Returns the string representing the current time zone based on the user's device.
spokenLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Patient's spoken language, null by default
	object If the user was redirected from external application, identifier click ids
userSource	string Enum: "ORGANIC" "CARD" "ASSISTANCE" "LANDING" "MARKETING" "PARTNER" "ADVICE" "CS" "AFFILIATE" "AD_WEBSITE" "WEB_VIEW" "DIRECT_CLINIC" "WELCOME_EMAIL" User source
oneTimePassword	string One time password.
whatsAppPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether WhatsApp is selected as the preferred method for receiving notifications or not
smsPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether SMS is selected as the preferred method for receiving notifications or not
emailPreference	string Enum: "TURNED_OFF" "TURNED_ON" "DISABLED" Indicates whether email is selected as the preferred method for receiving notifications or not

Responses

Request samples

Payload

Content type

application/json

{"firstName": "John",
"lastName": "Smith",
"gender": "MALE",
"birthday": "1980-04-28",
"phone": "+972501234567",
"affiliateId": "string",
"latitude": 48.8566,
"longitude": 2.3522,
"location": "Paris",
"country": "FR",
"state": "AL",
"city": "London",
"deviceId": "0123456789abcdef0123456789abcdef",
"pushToken": "0123456789abcdef0123456789abcdef",
"deviceOS": "string",
"deviceModel": "string",
"appVersion": "string",
"language": "ENGLISH",
"currency": "USD",
"sessionType": "WEB",
"linkState": "string",
"email": "test@air-dr.com",
"auxEmail": "test@icloud.com",
"password": "Hello$",
"oldPassword": "Hello?",
"passwordHint": "SET",
"resetPasswordCode": "0123456789abcdef0123456789abcdef",
"localTimestamp": "2019-08-24T14:15:22Z",
"localTimeZone": "Europe/Paris",
"spokenLanguage": "AA",
"identifiers": {"property1": "string",
"property2": "string"
},
"userSource": "ORGANIC",
"oneTimePassword": 123456,
"whatsAppPreference": "TURNED_OFF",
"smsPreference": "TURNED_OFF",
"emailPreference": "TURNED_OFF"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Requests a reset password email (the email is sent automatically and immediately by the system)

query Parameters

email

required

string

Example: email=test@air-dr.com

Email Address

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Adds or updates a person under the policy or for the user outside of policy

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

personId	integer <int32> Unique user ID (should only be specified when existing the person is being edited)
policyId	integer <int32> Policy ID reference (should not be specified for a person passed within the policy's list)
firstName	string Person's first name
lastName	string Person's last name
firstNameLatin	string Person's first name in Latin letters
lastNameLatin	string Person's last name in Latin letters
gender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" Person's gender
birthday	string <date> Person's date of birth
personalIdNumber	string Person's government ID number (usually either an identity card number or a passport number)

Responses

Request samples

Payload

Content type

application/json

{"personId": 123,
"policyId": 456,
"firstName": "John",
"lastName": "Smith",
"firstNameLatin": "John",
"lastNameLatin": "Smith",
"gender": "MALE",
"birthday": "1980-04-20",
"personalIdNumber": 30123456789
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Invalidates the token (effectively - log out)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Deletes the specified user from Air-Doctor database

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

string

User's password (used to confirm the request)

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Checks whether a user with the specified email is already registered

query Parameters

email

required

string

Example: email=test@air-dr.com

Email Address

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Downloads all the data, stored by Air-Doctor about the user (as a single ZIP file)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

User's Insurance

Requests an addition of a policy to the user's account

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

COMPANY	string
SUBSCRIBER_ID	string
POLICY_NUMBER	string
FIRST_NAME	string
LAST_NAME	string
GENDER	string
PERSONAL_ID_NUMBER	string
DATE_OF_BIRTH	string
POLICY_START_DATE	string
POLICY_END_DATE	string
PHONE_NUMBER	string
EMAIL_ADDRESS	string
CARD_4_DIGITS	string
TRAVEL_START_DATE	string
TRAVEL_END_DATE	string
EXCESS	string
EXCESS_CURRENCY	string
PASSWORD_HINT	string
LATITUDE	string
LONGITUDE	string
PACKAGE	string
SPECIALITY	string
LANGUAGE	string

Responses

Request samples

Payload

Content type

application/json

{"COMPANY": "string",
"SUBSCRIBER_ID": "string",
"POLICY_NUMBER": "string",
"FIRST_NAME": "string",
"LAST_NAME": "string",
"GENDER": "string",
"PERSONAL_ID_NUMBER": "string",
"DATE_OF_BIRTH": "string",
"POLICY_START_DATE": "string",
"POLICY_END_DATE": "string",
"PHONE_NUMBER": "string",
"EMAIL_ADDRESS": "string",
"CARD_4_DIGITS": "string",
"TRAVEL_START_DATE": "string",
"TRAVEL_END_DATE": "string",
"EXCESS": "string",
"EXCESS_CURRENCY": "string",
"PASSWORD_HINT": "string",
"LATITUDE": "string",
"LONGITUDE": "string",
"PACKAGE": "string",
"SPECIALITY": "string",
"LANGUAGE": "string"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Requests policy removal from the user's account

path Parameters

id

required

integer <int32>

Example: 123

Policy ID

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Requests an addition of a policy to the user's account (fast call, not returning updated user)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

COMPANY	string
SUBSCRIBER_ID	string
POLICY_NUMBER	string
FIRST_NAME	string
LAST_NAME	string
GENDER	string
PERSONAL_ID_NUMBER	string
DATE_OF_BIRTH	string
POLICY_START_DATE	string
POLICY_END_DATE	string
PHONE_NUMBER	string
EMAIL_ADDRESS	string
CARD_4_DIGITS	string
TRAVEL_START_DATE	string
TRAVEL_END_DATE	string
EXCESS	string
EXCESS_CURRENCY	string
PASSWORD_HINT	string
LATITUDE	string
LONGITUDE	string
PACKAGE	string
SPECIALITY	string
LANGUAGE	string

Responses

Request samples

Payload

Content type

application/json

{"COMPANY": "string",
"SUBSCRIBER_ID": "string",
"POLICY_NUMBER": "string",
"FIRST_NAME": "string",
"LAST_NAME": "string",
"GENDER": "string",
"PERSONAL_ID_NUMBER": "string",
"DATE_OF_BIRTH": "string",
"POLICY_START_DATE": "string",
"POLICY_END_DATE": "string",
"PHONE_NUMBER": "string",
"EMAIL_ADDRESS": "string",
"CARD_4_DIGITS": "string",
"TRAVEL_START_DATE": "string",
"TRAVEL_END_DATE": "string",
"EXCESS": "string",
"EXCESS_CURRENCY": "string",
"PASSWORD_HINT": "string",
"LATITUDE": "string",
"LONGITUDE": "string",
"PACKAGE": "string",
"SPECIALITY": "string",
"LANGUAGE": "string"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Request contact (callback) from insurance company (for supporting companies)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

personId	integer <int32> Person ID; should be linked to an insurance policy
language	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" User's preferred communications language (out of the languages accepted by the insurance carrier)
location	string General user's location
phone	string Phone number where the user can be reached
notes	string Any patient-specific comments or requests

Responses

Request samples

Payload

Content type

application/json

{"personId": 123,
"language": "EN",
"location": "London, UK",
"phone": "+442067894321",
"notes": "I need to urgently talk to a representative"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Promo code Management

Checks if a provided promo code is valid for a specific location and patient

query Parameters

promoCodeKey required	string The unique identifier of the promo code to be verified
patientId required	integer <int32> The ID of the patient who wants to use the promo code

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

Array

string

Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT"

Responses

Request samples

Payload

Content type

application/json

["HOME_VISIT"
]

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Policies Management

Wildcard query of insurance policies (insurance carrier use only; returns up to 1000 records)

query Parameters

search required	string Example: search=%123456789% Query (% and _ wildcards are accepted; policy numbers exclude leading zeros and any non-alphanumeric characters)
fromDate	string <date-time> Example: fromDate=2022-03-07T00:00 Filter by: from creation date. Requires both dates(from/to), if uses.
toDate	string <date-time> Example: toDate=2022-04-07T00:00 Filter by: to creation date. Requires both dates(from/to), if uses.
scopeType	string Default: "ALL" Enum: "ALL" "ASSISTANCE" "API" Example: scopeType=ALL Filter by: the scope type for policies. Not required. Defaults to 'ALL' if not provided.

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Upload or update policies (insurance carrier use only)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

Array

policyId	integer <int32> Unique insurance policy ID
corporateName	string For corporate policies, the name of the company
companyId required	integer <int32> Insurance company ID (will be supplied by Air Doctor; security will forbid calls with the wrong value)
policyNumber required	string The insurance policy number (this is the unique identifier of the insurance policy for this call)
creationDate	string <date-time> Timestamp when policy was created
phone	string Phone number associated with the policy
startDate	string <date> Policy validity start date
endDate	string <date> Policy validity end date
status	string Enum: "ACTIVE" "CANCELLED" Status of the policy (policy deletion is not supported; pass CANCELLED to cancel the policy)
excessCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" The currency of the excess (deductible) amount
excessPercentage	number <double> Excess (deductible) to be charged for a visit (basic fee percentage; to remove excess, set to a negative value)
excessFee	number <double> Excess (deductible) to be charged for a visit (fixed part; to remove excess, set to a negative value)
accumulatedExcess	boolean Accumulated excess behaviour. “Atomic/copay” (if set to false) or all accumulated (if set to true)
canRenewPolicy	boolean The insurance policy allows the user to request policy renewal (via insurer's website)
canBookPrivately	boolean The insurance policy allows the user to book an appointment privately (ignoring the policy)
canAddPatients	boolean The insurance policy allows the user to add patients to the policy (usually when the list of policyholders cannot be supplied upfront)
canUseClinicVisits	boolean The patient can use clinic visits
canUseHomeVisits	boolean The patient can use home visits
canUseVideoVisits	boolean The patient can use video visits
canBeDisabled	boolean The user is allowed to remove the policy from his account
skipPolicyPull	boolean Policy skips external insurer's validation
needsCreditCard	boolean The policy requires credit card entry to book an appointment
requireTravelDates	boolean The policy can have the travel dates
useStatus	string Enum: "ACTIVE" "CANCELLED" Association status for the current user (ignored for policy management; only used for token status)
usersLimit	integer <int32> Default: "999" The number of users who can associate this policy to their account (0 value is ignored - 999 assumed; pass a negative value to set the field to zero)
	Array of objects (Travel dates of insurance policy record) Travel dates for insurance policy
packageType	integer <int32> The package type of policy
associationDate	string <date-time> Timestamp when policy was associated to the user (GET only)
touchedByAssistance	boolean TRUE if a policy was created or updated through the 'Assistance API'
homeCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Home country for policy
notificationOnCreation	string Enum: "SEND" "OMIT" "DEFAULT" The user can receive a notification about the creation of a policy
notificationOnUpdate	string Enum: "SEND" "OMIT" "DEFAULT" The user can receive a notification about the update of a policy
notificationOnCancelation	string Enum: "SEND" "OMIT" "DEFAULT" The user can receive a notification about the cancel of a policy
notificationTimeBeforePolicyStart	integer <int32> Shows the time in seconds for which the user will receive a notification before creating the policy. 0 means default; -1 means do not send; any other negative means revert to default.
distributorName	string Name of policy distributor company
	Array of objects (Person record (either an insured individual or one for whom an appointment was created)) The list of people included in this policy
corporateAgent	string For corporate policies, insurance agent responsible
corporateEmails	string For corporate policies, corporate email address
policyIdentifier	string Insurance policy custom identifier
email	string Policyholder's registration email address
preferredLink	string Preferred link to send to the user (GET only)
ownerUserName	string Username that has created the policy (GET only)
language	string Enum: "ENGLISH" "ENGLISH_UK" "HEBREW" "SPANISH" "GERMAN" "CHINESE" "DUTCH" "FRENCH" "RUSSIAN" "JAPANESE" "ITALIAN" Language of mail

Responses

Request samples

Payload

Content type

application/json

[{"policyId": 123,
"corporateName": "Over the Rainbow inc",
"companyId": 1,
"policyNumber": 468239748923321,
"creationDate": "2019-12-09T08:40:53",
"phone": "+15467383892",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"status": "ACTIVE",
"excessCurrency": "USD",
"excessPercentage": 0.2,
"excessFee": 50,
"accumulatedExcess": true,
"canRenewPolicy": true,
"canBookPrivately": true,
"canAddPatients": true,
"canUseClinicVisits": true,
"canUseHomeVisits": true,
"canUseVideoVisits": true,
"canBeDisabled": true,
"skipPolicyPull": true,
"needsCreditCard": true,
"requireTravelDates": true,
"useStatus": "ACTIVE",
"usersLimit": 1,
"travelDates": [{"id": 1,
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"subscriberId": 123
}
],
"packageType": 0,
"associationDate": "2019-12-09T08:40:53",
"touchedByAssistance": true,
"homeCountry": "BV",
"notificationOnCreation": "OMIT",
"notificationOnUpdate": "SEND",
"notificationOnCancelation": "DEFAULT",
"notificationTimeBeforePolicyStart": 86400,
"distributorName": "Delta",
"people": [{"personId": 123,
"policyId": 456,
"firstName": "John",
"lastName": "Smith",
"firstNameLatin": "John",
"lastNameLatin": "Smith",
"gender": "MALE",
"birthday": "1980-04-20",
"personalIdNumber": 30123456789,
"status": "ACTIVE",
"liabilityLimit": 200000,
"excessPercentage": 0.2,
"excessFee": 50,
"packageType": 0
}
],
"corporateAgent": "Shuki & Sons inc",
"corporateEmails": "someone@somewhere.com",
"policyIdentifier": 821346,
"email": "someone@example.com",
"preferredLink": "https://www.air-dr.com/some-policy-identifier",
"ownerUserName": "email@domain.com",
"language": "Germany"
}
]

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Upload or update policy travel-dates (insurance carrier use only)

path Parameters

policyId

required

integer <int32>

query Parameters

subscriber

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

Array

id	integer <int32> Unique ID
startDate	string <date> Travel start date
endDate	string <date> Travel end date
subscriberId	integer <int32> Subscriber ID

Responses

Request samples

Payload

Content type

application/json

[{"id": 1,
"startDate": "2022-01-01",
"endDate": "2022-12-31",
"subscriberId": 123
}
]

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Get policy overrides

path Parameters

policyId

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Create policy override

path Parameters

policyId

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

patientId	integer <int32> Air Doctor's internal patient id to apply the override. Pass blank if override is applied to the whole policy (to each active patient in the policy)
followUp	boolean If true - overridden policy rules will apply to follow-up visits only
startTimestamp	string <date-time> Default: "current time" Override window start time
endTimestamp	string <date-time> Default: "start time + 24 hours" Override window end time
reason	string Override reason
status required	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Current overridden policy rules status
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Allowed country. Pass blank if all company allowed countries
specialty	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Allowed specialty. Pass blank if all company allowed specialties
priceLimit	number <double> Price limit. Pass 0 or skip this field if up to company price limit
priceLimitCurrency	string Default: "company default currency" Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Price limit currency
allowUseVideoVisit	boolean Video visits allowed
allowUseClinicVisit	boolean Clinic visits allowed
allowUseHomeVisit	boolean Home visits allowed
visitsNumber	integer <int32> Default: "1" Max number of allowed visits inside current override
excessFee	number <double> Default: "0" Excess (deductible) to be charged for a visit
excessCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Excess (deductible) currency to be charged for a visit
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) List of attachments
followUpOverride	string Enum: "FORBID" "ALLOW" "DEFAULT" Does follow up availability manually override

Responses

Request samples

Payload

Content type

application/json

{"patientId": 9876,
"followUp": true,
"startTimestamp": "2020-07-29T08:30",
"endTimestamp": "2020-07-29T16:30",
"reason": "Customer requested extra visit",
"status": "COVERED",
"country": "DE",
"specialty": "GENERAL",
"priceLimit": 25.5,
"priceLimitCurrency": "USD",
"allowUseVideoVisit": true,
"allowUseClinicVisit": true,
"allowUseHomeVisit": false,
"visitsNumber": 1,
"excessFee": 50,
"excessCurrency": "USD",
"attachments": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"followUpOverride": "DEFAULT"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns patient's or policy's status for next appointment

path Parameters

policyId

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

visitFee	number <double> Appointment visit fee
visitFeeCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Appointment visit currency
patientId	integer <int32> Patient's identifier
visitDate	string <date-time> Appointment scheduled date and time. Initiators local time
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country where appointment will happen
specialty	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Doctors specialty
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Visit type
hasFollowUp	boolean Is next visit follow up
appointmentId	integer <int32> Appointment id to skip in appropriate status

Responses

Request samples

Payload

Content type

application/json

{"visitFee": 23.45,
"visitFeeCurrency": "USD",
"patientId": 12233,
"visitDate": "2019-08-24T14:15:22Z",
"country": "AD",
"specialty": "GENERAL",
"locationType": "CLINIC",
"hasFollowUp": true,
"appointmentId": 0
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns patient's or policy's status for next appointment

path Parameters

policyId

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

visitFee	number <double> Appointment visit fee
visitFeeCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Appointment visit currency
patientId	integer <int32> Patient's identifier
visitDate	string <date-time> Appointment scheduled date and time. Initiators local time
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country where appointment will happen
specialty	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Doctors specialty
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Visit type
hasFollowUp	boolean Is next visit follow up
appointmentId	integer <int32> Appointment id to skip in appropriate status

Responses

Request samples

Payload

Content type

application/json

{"visitFee": 23.45,
"visitFeeCurrency": "USD",
"patientId": 12233,
"visitDate": "2019-08-24T14:15:22Z",
"country": "AD",
"specialty": "GENERAL",
"locationType": "CLINIC",
"hasFollowUp": true,
"appointmentId": 0
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Policy request webhook — this is a sample function definition intended to describe the webhook call format (in AirDoctor server this is a NOP call)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

COMPANY	string
SUBSCRIBER_ID	string
POLICY_NUMBER	string
FIRST_NAME	string
LAST_NAME	string
GENDER	string
PERSONAL_ID_NUMBER	string
DATE_OF_BIRTH	string
POLICY_START_DATE	string
POLICY_END_DATE	string
PHONE_NUMBER	string
EMAIL_ADDRESS	string
CARD_4_DIGITS	string
TRAVEL_START_DATE	string
TRAVEL_END_DATE	string
EXCESS	string
EXCESS_CURRENCY	string
PASSWORD_HINT	string
LATITUDE	string
LONGITUDE	string
PACKAGE	string
SPECIALITY	string
LANGUAGE	string

Responses

Request samples

Payload

Content type

application/json

{"COMPANY": "string",
"SUBSCRIBER_ID": "string",
"POLICY_NUMBER": "string",
"FIRST_NAME": "string",
"LAST_NAME": "string",
"GENDER": "string",
"PERSONAL_ID_NUMBER": "string",
"DATE_OF_BIRTH": "string",
"POLICY_START_DATE": "string",
"POLICY_END_DATE": "string",
"PHONE_NUMBER": "string",
"EMAIL_ADDRESS": "string",
"CARD_4_DIGITS": "string",
"TRAVEL_START_DATE": "string",
"TRAVEL_END_DATE": "string",
"EXCESS": "string",
"EXCESS_CURRENCY": "string",
"PASSWORD_HINT": "string",
"LATITUDE": "string",
"LONGITUDE": "string",
"PACKAGE": "string",
"SPECIALITY": "string",
"LANGUAGE": "string"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Downloads policies as user-readable Excel file (insurance carrier use only; returns up to 1000 records)

query Parameters

search required	string Example: search=%123456789% Query (% and _ wildcards are accepted; policy numbers exclude leading zeros and any non-alphanumeric characters)
fromDate	string <date-time> Example: fromDate=2022-03-07T00:00 Filter by: from creation date. Requires both dates(from/to), if uses.
toDate	string <date-time> Example: toDate=2022-04-07T00:00 Filter by: to creation date. Requires both dates(from/to), if uses.
scopeType	string Default: "ALL" Enum: "ALL" "ASSISTANCE" "API" Example: scopeType=ALL Filter by: the scope type for policies. Not required. Defaults to 'ALL' if not provided.

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Appointments Management

Returns the list of appointments for the user

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Creates or updates an appointments

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

Array

appointmentId	integer <int32> Unique appointment ID (leave blank when creating an appointment)
appointmentRevisionId	integer <int32> Unique appointment revision ID (optional, but recommended: can be specified to make sure the underlying appointment was not changed since it was retreived; leave blank when creating an appointment)
patientId	integer <int32> Patient ID (from the list returned for the user)
profileId	integer <int32> Profile ID (identifies the provider with whom the appointment is being made)
locationId	integer <int32> Location ID (location must agree with the specified profile)
speciality	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Profile specialty (optional, but becomes mandatory on creation if the profile has multiple allowed specialties; the specialty of the appointment cannot be changed)
caseId	integer <int32> Case ID (case associated with this appointment; created automatically or manually before creating the appointment)
promoCodeId	integer <int32> Optional; Promo code ID to be applied to the appointment
status	string Enum: "PROPOSED" "REQUESTED" "DOCTOR_REFUSED_REQUEST" "REQUEST_EXPIRED" "PATIENT_CANCELLED_REQUEST" "ALTERNATIVE_OFFERED" "PATIENT_REFUSED_OFFER" "OFFER_EXPIRED" "DOCTOR_CANCELLED_OFFER" "APPOINTMENT_SCHEDULED" "AUTOMATICALLY_CANCELLED" "DOCTOR_CANCELLED_APPOINTMENT" "PATIENT_CANCELLED_APPOINTMENT" "VISIT_TOOK_PLACE" "APPOINTMENT_CLOSED" "PAYMENT_FAILED" "NO_SHOW" "CS_CANCELLED_REQUEST" "CS_CANCELLED_OFFER" "CS_CANCELLED_APPOINTMENT" "CS_OFFER" "LATE_CANCELLATION" "HOLD_FEE" "HOLD_FAILED" "INSURER_CANCELLED_APPOINTMENT" "CANCELLED_DUE_TO_HOLD_FAILURE" "ADDITIONAL_ALTERNATIVE_OFFERED" "CLAIM_OPEN" "CLAIM_CLARIFICATION" "CLAIM_READY_FOR_PAYMENT" "CLAIM_INTERNALLY_PAID" "CLAIM_SEND_TO_INSURER" "CLAIM_SUBMITTED_TO_INSURER" "CLAIM_CANCELED" Appointment status
minutesToExpiration	integer <int32> Minutes left until the current appointment status expires (cannot be changed, except by customer support team)
scheduledTimestamp	string <date-time> Scheduled time of the appointment in appointment time zone (profile's time zone for clinic and home visits; patient's time zone for patient-side video visits)
careOf	string A person responsible for the patient (useful for minors)
passportNumber	string Passport number of patient
passportCountryEnum	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Passport country of patient
passportIssueDate	string <date> Passport issue date of patient
homeAddressInHomeCountry	string Patient home address in home country
email	string Patient's email address
phone	string Patient's contact phone number
notes	string Problem description to be provided by the patient
city	string For home visits, city of the visit
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" For home visits, the state of the country of the visit
postalCode	string For home visits, postal code of the address for the visit
street	string For home visits, street of the address for the visit
streetNumber	string For home visits, street number of the address for the visit
buildingName	string For home visits, building name of the address for the visit
floor	string For home visits, floor within the residence at the visit's location
apartment	string For home visits, apartment or room number at the visit's location
notesHomeAddress	string Patient address of accommodation or For home visits, additional instruction how to enter patient location
latitude	number <double> For home visits, latitude of visit's location
longitude	number <double> For home visits, longitude of visit's location
paymentStatus	string Enum: "WRITE_OFF" "CASH_DIRECT" "PAID_PRIVATELY" "PREPAYMENT" "EXCESS" "COVERED" Designated appointment payment status
chunkStatus	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Designated appointment chunk status
followUpType	string Enum: "REGULAR" "PAID_FOLLOW_UP" "FREE_FOLLOW_UP" Indicates whether the appointment is a follow-up
appointmentFeeNet	number <double> Appointment net fee (privileged)
appointmentExtraFlatCommission	number <double> Appointment extra flat commission (privileged)
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) Photos attached to this appointment
	Array of objects (Single appointment extra charge) Extra payments for this appointment. Privileged; might not be provided
	object (EventDto) Event associated with this appointment; on GET only the following fields are filled: time stamp, type, public note and initiator ID (0 for profile, -1 for customer support department, -2 system automation, patient's Subscriber ID otherwise)
demandNumber	string Appointment insurance demand number (if needed)
voucherNumber	string Insurance visit voucher number (if needed)
voucherStatus	string Enum: "MISSING" "VALID" "EXPIRED" "CANCELLED" "DECLINED" Status of the voucher (if needed)
voucherExpirationDate	string <date> The day on which the voucher expires(the voucher becomes expired the next day)
requestedTime	string Appointment time preference (only for manually allocated appointments)
	object (ClaimDetailsDto) Insurance claim extra details (only present and can be specified for claims, not system-managed appointments)
profileNotes	string Clinic notes about appointment
hmoEnum	string Enum: "CLALIT" "MACCABI" "MEHUHEDET" "LEUMIT" "OTHER" Health Maintenance Organization
appointmentOrigin	string Enum: "REGULAR" "FIRST_SERVE" "CLINIC_DIRECT" "VIDEO_GROUP" "VIDEO_GROUP_ONE_CLICK" "BOTH_OFFLINE_GROUP" "HOME_OFFLINE_GROUP" "CLINIC_OFFLINE_GROUP" "BOTH_OFFLINE_GROUP_BY_SYSTEM" "HOME_OFFLINE_GROUP_BY_SYSTEM" "CLINIC_OFFLINE_GROUP_BY_SYSTEM" Appointment origin
dispatchTo	string Doctor who get appointment from dispatcher
medicationsInUseStatus	string Enum: "STATUS_UNKNOWN" "MEDICATIONS_TAKEN" "NO_MEDICATIONS_TAKEN" Whether the patient provided a description of the medications in use
medicationsInUse	string Medications taken on regular basis
interpreterLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Language of requested interpreter
languages	Array of strings Items Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" List of preferred appointment languages
requestPreference	string Enum: "PRESCRIPTION" "LANGUAGE" "INTERPRETER_REQUESTED" "WITHOUT_INTERPRETER" Indicates that the user prefers a doctor capable of providing prescription, rather than speaking the language
patientCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Preference country (used to determine whether prescription is possible)
suggestedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country in which the patient suggest the appointment
preferredData	string <date> Data which was selected in filter by patient
preferredGender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" Genders which were selected in filter by patient
creationDelaySeconds	integer <int32> Delay to create suggestion (seconds)
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Requested appointment type

Responses

Request samples

Payload

Content type

application/json

[{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"languages": ["AA"
],
"requestPreference": "PRESCRIPTION",
"patientCountry": "AD",
"suggestedCountry": "AD",
"preferredData": "2019-08-24",
"preferredGender": "MALE",
"creationDelaySeconds": 0,
"locationType": "HOME_VISIT"
}
]

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns a token for the video appointment

path Parameters

id

required

integer <int32>

Appointment ID

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns a token for the video appointment

path Parameters

id

required

integer <int32>

Appointment ID

query Parameters

dispatch

required

string

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

DEV server

https://dev.air-dr.com/api/v2/appointments/{id}/video-token/dispatch

TEST server

https://test.air-dr.com/api/v2/appointments/{id}/video-token/dispatch

PROD server

https://prod.air-dr.com/api/v2/appointments/{id}/video-token/dispatch

DEMO server

https://demo.air-dr.com/api/v2/appointments/{id}/video-token/dispatch

LOCAL server

http://127.0.0.1:5000/api/v2/appointments/{id}/video-token/dispatch

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Appointment webhook — this is a sample function definition intended to describe the webhook call format (in AirDoctor server this is a NOP call)

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

appointmentId	integer <int32> Unique appointment ID (leave blank when creating an appointment)
appointmentRevisionId	integer <int32> Unique appointment revision ID (optional, but recommended: can be specified to make sure the underlying appointment was not changed since it was retreived; leave blank when creating an appointment)
patientId	integer <int32> Patient ID (from the list returned for the user)
profileId	integer <int32> Profile ID (identifies the provider with whom the appointment is being made)
locationId	integer <int32> Location ID (location must agree with the specified profile)
speciality	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Profile specialty (optional, but becomes mandatory on creation if the profile has multiple allowed specialties; the specialty of the appointment cannot be changed)
caseId	integer <int32> Case ID (case associated with this appointment; created automatically or manually before creating the appointment)
promoCodeId	integer <int32> Optional; Promo code ID to be applied to the appointment
status	string Enum: "PROPOSED" "REQUESTED" "DOCTOR_REFUSED_REQUEST" "REQUEST_EXPIRED" "PATIENT_CANCELLED_REQUEST" "ALTERNATIVE_OFFERED" "PATIENT_REFUSED_OFFER" "OFFER_EXPIRED" "DOCTOR_CANCELLED_OFFER" "APPOINTMENT_SCHEDULED" "AUTOMATICALLY_CANCELLED" "DOCTOR_CANCELLED_APPOINTMENT" "PATIENT_CANCELLED_APPOINTMENT" "VISIT_TOOK_PLACE" "APPOINTMENT_CLOSED" "PAYMENT_FAILED" "NO_SHOW" "CS_CANCELLED_REQUEST" "CS_CANCELLED_OFFER" "CS_CANCELLED_APPOINTMENT" "CS_OFFER" "LATE_CANCELLATION" "HOLD_FEE" "HOLD_FAILED" "INSURER_CANCELLED_APPOINTMENT" "CANCELLED_DUE_TO_HOLD_FAILURE" "ADDITIONAL_ALTERNATIVE_OFFERED" "CLAIM_OPEN" "CLAIM_CLARIFICATION" "CLAIM_READY_FOR_PAYMENT" "CLAIM_INTERNALLY_PAID" "CLAIM_SEND_TO_INSURER" "CLAIM_SUBMITTED_TO_INSURER" "CLAIM_CANCELED" Appointment status
minutesToExpiration	integer <int32> Minutes left until the current appointment status expires (cannot be changed, except by customer support team)
scheduledTimestamp	string <date-time> Scheduled time of the appointment in appointment time zone (profile's time zone for clinic and home visits; patient's time zone for patient-side video visits)
careOf	string A person responsible for the patient (useful for minors)
passportNumber	string Passport number of patient
passportCountryEnum	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Passport country of patient
passportIssueDate	string <date> Passport issue date of patient
homeAddressInHomeCountry	string Patient home address in home country
email	string Patient's email address
phone	string Patient's contact phone number
notes	string Problem description to be provided by the patient
city	string For home visits, city of the visit
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" For home visits, the state of the country of the visit
postalCode	string For home visits, postal code of the address for the visit
street	string For home visits, street of the address for the visit
streetNumber	string For home visits, street number of the address for the visit
buildingName	string For home visits, building name of the address for the visit
floor	string For home visits, floor within the residence at the visit's location
apartment	string For home visits, apartment or room number at the visit's location
notesHomeAddress	string Patient address of accommodation or For home visits, additional instruction how to enter patient location
latitude	number <double> For home visits, latitude of visit's location
longitude	number <double> For home visits, longitude of visit's location
paymentStatus	string Enum: "WRITE_OFF" "CASH_DIRECT" "PAID_PRIVATELY" "PREPAYMENT" "EXCESS" "COVERED" Designated appointment payment status
chunkStatus	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Designated appointment chunk status
followUpType	string Enum: "REGULAR" "PAID_FOLLOW_UP" "FREE_FOLLOW_UP" Indicates whether the appointment is a follow-up
appointmentFeeNet	number <double> Appointment net fee (privileged)
appointmentExtraFlatCommission	number <double> Appointment extra flat commission (privileged)
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) Photos attached to this appointment
	Array of objects (Single appointment extra charge) Extra payments for this appointment. Privileged; might not be provided
	object (EventDto) Event associated with this appointment; on GET only the following fields are filled: time stamp, type, public note and initiator ID (0 for profile, -1 for customer support department, -2 system automation, patient's Subscriber ID otherwise)
demandNumber	string Appointment insurance demand number (if needed)
voucherNumber	string Insurance visit voucher number (if needed)
voucherStatus	string Enum: "MISSING" "VALID" "EXPIRED" "CANCELLED" "DECLINED" Status of the voucher (if needed)
voucherExpirationDate	string <date> The day on which the voucher expires(the voucher becomes expired the next day)
requestedTime	string Appointment time preference (only for manually allocated appointments)
	object (ClaimDetailsDto) Insurance claim extra details (only present and can be specified for claims, not system-managed appointments)
profileNotes	string Clinic notes about appointment
hmoEnum	string Enum: "CLALIT" "MACCABI" "MEHUHEDET" "LEUMIT" "OTHER" Health Maintenance Organization
appointmentOrigin	string Enum: "REGULAR" "FIRST_SERVE" "CLINIC_DIRECT" "VIDEO_GROUP" "VIDEO_GROUP_ONE_CLICK" "BOTH_OFFLINE_GROUP" "HOME_OFFLINE_GROUP" "CLINIC_OFFLINE_GROUP" "BOTH_OFFLINE_GROUP_BY_SYSTEM" "HOME_OFFLINE_GROUP_BY_SYSTEM" "CLINIC_OFFLINE_GROUP_BY_SYSTEM" Appointment origin
dispatchTo	string Doctor who get appointment from dispatcher
medicationsInUseStatus	string Enum: "STATUS_UNKNOWN" "MEDICATIONS_TAKEN" "NO_MEDICATIONS_TAKEN" Whether the patient provided a description of the medications in use
medicationsInUse	string Medications taken on regular basis
interpreterLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Language of requested interpreter
	Array of objects (Appointment details record) List of previous appointment revisions (earlier revision will be the last in the list; latest revision will be the first; nested records will not have this property set). Privileged; might not be provided
	object (PatientDto) Explicit patient details
groupId	integer <int32> Group ID (the same value will be provided for all appointments in a group created by a suggestion all; zero for appointments not belonging to a group)
scheduledLocalTimestamp	string <date-time> Scheduled date and time of the appointment, according to the current user's local time
scheduledProfileTimestamp	string <date-time> Scheduled date and time of the appointment, always according to the profile's local time
scheduledPatientTimestamp	string <date-time> Scheduled date and time of the appointment, always according to the patient's local time
appointmentFee	number <double> Appointment basic fee (can only be changed by a profile and only in some circumstances) (privileged)
excessAmount	number <double> Excess (deductible) amount of the appointment
excessCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Excess currency
appointmentCurrency	string Enum: "AED" "ALL" "AMD" "ANG" "ARS" "AUD" "AWG" "BAM" "BBD" "BGN" "BHD" "BMD" "BND" "BOB" "BRL" "BSD" "BWP" "BYR" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "DOP" "DZD" "EGP" "EUR" "FJD" "GBP" "GEL" "GIP" "GTQ" "HKD" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JMD" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KYD" "KZT" "LBP" "LKR" "MAD" "MDL" "MKD" "MRO" "MUR" "MWK" "MXN" "MYR" "NAD" "NGN" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SCR" "SDG" "SEK" "SGD" "THB" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "USD" "UYU" "UZS" "VEF" "VND" "XCD" "XOF" "ZAR" "AFN" "AOA" "AZN" "BDT" "BIF" "BZD" "CDF" "CVE" "DJF" "ETB" "FKP" "GMD" "GNF" "GYD" "HNL" "HTG" "KGS" "KMF" "LAK" "LRD" "LSL" "MGA" "MMK" "MNT" "MOP" "MVR" "MZN" "NIO" "PYG" "RWF" "SBD" "SHP" "SLL" "SOS" "SRD" "STD" "SZL" "TJS" "TOP" "UGX" "VUV" "WST" "XAF" "XPF" "YER" "ZMW" Appointment currency (based on the profile's currency)
	object (PromoCodeDto) Explicit promo code details
appointmentType	string Enum: "VIDEO_VISIT" "REGULAR_CLINIC" "URGENT_CLINIC" "REGULAR_HOME" "URGENT_HOME" Appointment type (urgent equates to off hours)
reviewRating	integer <int32> If the patient rated the visit, the rating given (-1 through 10)
doctorReviewRating	integer <int32> If the patient rated the visit, the rating given (-1 through 10)
reviewText	string If the patient rated the visit, the review text provided
applicationReviewRating	integer <int32> If the patient rated the application after visit, the given (-1 thought 10)
	Array of objects (Represents an invoice linked to the appointment) List of the appointment related invoices. Privileged; may not all come in
appointmentCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Appointment country when appointment was created
appointmentSearchedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Manually typed country while making the appointment
appointmentState	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" Appointment state when appointment was created
appointmentSearchedState	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" Manually typed state while making the appointment
canPrescribe	boolean Is profile can make a prescription
	object (AppointmentProfileDto) Profile's and location's details
	object (ProfileDto) The profile with which the appointment is scheduled
reason	string Enum: "STATUS_CHANGE" "VIDEO_REMINDER" "CANCELLATION_REMINDER" "CONFIRMATION_REMINDER" "REVIEW_REMINDER" "APPOINTMENT_INVOICE" "UPDATE_APPOINTMENT" "UPDATE_PAYMENT_METHOD" "APPOINTMENT_REMINDER" "NEW_PRESCRIPTION" "NEW_CHAT_MESSAGE" The action that occured that required a call
	object (MessageContentDto) Message for the patient (only if Air Doctor considers the message needed; using patient's locale)
	object (MessageContentDto) Message for the profile (only if Air Doctor considers the message needed; using profile's locale)

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"pastRevisions": [{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"pastRevisions": null,
"patient": {"personId": 123,
"policyId": 456,
"firstName": "John",
"lastName": "Smith",
"firstNameLatin": "John",
"lastNameLatin": "Smith",
"gender": "MALE",
"birthday": "1980-04-20",
"personalIdNumber": 30123456789,
"status": "ACTIVE",
"liabilityLimit": 200000,
"excessPercentage": 0.2,
"excessFee": 50,
"packageType": 0,
"subscriberId": 1234,
"companyId": 1,
"startDate": "2019-05-19",
"endDate": "2019-08-25",
"policyNumber": 468239748923321
},
"groupId": 1234,
"scheduledLocalTimestamp": "2020-07-29T18:30",
"scheduledProfileTimestamp": "2020-07-29T16:30",
"scheduledPatientTimestamp": "2020-07-29T15:30",
"appointmentFee": 240,
"excessAmount": 40,
"excessCurrency": "EUR",
"appointmentCurrency": "USD",
"promoCode": {"promoCodeId": 1234,
"name": "Welcome promo code",
"key": "PROMO15",
"discountPercentage": 10,
"discountFixed": 10,
"currency": "EUR",
"discountPercentageLimit": 20,
"minimalApplicableCost": 50
},
"appointmentType": "URGENT_HOME",
"reviewRating": 9,
"doctorReviewRating": 9,
"reviewText": "Almost perfect!",
"applicationReviewRating": 9,
"invoices": [{"invoiceId": 1234,
"invoiceNumber": 0,
"amount": 40,
"currency": "EUR",
"preliminary": true,
"date": "2021-02-15",
"type": "TO_PATIENT",
"files": ["string"
]
}
],
"appointmentCountry": "AD",
"appointmentSearchedCountry": "AD",
"appointmentState": "US_AL",
"appointmentSearchedState": "US_AL",
"canPrescribe": true,
"profileDetails": {"name": "John",
"lastName": "Smith",
"prefix": "DR",
"pseudonym": "Dr. John S.",
"gender": "MALE",
"photo": "string",
"experience": 5,
"prescriptionStates": ["US_AL"
],
"prescriptionCountriesByMatrix": ["AD"
],
"prescriptionCountriesByDataEntry": ["AD"
],
"clinicName": "string",
"phones": ["string"
],
"zipCode": 10029,
"city": "New York",
"street": "Madison Ave",
"number": 1468,
"floor": 3,
"entrance": "2a",
"room": 3284,
"addressNotes": "Take the second elevator",
"latitude": 40.79,
"longitude": -73.953,
"spokenLanguages": ["AA"
],
"profilesDelta": -300
}
}
],
"patient": {"personId": 123,
"policyId": 456,
"firstName": "John",
"lastName": "Smith",
"firstNameLatin": "John",
"lastNameLatin": "Smith",
"gender": "MALE",
"birthday": "1980-04-20",
"personalIdNumber": 30123456789,
"status": "ACTIVE",
"liabilityLimit": 200000,
"excessPercentage": 0.2,
"excessFee": 50,
"packageType": 0,
"subscriberId": 1234,
"companyId": 1,
"startDate": "2019-05-19",
"endDate": "2019-08-25",
"policyNumber": 468239748923321
},
"groupId": 1234,
"scheduledLocalTimestamp": "2020-07-29T18:30",
"scheduledProfileTimestamp": "2020-07-29T16:30",
"scheduledPatientTimestamp": "2020-07-29T15:30",
"appointmentFee": 240,
"excessAmount": 40,
"excessCurrency": "EUR",
"appointmentCurrency": "USD",
"promoCode": {"promoCodeId": 1234,
"name": "Welcome promo code",
"key": "PROMO15",
"discountPercentage": 10,
"discountFixed": 10,
"currency": "EUR",
"discountPercentageLimit": 20,
"minimalApplicableCost": 50
},
"appointmentType": "URGENT_HOME",
"reviewRating": 9,
"doctorReviewRating": 9,
"reviewText": "Almost perfect!",
"applicationReviewRating": 9,
"invoices": [{"invoiceId": 1234,
"invoiceNumber": 0,
"amount": 40,
"currency": "EUR",
"preliminary": true,
"date": "2021-02-15",
"type": "TO_PATIENT",
"files": ["string"
]
}
],
"appointmentCountry": "AD",
"appointmentSearchedCountry": "AD",
"appointmentState": "US_AL",
"appointmentSearchedState": "US_AL",
"canPrescribe": true,
"profileDetails": {"name": "John",
"lastName": "Smith",
"prefix": "DR",
"pseudonym": "Dr. John S.",
"gender": "MALE",
"photo": "string",
"experience": 5,
"prescriptionStates": ["US_AL"
],
"prescriptionCountriesByMatrix": ["AD"
],
"prescriptionCountriesByDataEntry": ["AD"
],
"clinicName": "string",
"phones": ["string"
],
"zipCode": 10029,
"city": "New York",
"street": "Madison Ave",
"number": 1468,
"floor": 3,
"entrance": "2a",
"room": 3284,
"addressNotes": "Take the second elevator",
"latitude": 40.79,
"longitude": -73.953,
"spokenLanguages": ["AA"
],
"profilesDelta": -300
},
"profile": {"profileId": 1234,
"ownerId": 1,
"prefix": "DR",
"pseudonym": "Dr. John S.",
"gender": "MALE",
"photo": "string",
"name": "John",
"lastName": "Smith",
"disabled": true,
"showToB2C": true,
"showToB2B2C": true,
"paymentSource": "AIR_DOCTOR",
"country": "US",
"currency": "USD",
"deltaTime": -300,
"specialty": ["GENERAL"
],
"subSpecialities": ["ACUPUNCTURE"
],
"specialSkills": "Also a sergeon",
"languages": ["AA"
],
"prescriptionStates": ["US_AL"
],
"prescriptionCountriesByMatrix": ["AD"
],
"prescriptionCountriesByDataEntry": ["AD"
],
"acceptLocalOnlyVideoPatients": true,
"about": "A very long life story would go here",
"licenseNumber": "1234567/89034567",
"experience": 5,
"university": "Harvard Medical School",
"locations": [{"locationId": 1234,
"type": "CLINIC",
"status": "ENABLED",
"maxRadius": 50000,
"minFeeRadius": 1000,
"feePerMeter": "0,10",
"offHours": "AVAILABLE_OFF_HOURS",
"photos": ["string"
],
"specialtyHours": {"property1": [{"dayOfWeek": "MONDAY",
"startTimes": [0
],
"endTimes": [0
],
"feeWorkingHours": 100,
"workingHoursAvailability": true,
"locationAvailabilityStatus": "COVERED",
"locationAvailabilityMessageId": 0,
"feeOffHours": 120,
"offHoursAvailability": true
}
],
"property2": [{"dayOfWeek": "MONDAY",
"startTimes": [0
],
"endTimes": [0
],
"feeWorkingHours": 100,
"workingHoursAvailability": true,
"locationAvailabilityStatus": "COVERED",
"locationAvailabilityMessageId": 0,
"feeOffHours": 120,
"offHoursAvailability": true
}
]
},
"phones": ["string"
],
"name": "Mount Sinai Hospital",
"zipCode": 10029,
"city": "New York",
"street": "Madison Ave",
"number": 1468,
"floor": 3,
"entrance": "2a",
"room": 3284,
"addressNotes": "Take the second elevator",
"dispatchType": "VIDEO_DISPATCH",
"dispatchPassword": "123$!",
"latitude": 40.79,
"longitude": -73.953,
"requiredData": "PASSPORT_NUMBER_COUNTRY_AND_ISSUE_DATE",
"requiresAccommodationAddress": "NOT_REQUIRED",
"requiresHomeAddress": "REQUIRED"
}
],
"reviewCount": 5,
"reviewRating": 3.9,
"doctorReviewRating": 8.9,
"taxIdentificationNumber": 304657283,
"personalIdentificationNumber": 304657283
},
"reason": "APPOINTMENT_UPDATED",
"patientMessage": {"description": "Appointment was Cancelled",
"details": "Sadly the doctor was not available to take your call",
"action": "Click to Reschedule",
"link": "https://www.air-dr.com/webapp/#details&id=2918",
"appointmentDetailsLine1": "Dr. TEST t., General Doctor",
"appointmentDetailsLine2": "Online visit, Saturday, 8/6/22, 9:00 AM",
"appointmentDetailsLine3": "John Smith",
"notes": ["string"
],
"calendarType": "SCHEDULE"
},
"profileMessage": {"description": "Appointment was Cancelled",
"details": "Sadly the doctor was not available to take your call",
"action": "Click to Reschedule",
"link": "https://www.air-dr.com/webapp/#details&id=2918",
"appointmentDetailsLine1": "Dr. TEST t., General Doctor",
"appointmentDetailsLine2": "Online visit, Saturday, 8/6/22, 9:00 AM",
"appointmentDetailsLine3": "John Smith",
"notes": ["string"
],
"calendarType": "SCHEDULE"
}
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Creates a set of video appointment requests, based on an automated algorithm

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

appointmentId	integer <int32> Unique appointment ID (leave blank when creating an appointment)
appointmentRevisionId	integer <int32> Unique appointment revision ID (optional, but recommended: can be specified to make sure the underlying appointment was not changed since it was retreived; leave blank when creating an appointment)
patientId	integer <int32> Patient ID (from the list returned for the user)
profileId	integer <int32> Profile ID (identifies the provider with whom the appointment is being made)
locationId	integer <int32> Location ID (location must agree with the specified profile)
speciality	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Profile specialty (optional, but becomes mandatory on creation if the profile has multiple allowed specialties; the specialty of the appointment cannot be changed)
caseId	integer <int32> Case ID (case associated with this appointment; created automatically or manually before creating the appointment)
promoCodeId	integer <int32> Optional; Promo code ID to be applied to the appointment
status	string Enum: "PROPOSED" "REQUESTED" "DOCTOR_REFUSED_REQUEST" "REQUEST_EXPIRED" "PATIENT_CANCELLED_REQUEST" "ALTERNATIVE_OFFERED" "PATIENT_REFUSED_OFFER" "OFFER_EXPIRED" "DOCTOR_CANCELLED_OFFER" "APPOINTMENT_SCHEDULED" "AUTOMATICALLY_CANCELLED" "DOCTOR_CANCELLED_APPOINTMENT" "PATIENT_CANCELLED_APPOINTMENT" "VISIT_TOOK_PLACE" "APPOINTMENT_CLOSED" "PAYMENT_FAILED" "NO_SHOW" "CS_CANCELLED_REQUEST" "CS_CANCELLED_OFFER" "CS_CANCELLED_APPOINTMENT" "CS_OFFER" "LATE_CANCELLATION" "HOLD_FEE" "HOLD_FAILED" "INSURER_CANCELLED_APPOINTMENT" "CANCELLED_DUE_TO_HOLD_FAILURE" "ADDITIONAL_ALTERNATIVE_OFFERED" "CLAIM_OPEN" "CLAIM_CLARIFICATION" "CLAIM_READY_FOR_PAYMENT" "CLAIM_INTERNALLY_PAID" "CLAIM_SEND_TO_INSURER" "CLAIM_SUBMITTED_TO_INSURER" "CLAIM_CANCELED" Appointment status
minutesToExpiration	integer <int32> Minutes left until the current appointment status expires (cannot be changed, except by customer support team)
scheduledTimestamp	string <date-time> Scheduled time of the appointment in appointment time zone (profile's time zone for clinic and home visits; patient's time zone for patient-side video visits)
careOf	string A person responsible for the patient (useful for minors)
passportNumber	string Passport number of patient
passportCountryEnum	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Passport country of patient
passportIssueDate	string <date> Passport issue date of patient
homeAddressInHomeCountry	string Patient home address in home country
email	string Patient's email address
phone	string Patient's contact phone number
notes	string Problem description to be provided by the patient
city	string For home visits, city of the visit
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" For home visits, the state of the country of the visit
postalCode	string For home visits, postal code of the address for the visit
street	string For home visits, street of the address for the visit
streetNumber	string For home visits, street number of the address for the visit
buildingName	string For home visits, building name of the address for the visit
floor	string For home visits, floor within the residence at the visit's location
apartment	string For home visits, apartment or room number at the visit's location
notesHomeAddress	string Patient address of accommodation or For home visits, additional instruction how to enter patient location
latitude	number <double> For home visits, latitude of visit's location
longitude	number <double> For home visits, longitude of visit's location
paymentStatus	string Enum: "WRITE_OFF" "CASH_DIRECT" "PAID_PRIVATELY" "PREPAYMENT" "EXCESS" "COVERED" Designated appointment payment status
chunkStatus	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Designated appointment chunk status
followUpType	string Enum: "REGULAR" "PAID_FOLLOW_UP" "FREE_FOLLOW_UP" Indicates whether the appointment is a follow-up
appointmentFeeNet	number <double> Appointment net fee (privileged)
appointmentExtraFlatCommission	number <double> Appointment extra flat commission (privileged)
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) Photos attached to this appointment
	Array of objects (Single appointment extra charge) Extra payments for this appointment. Privileged; might not be provided
	object (EventDto) Event associated with this appointment; on GET only the following fields are filled: time stamp, type, public note and initiator ID (0 for profile, -1 for customer support department, -2 system automation, patient's Subscriber ID otherwise)
demandNumber	string Appointment insurance demand number (if needed)
voucherNumber	string Insurance visit voucher number (if needed)
voucherStatus	string Enum: "MISSING" "VALID" "EXPIRED" "CANCELLED" "DECLINED" Status of the voucher (if needed)
voucherExpirationDate	string <date> The day on which the voucher expires(the voucher becomes expired the next day)
requestedTime	string Appointment time preference (only for manually allocated appointments)
	object (ClaimDetailsDto) Insurance claim extra details (only present and can be specified for claims, not system-managed appointments)
profileNotes	string Clinic notes about appointment
hmoEnum	string Enum: "CLALIT" "MACCABI" "MEHUHEDET" "LEUMIT" "OTHER" Health Maintenance Organization
appointmentOrigin	string Enum: "REGULAR" "FIRST_SERVE" "CLINIC_DIRECT" "VIDEO_GROUP" "VIDEO_GROUP_ONE_CLICK" "BOTH_OFFLINE_GROUP" "HOME_OFFLINE_GROUP" "CLINIC_OFFLINE_GROUP" "BOTH_OFFLINE_GROUP_BY_SYSTEM" "HOME_OFFLINE_GROUP_BY_SYSTEM" "CLINIC_OFFLINE_GROUP_BY_SYSTEM" Appointment origin
dispatchTo	string Doctor who get appointment from dispatcher
medicationsInUseStatus	string Enum: "STATUS_UNKNOWN" "MEDICATIONS_TAKEN" "NO_MEDICATIONS_TAKEN" Whether the patient provided a description of the medications in use
medicationsInUse	string Medications taken on regular basis
interpreterLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Language of requested interpreter
languages	Array of strings Items Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" List of preferred appointment languages
requestPreference	string Enum: "PRESCRIPTION" "LANGUAGE" "INTERPRETER_REQUESTED" "WITHOUT_INTERPRETER" Indicates that the user prefers a doctor capable of providing prescription, rather than speaking the language
patientCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Preference country (used to determine whether prescription is possible)
suggestedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country in which the patient suggest the appointment
preferredData	string <date> Data which was selected in filter by patient
preferredGender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" Genders which were selected in filter by patient
creationDelaySeconds	integer <int32> Delay to create suggestion (seconds)
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Requested appointment type

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"languages": ["AA"
],
"requestPreference": "PRESCRIPTION",
"patientCountry": "AD",
"suggestedCountry": "AD",
"preferredData": "2019-08-24",
"preferredGender": "MALE",
"creationDelaySeconds": 0,
"locationType": "HOME_VISIT"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Creates a face to face appointment requests, based on an automated algorithm

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

appointmentId	integer <int32> Unique appointment ID (leave blank when creating an appointment)
appointmentRevisionId	integer <int32> Unique appointment revision ID (optional, but recommended: can be specified to make sure the underlying appointment was not changed since it was retreived; leave blank when creating an appointment)
patientId	integer <int32> Patient ID (from the list returned for the user)
profileId	integer <int32> Profile ID (identifies the provider with whom the appointment is being made)
locationId	integer <int32> Location ID (location must agree with the specified profile)
speciality	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Profile specialty (optional, but becomes mandatory on creation if the profile has multiple allowed specialties; the specialty of the appointment cannot be changed)
caseId	integer <int32> Case ID (case associated with this appointment; created automatically or manually before creating the appointment)
promoCodeId	integer <int32> Optional; Promo code ID to be applied to the appointment
status	string Enum: "PROPOSED" "REQUESTED" "DOCTOR_REFUSED_REQUEST" "REQUEST_EXPIRED" "PATIENT_CANCELLED_REQUEST" "ALTERNATIVE_OFFERED" "PATIENT_REFUSED_OFFER" "OFFER_EXPIRED" "DOCTOR_CANCELLED_OFFER" "APPOINTMENT_SCHEDULED" "AUTOMATICALLY_CANCELLED" "DOCTOR_CANCELLED_APPOINTMENT" "PATIENT_CANCELLED_APPOINTMENT" "VISIT_TOOK_PLACE" "APPOINTMENT_CLOSED" "PAYMENT_FAILED" "NO_SHOW" "CS_CANCELLED_REQUEST" "CS_CANCELLED_OFFER" "CS_CANCELLED_APPOINTMENT" "CS_OFFER" "LATE_CANCELLATION" "HOLD_FEE" "HOLD_FAILED" "INSURER_CANCELLED_APPOINTMENT" "CANCELLED_DUE_TO_HOLD_FAILURE" "ADDITIONAL_ALTERNATIVE_OFFERED" "CLAIM_OPEN" "CLAIM_CLARIFICATION" "CLAIM_READY_FOR_PAYMENT" "CLAIM_INTERNALLY_PAID" "CLAIM_SEND_TO_INSURER" "CLAIM_SUBMITTED_TO_INSURER" "CLAIM_CANCELED" Appointment status
minutesToExpiration	integer <int32> Minutes left until the current appointment status expires (cannot be changed, except by customer support team)
scheduledTimestamp	string <date-time> Scheduled time of the appointment in appointment time zone (profile's time zone for clinic and home visits; patient's time zone for patient-side video visits)
careOf	string A person responsible for the patient (useful for minors)
passportNumber	string Passport number of patient
passportCountryEnum	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Passport country of patient
passportIssueDate	string <date> Passport issue date of patient
homeAddressInHomeCountry	string Patient home address in home country
email	string Patient's email address
phone	string Patient's contact phone number
notes	string Problem description to be provided by the patient
city	string For home visits, city of the visit
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" For home visits, the state of the country of the visit
postalCode	string For home visits, postal code of the address for the visit
street	string For home visits, street of the address for the visit
streetNumber	string For home visits, street number of the address for the visit
buildingName	string For home visits, building name of the address for the visit
floor	string For home visits, floor within the residence at the visit's location
apartment	string For home visits, apartment or room number at the visit's location
notesHomeAddress	string Patient address of accommodation or For home visits, additional instruction how to enter patient location
latitude	number <double> For home visits, latitude of visit's location
longitude	number <double> For home visits, longitude of visit's location
paymentStatus	string Enum: "WRITE_OFF" "CASH_DIRECT" "PAID_PRIVATELY" "PREPAYMENT" "EXCESS" "COVERED" Designated appointment payment status
chunkStatus	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Designated appointment chunk status
followUpType	string Enum: "REGULAR" "PAID_FOLLOW_UP" "FREE_FOLLOW_UP" Indicates whether the appointment is a follow-up
appointmentFeeNet	number <double> Appointment net fee (privileged)
appointmentExtraFlatCommission	number <double> Appointment extra flat commission (privileged)
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) Photos attached to this appointment
	Array of objects (Single appointment extra charge) Extra payments for this appointment. Privileged; might not be provided
	object (EventDto) Event associated with this appointment; on GET only the following fields are filled: time stamp, type, public note and initiator ID (0 for profile, -1 for customer support department, -2 system automation, patient's Subscriber ID otherwise)
demandNumber	string Appointment insurance demand number (if needed)
voucherNumber	string Insurance visit voucher number (if needed)
voucherStatus	string Enum: "MISSING" "VALID" "EXPIRED" "CANCELLED" "DECLINED" Status of the voucher (if needed)
voucherExpirationDate	string <date> The day on which the voucher expires(the voucher becomes expired the next day)
requestedTime	string Appointment time preference (only for manually allocated appointments)
	object (ClaimDetailsDto) Insurance claim extra details (only present and can be specified for claims, not system-managed appointments)
profileNotes	string Clinic notes about appointment
hmoEnum	string Enum: "CLALIT" "MACCABI" "MEHUHEDET" "LEUMIT" "OTHER" Health Maintenance Organization
appointmentOrigin	string Enum: "REGULAR" "FIRST_SERVE" "CLINIC_DIRECT" "VIDEO_GROUP" "VIDEO_GROUP_ONE_CLICK" "BOTH_OFFLINE_GROUP" "HOME_OFFLINE_GROUP" "CLINIC_OFFLINE_GROUP" "BOTH_OFFLINE_GROUP_BY_SYSTEM" "HOME_OFFLINE_GROUP_BY_SYSTEM" "CLINIC_OFFLINE_GROUP_BY_SYSTEM" Appointment origin
dispatchTo	string Doctor who get appointment from dispatcher
medicationsInUseStatus	string Enum: "STATUS_UNKNOWN" "MEDICATIONS_TAKEN" "NO_MEDICATIONS_TAKEN" Whether the patient provided a description of the medications in use
medicationsInUse	string Medications taken on regular basis
interpreterLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Language of requested interpreter
languages	Array of strings Items Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" List of preferred appointment languages
requestPreference	string Enum: "PRESCRIPTION" "LANGUAGE" "INTERPRETER_REQUESTED" "WITHOUT_INTERPRETER" Indicates that the user prefers a doctor capable of providing prescription, rather than speaking the language
patientCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Preference country (used to determine whether prescription is possible)
suggestedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country in which the patient suggest the appointment
preferredData	string <date> Data which was selected in filter by patient
preferredGender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" Genders which were selected in filter by patient
creationDelaySeconds	integer <int32> Delay to create suggestion (seconds)
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Requested appointment type

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"languages": ["AA"
],
"requestPreference": "PRESCRIPTION",
"patientCountry": "AD",
"suggestedCountry": "AD",
"preferredData": "2019-08-24",
"preferredGender": "MALE",
"creationDelaySeconds": 0,
"locationType": "HOME_VISIT"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Get profiles price range by available location type for offline asap visits

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

selectedLanguages	Array of strings Items Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU"
selectedSpecialty	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS"
selectedSubSpeciality	Array of strings Items Enum: "ACUPUNCTURE" "AYURVEDA" "HOMEOPATHY" "NATUROPATHY" "CHINESE_OR_ORIENTAL_MEDICINE" "GENERAL_CLINICAL_CARDIOLOGIST" "CARDIOTHORACIC_SURGEON" "ECHOCARDIOLOGIST" "ELECTROPHYSIOLOGIST" "INTERVENTIONAL_CARDIOLOGY_CARDIOLOGIST" "ELECTROPHYSIOLOGY" "ADVANCED_HEART_FAILURE_AND_TRANSPLANTATION" "ADULT_CONGENITAL_CARDIOLOGIST" "NUCLEAR_CARDIOLOGIST" "HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGIST" "COMPUTED_TOMOGRAPHY_MAGNETIC_RESONANCE_IMAGING_CARDIOLOGIST" "ENDODONTIST" "ORAL_AND_MAXILLOFACIAL_SURGEON" "ORTHODONTIST_ALIGNMENT_SPECIALIST" "PEDIATRIC_DENTIST" "PERIODONTIST_GUM_SPECIALIST" "PROSTHODONTIST_REPLACEMENT_SPECIALIST" "DERMATOPATHOLOGY" "EPIDERMOLYSIS_BULLOSA_CLINIC" "LASER" "MOHS_SURGERY" "PEDIATRIC_DERMATOLOGY" "PHOTOTHERAPY" "CONTACT_DERMATITIS" "VITILIGO_ALOPECIA_AREATA" "PIGMENTED_LESION_AND_MELANOMA" "AUTOIMMUNE_SKIN_DISEASE" "SKIN_CANCER_GENETICS" "HIGH_RISK_NONMELANOMA_SKIN_CANCER" "NAIL_DISORDERS" "HAIR_LOSS" "GENITAL_DERMATOLOGY" "ADVANCED_BASAL_CELL_CARCINOMA" "SKIN_ALLERGIES_AND_CONTACT_DERMATITIS" "PALLIATIVE_MEDICINE" "CRITICAL_CARE_MEDICINE_EMERGENCY" "MEDICAL_TOXICOLOGY_EMERGENCY" "PEDIATRIC_EMERGENCY_MEDICINE" "SPORTS_MEDICINE_EMERGENCY" "EMERGENCY_MEDICAL_SERVICES" "UNDERSEA_AND_HYPERBARIC_MEDICINE" "ALLERGIES" "FACIAL_SURGERY" "HEAD_AND_NECK" "THROAT" "EAR" "PEDIATRIC_CONDITIONS" "COSMETIC_SURGERY" "LARYNGOLOGY" "OTOLOGY_AND_NEUROTOLOGY" "INFLAMMATORY_BOWEL_DISEASE" "TROPICAL_DISEASES" "GASTROINTESTINAL_CANCER_AND_ITS_PREVENTION" "ENDOSCOPIC_SURVEILLANCE" "REFLUX_OESOPHAGITIS" "HEPATOLOGY" "PANCREATIC_DISEASE" "TRANSPLANTATION" "MEDICOLEGAL_ISSUES_IN_MEDICINE" "CLINICAL_PHARMACOLOGY" "INHERITED_CANCER_SYNDROMES" "ADOLESCENT_MEDICINE_GENERAL" "CLINICAL_INFORMATICS" "EMERGENCY_MEDICINE" "GERIATRIC_MEDICINE_GENERAL" "HIV_AIDS" "HOSPICE_AND_PALLIATIVE_MEDICINE_GENERAL" "MATERNAL_FETAL_MEDICINE" "REPRODUCTIVE_ENDOCRINOLOGY" "GYNECOLOGIC_ONCOLOGY_GYNECOLOGIST" "UROGYNECOLOGY" "EPILEPSY_NEURO_DIAGNOSTICS" "HEADACHE_PAIN_MEDICINE" "MOVEMENT_DISORDERS" "NEURO_BEHAVIOR_MEMORY_DISORDERS" "NEURO_IMMUNOLOGY_MS" "NEURO_INFECTIOUS_DISEASE" "NEURO_MUSCULAR" "NEURO_ONCOLOGY_NEUROLOGIST" "NEURO_OPHTHALMOLOGY_NEUROLOGIST" "NEURO_VASCULAR_STROKE" "SPORTS_MEDICINE_ORTHOPEDIST" "HAND_AND_ARM" "PEDIATRIC_ORTHOPEDICS" "SPINE_SURGERY" "FOOT_AND_ANKLE_ORTHOPEDICS_PODIATRY" "JOINT_REPLACEMENT" "TRAUMA_SURGERY" "HIP_AND_KNEE_REPLACEMENT" "SHOULDER_AND_ELBOW" "ORTHOPAEDIC_ONCOLOGY" "MUSCULOSKELETALTUMORS" "ANTERIOR_SEGMENT_SURGERY" "CATARACTS_AND_REFRACTIVE_SURGERY" "CORNEA_AND_EXTERNAL_DISEASE" "GLAUCOMA" "NEURO_OPHTHALMOLOGY_OPHTALMOLOGIST" "OCULAR_ONCOLOGY" "OCULOPLASTICS_AND_ORBIT_SURGERY" "OPHTHALMIC_PATHOLOGY" "PEDIATRICS" "UVEITIS_AND_IMMUNOLOGY" "VITREORETINAL_SURGERY" "PEDIATRIC_RHEUMATOLOGY" "PEDIATRIC_PULMONOLOGY" "PEDIATRIC_NEPHROLOGY" "PEDIATRIC_INFECTIOUS_DISEASES" "PEDIATRIC_HEMATOLOGYONCOLOGY" "PEDIATRIC_GASTROENTEROLOGY" "PEDIATRIC_ENDOCRINOLOGY" "PEDIATRIC_EMERGENCY_MEDICINE_PEDIATRICIAN" "DEVELOPMENTAL_BEHAVIORAL_PEDIATRICS" "PEDIATRIC_CRITICAL_CARE_MEDICINE" "PEDIATRIC_CARDIOLOGY" "ADOLESCENT_MEDICINE_PEDIATRICIAN" "MEDICAL_TOXICOLOGY_PEDIATRICIAN" "SLEEP_MEDICINE_PEDIATRICIAN" "SPORTS_MEDICINE_PEDIATRICIAN" "PEDIATRIC_TRANSPLANT_HEPATOLOGY" "GENERAL_ADULT_PSYCHIATRY" "SOCIAL_AND_COMMUNITY_PSYCHIATRY" "OLD_AGE_PSYCHIATRY" "CHILD_AND_ADOLESCENT_PSYCHIATRY" "LIAISON_PSYCHIATRY" "FORENSIC_PSYCHIATRY" "LEARNING_DISABILITY" "PSYCHOTHERAPY" "RADIATION_ONCOLOGY" "SURGICAL_ONCOLOGY" "MEDICAL_ONCOLOGY" "INTERVENTIONAL_ONCOLOGY" "GYNECOLOGIC_ONCOLOGY" "PEDIATRIC_ONCOLOGY" "NEURO_ONCOLOGY" "HEMATO_ONCOLOGY" "URO_ONCOLOGY" "CARDIOTHORACIC_SURGERY" "GENERAL_SURGERY" "NEUROSURGERY" "ORAL_AND_MAXILLOFACIAL_SURGERY" "OTOLARYNGOLOGY_SURGERY" "PAEDIATRIC_SURGERY" "PLASTIC_SURGERY" "TRAUMA_AND_ORTHOPAEDIC_SURGERY" "UROLOGY_SURGERY" "VASCULAR_SURGERY" "CARDIOVASCULAR_DISEASE" "ADULT_CONGENITAL_HEART_DISEASE" "CARDIAC_ELECTROPHYSIOLOGY" "HEART_FAILURE_AND_TRANSPLANT_CARDIOLOGY" "INTERVENTIONAL_CARDIOLOGY_INTERNAL" "ENDOCRINOLOGY_DIABETES_AND_METABOLISM" "GASTROENTEROLOGY" "TRANSPLANT_HEPATOLOGY" "HEMATOLOGY_BLOOD" "INFECTIOUS_DISEASE" "NEPHROLOGY" "ONCOLOGY" "PULMONARY_DISEASE" "RHEUMATOLOGY" "ADOLESCENT_MEDICINE_INTERNAL" "ALLERGY_AND_IMMUNOLOGY" "CRITICAL_CARE_MEDICINE_INTERNAL" "GERIATRIC_MEDICINE_INTERNAL" "NEUROCRITICAL_CARE" "SLEEP_MEDICINE_INTERNAL" "SPORTS_MEDICINE_INTERNAL" "RHINOLOGY" "SLEEP_MEDICINE" "ENDO_UROLOGY" "ONCOLOGICAL_UROLOGY" "NEURO_UROLOGY" "PREDIATRIC_UROLOGIST" "ANDROLOGY" "RECONSTRUCTIVE_UROLOGY" "UROGYNECOLOGY_UROLOGIST" "GASTROENTEROLOGIST_PEDIATRIC_GASTROENTEROLOGY" "NEUROGASTROENTEROLOGY" "ORTHOPEDIC_SURGERY" "ONCOLOGICAL_SURGERY" "ENDOCRINE_SURGERY" "COLORECTAL_SURGERY" "NEUROLOGIST_NEUROSURGERY" "PRIATRIC_NEUROLOGY" "NEUROLOGIST_SLEEP_MEDICINE" "CARDIOLOGIST_PEDIATRIC_CARDIOLOGY" "PAIN_MEDICINE" "PEDIATRIC_OTOLARYNGOLOGY" "PEDIATRIC_UROLOGIST" "PEDIATRICIAN_PEDIATRIC_ORTHOPEDICS" "PEDIATRIC_SURGERY" "PEDIATRIC_NEUROLOGY" "PEDIATRICIAN_PEDIATRIC_DERMATOLOGY" "CT" "MRI" "THYROID_AND_PARATHYROID_SURGERY" "MILITARY_INVASIVE_SURGERY" "BARIATRIC_SURGERY" "ORGAN_TRANSPLANT" "LAPAROSCOPIC_SURGERY" "GASTROINTESTINAL_SURGERY" "PEDIATRIC_ALLERGY_AND_IMMUNOLOGY" "EATING_DISORDER" "GASTROINTESTINAL_ONCOLOGY" "HIGH_RISK_PREGNANCY" "CERVIX" "FERTILITY_TREATMENTS" "IVF" "ULTRASOUND" "MINIMALLY_INVASIVE_GYNECOLOGIC_SURGERY" "CATARACTS_SURGERY" "STRABISMUS" "RETINA" "SHOULDER" "ELBOW" "HIP" "KNEE" "FOOT" "ANKLE" "PALM" "ARM" "ARTHROSCOPY_SURGERY" "MRI_LAB" "BLOOD_TEST" "X_RAY" "VACCINATION" "ULTRASOUND_LAB" "CT_LAB" "URINE" "THROAT_SURFACE" "STD" "HIV" "PCR"
selectedGender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER"
patientId	integer <int32>
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT"
suggestedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
longitude	number <double>
latitude	number <double>
includeHomeDistanceCheck	boolean
requestTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"selectedLanguages": ["AA"
],
"selectedSpecialty": "GENERAL",
"selectedSubSpeciality": ["ACUPUNCTURE"
],
"selectedGender": "MALE",
"patientId": 0,
"locationType": "HOME_VISIT",
"suggestedCountry": "AD",
"longitude": 0.1,
"latitude": 0.1,
"includeHomeDistanceCheck": true,
"requestTime": "2019-08-24T14:15:22Z"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Creates or updates an appointment

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Request Body schema: application/json
required

appointmentId	integer <int32> Unique appointment ID (leave blank when creating an appointment)
appointmentRevisionId	integer <int32> Unique appointment revision ID (optional, but recommended: can be specified to make sure the underlying appointment was not changed since it was retreived; leave blank when creating an appointment)
patientId	integer <int32> Patient ID (from the list returned for the user)
profileId	integer <int32> Profile ID (identifies the provider with whom the appointment is being made)
locationId	integer <int32> Location ID (location must agree with the specified profile)
speciality	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS" Profile specialty (optional, but becomes mandatory on creation if the profile has multiple allowed specialties; the specialty of the appointment cannot be changed)
caseId	integer <int32> Case ID (case associated with this appointment; created automatically or manually before creating the appointment)
promoCodeId	integer <int32> Optional; Promo code ID to be applied to the appointment
status	string Enum: "PROPOSED" "REQUESTED" "DOCTOR_REFUSED_REQUEST" "REQUEST_EXPIRED" "PATIENT_CANCELLED_REQUEST" "ALTERNATIVE_OFFERED" "PATIENT_REFUSED_OFFER" "OFFER_EXPIRED" "DOCTOR_CANCELLED_OFFER" "APPOINTMENT_SCHEDULED" "AUTOMATICALLY_CANCELLED" "DOCTOR_CANCELLED_APPOINTMENT" "PATIENT_CANCELLED_APPOINTMENT" "VISIT_TOOK_PLACE" "APPOINTMENT_CLOSED" "PAYMENT_FAILED" "NO_SHOW" "CS_CANCELLED_REQUEST" "CS_CANCELLED_OFFER" "CS_CANCELLED_APPOINTMENT" "CS_OFFER" "LATE_CANCELLATION" "HOLD_FEE" "HOLD_FAILED" "INSURER_CANCELLED_APPOINTMENT" "CANCELLED_DUE_TO_HOLD_FAILURE" "ADDITIONAL_ALTERNATIVE_OFFERED" "CLAIM_OPEN" "CLAIM_CLARIFICATION" "CLAIM_READY_FOR_PAYMENT" "CLAIM_INTERNALLY_PAID" "CLAIM_SEND_TO_INSURER" "CLAIM_SUBMITTED_TO_INSURER" "CLAIM_CANCELED" Appointment status
minutesToExpiration	integer <int32> Minutes left until the current appointment status expires (cannot be changed, except by customer support team)
scheduledTimestamp	string <date-time> Scheduled time of the appointment in appointment time zone (profile's time zone for clinic and home visits; patient's time zone for patient-side video visits)
careOf	string A person responsible for the patient (useful for minors)
passportNumber	string Passport number of patient
passportCountryEnum	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Passport country of patient
passportIssueDate	string <date> Passport issue date of patient
homeAddressInHomeCountry	string Patient home address in home country
email	string Patient's email address
phone	string Patient's contact phone number
notes	string Problem description to be provided by the patient
city	string For home visits, city of the visit
state	string Enum: "US_AL" "US_AK" "US_AZ" "US_AR" "US_CA" "US_CO" "US_CT" "US_DE" "US_DC" "US_FL" "US_GA" "US_HI" "US_ID" "US_IL" "US_IN" "US_IA" "US_KS" "US_KY" "US_LA" "US_ME" "US_MD" "US_MA" "US_MI" "US_MN" "US_MS" "US_MO" "US_MT" "US_NE" "US_NV" "US_NH" "US_NJ" "US_NM" "US_NY" "US_NC" "US_ND" "US_OH" "US_OK" "US_OR" "US_PA" "US_RI" "US_SC" "US_SD" "US_TN" "US_TX" "US_UT" "US_VT" "US_VA" "US_WA" "US_WV" "US_WI" "US_WY" "DE_BW" "DE_BY" "DE_BE" "DE_BB" "DE_HB" "DE_HH" "DE_HE" "DE_MV" "DE_NI" "DE_NW" "DE_RP" "DE_SL" "DE_SN" "DE_ST" "DE_SH" "DE_TH" "CA_AB" "CA_BC" "CA_MB" "CA_NB" "CA_NL" "CA_NT" "CA_NS" "CA_NU" "CA_ON" "CA_PE" "CA_QC" "CA_SK" "CA_YT" "IN_AN" "IN_AP" "IN_AR" "IN_AS" "IN_BR" "IN_CH" "IN_CG" "IN_DH" "IN_DL" "IN_GA" "IN_GJ" "IN_HR" "IN_HP" "IN_JK" "IN_JH" "IN_KA" "IN_KL" "IN_LA" "IN_LD" "IN_MP" "IN_MH" "IN_MN" "IN_ML" "IN_MZ" "IN_NL" "IN_OD" "IN_PY" "IN_PB" "IN_RJ" "IN_SK" "IN_TN" "IN_TS" "IN_TR" "IN_UP" "IN_UK" "IN_WB" "AU_NSW" "AU_QLD" "AU_SA" "AU_TAS" "AU_VIC" "AU_WA" "AU_ACT" "AU_NT" "CH_ZH" "CH_BE" "CH_LU" "CH_UR" "CH_SZ" "CH_OW" "CH_NW" "CH_GL" "CH_ZG" "CH_FR" "CH_SO" "CH_BS" "CH_BL" "CH_SH" "CH_AR" "CH_AI" "CH_SG" "CH_GR" "CH_AG" "CH_TG" "CH_TI" "CH_VD" "CH_VS" "CH_NE" "CH_GE" "CH_JU" "BR_AC" "BR_AL" "BR_AM" "BR_AP" "BR_BA" "BR_CE" "BR_DF" "BR_ES" "BR_GO" "BR_MA" "BR_MG" "BR_MS" "BR_MT" "BR_PA" "BR_PB" "BR_PE" "BR_PI" "BR_PR" "BR_RJ" "BR_RN" "BR_RO" "BR_RR" "BR_RS" "BR_SC" "BR_SE" "BR_SP" "BR_TO" For home visits, the state of the country of the visit
postalCode	string For home visits, postal code of the address for the visit
street	string For home visits, street of the address for the visit
streetNumber	string For home visits, street number of the address for the visit
buildingName	string For home visits, building name of the address for the visit
floor	string For home visits, floor within the residence at the visit's location
apartment	string For home visits, apartment or room number at the visit's location
notesHomeAddress	string Patient address of accommodation or For home visits, additional instruction how to enter patient location
latitude	number <double> For home visits, latitude of visit's location
longitude	number <double> For home visits, longitude of visit's location
paymentStatus	string Enum: "WRITE_OFF" "CASH_DIRECT" "PAID_PRIVATELY" "PREPAYMENT" "EXCESS" "COVERED" Designated appointment payment status
chunkStatus	string Enum: "HIDE" "SHOW_BLOCK" "ASSISTANCE" "PAY" "PREPAYMENT" "CC_BACKUP" "COVERED" "PAY_UNDER_INSURER" Designated appointment chunk status
followUpType	string Enum: "REGULAR" "PAID_FOLLOW_UP" "FREE_FOLLOW_UP" Indicates whether the appointment is a follow-up
appointmentFeeNet	number <double> Appointment net fee (privileged)
appointmentExtraFlatCommission	number <double> Appointment extra flat commission (privileged)
	Array of objects (Record holding a single file attachment (usually a photo or a document scan, but different types of files can be uploaded)) Photos attached to this appointment
	Array of objects (Single appointment extra charge) Extra payments for this appointment. Privileged; might not be provided
	object (EventDto) Event associated with this appointment; on GET only the following fields are filled: time stamp, type, public note and initiator ID (0 for profile, -1 for customer support department, -2 system automation, patient's Subscriber ID otherwise)
demandNumber	string Appointment insurance demand number (if needed)
voucherNumber	string Insurance visit voucher number (if needed)
voucherStatus	string Enum: "MISSING" "VALID" "EXPIRED" "CANCELLED" "DECLINED" Status of the voucher (if needed)
voucherExpirationDate	string <date> The day on which the voucher expires(the voucher becomes expired the next day)
requestedTime	string Appointment time preference (only for manually allocated appointments)
	object (ClaimDetailsDto) Insurance claim extra details (only present and can be specified for claims, not system-managed appointments)
profileNotes	string Clinic notes about appointment
hmoEnum	string Enum: "CLALIT" "MACCABI" "MEHUHEDET" "LEUMIT" "OTHER" Health Maintenance Organization
appointmentOrigin	string Enum: "REGULAR" "FIRST_SERVE" "CLINIC_DIRECT" "VIDEO_GROUP" "VIDEO_GROUP_ONE_CLICK" "BOTH_OFFLINE_GROUP" "HOME_OFFLINE_GROUP" "CLINIC_OFFLINE_GROUP" "BOTH_OFFLINE_GROUP_BY_SYSTEM" "HOME_OFFLINE_GROUP_BY_SYSTEM" "CLINIC_OFFLINE_GROUP_BY_SYSTEM" Appointment origin
dispatchTo	string Doctor who get appointment from dispatcher
medicationsInUseStatus	string Enum: "STATUS_UNKNOWN" "MEDICATIONS_TAKEN" "NO_MEDICATIONS_TAKEN" Whether the patient provided a description of the medications in use
medicationsInUse	string Medications taken on regular basis
interpreterLanguage	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" Language of requested interpreter
languages	Array of strings Items Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU" List of preferred appointment languages
requestPreference	string Enum: "PRESCRIPTION" "LANGUAGE" "INTERPRETER_REQUESTED" "WITHOUT_INTERPRETER" Indicates that the user prefers a doctor capable of providing prescription, rather than speaking the language
patientCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Preference country (used to determine whether prescription is possible)
suggestedCountry	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country in which the patient suggest the appointment
preferredData	string <date> Data which was selected in filter by patient
preferredGender	string Enum: "MALE" "FEMALE" "BOTH" "OTHER" Genders which were selected in filter by patient
creationDelaySeconds	integer <int32> Delay to create suggestion (seconds)
locationType	string Enum: "HOME_VISIT" "CLINIC_VISIT" "VIDEO_VISIT" Requested appointment type

Responses

Request samples

Payload

Content type

application/json

{"appointmentId": 1234,
"appointmentRevisionId": 5678,
"patientId": 12345,
"profileId": 1234,
"locationId": 1234,
"speciality": "DERMATOLOGIST",
"caseId": 1234,
"promoCodeId": 1234,
"status": "REQUESTED",
"minutesToExpiration": 57,
"scheduledTimestamp": "2020-07-29T16:30",
"careOf": "Vivian Smith",
"passportNumber": "string",
"passportCountryEnum": "AD",
"passportIssueDate": "2019-08-24",
"homeAddressInHomeCountry": "string",
"email": "someone@example.com",
"phone": "+15467383892",
"notes": "Meesa don't feel so good...",
"city": "London",
"state": "AZ",
"postalCode": "W3 6RT",
"street": "Camden St",
"streetNumber": "11B",
"buildingName": "The Ritz Carlton, New York",
"floor": 3,
"apartment": 315,
"notesHomeAddress": "Entrance is on the opposite side",
"latitude": 51.507351,
"longitude": -0.127758,
"paymentStatus": "PREPAYMENT",
"chunkStatus": "PREPAYMENT",
"followUpType": "PAID_FOLLOW_UP",
"appointmentFeeNet": 240,
"appointmentExtraFlatCommission": 240,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"extras": [{"amount": 15,
"amountNet": 10,
"notes": 10,
"currency": "USD",
"type": "MEDICINE",
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"quantity": 0
}
],
"event": {"eventId": 0,
"caseId": 0,
"parentEventId": 0,
"initiatorUserName": "string",
"initiatorId": 0,
"patientUserName": "string",
"subscriberId": 0,
"profileId": 0,
"profileFullName": "string",
"aggregatorId": 0,
"appointmentId": 0,
"assigneeId": 0,
"statusId": 0,
"department": "ACCOUNT",
"dueTimestamp": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"amount": 0.1,
"internalNote": "string",
"publicNote": "string",
"currency": "AED",
"paymentMethod": "CREDIT_CARD",
"type": "APPOINTMENT_UPDATE",
"issueId": 0,
"photos": [{"id": 1234,
"path": "39d80a47f12c985f72c13f8e91a74.png",
"base64Data": "4389a21cd47e2f39d80a47f12c985f72c13f8e91a74289317489237148923",
"name": "photo.png",
"timestampUploaded": "2020-04-29",
"timestampExpire": "2021-12-31",
"comments": "Photo explaining the issue",
"fileTypeEnum": "PROBLEM_DESCRIPTION_PHOTO",
"fileSize": 647823
}
],
"invoiceIdList": [0
],
"paymentIdList": [0
]
},
"demandNumber": "F73289-G9",
"voucherNumber": "Q5789324841209PL",
"voucherStatus": "VALID",
"voucherExpirationDate": "2021-12-31",
"requestedTime": "string",
"claimDetails": {"appointmentId": 1987,
"companyId": 1,
"bankId": 12,
"branch": 855,
"accountNumber": 432678,
"accountHolder": "John Smith",
"accountTypeEnum": "SAVINGS",
"bankName": "First International Bank",
"bankNumber": "IL170108000000012612345",
"codeNumber": 323232,
"branchNumber": "00003456"
},
"profileNotes": "Requires additional appointment",
"hmoEnum": "CLALIT",
"appointmentOrigin": "CLINIC_DIRECT",
"dispatchTo": "Dr. Hippocrates",
"medicationsInUseStatus": "STATUS_UNKNOWN",
"medicationsInUse": "Some pills..",
"interpreterLanguage": "EN",
"languages": ["AA"
],
"requestPreference": "PRESCRIPTION",
"patientCountry": "AD",
"suggestedCountry": "AD",
"preferredData": "2019-08-24",
"preferredGender": "MALE",
"creationDelaySeconds": 0,
"locationType": "HOME_VISIT"
}

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns previously left and confirmed reviews for the profile

path Parameters

id

required

integer <int32>

query Parameters

startAt

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns profiles, based on list of Profile IDs

query Parameters

ids required	Array of integers <int32> [ items <int32 > ] List of profile Ids to retrieve
policy-id required	integer <int32> Policy Id associated with the request.
patient-id required	integer <int32> Patient Id for whom the profiles are being requested.
excluded-appointment-id	integer <int32> Appointment Id to be excluded from the results.
country	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK" Country associated with the request. Optional.

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns profiles, based on list of Profile IDs and given coordinates

query Parameters

ids required	Array of integers <int32> [ items <int32 > ] List of profile Ids to retrieve
policy-id required	integer <int32> Policy Id associated with the request.
patient-id required	integer <int32> Patient Id for whom the profiles are being requested.
excluded-appointment-id	integer <int32> Appointment Id to be excluded from the results.
latitude required	number <double> Latitude of the location for filtering profiles.
longitude required	number <double> Longitude of the location for filtering profiles.
check-home-distance	boolean Default: false Flag to indicate whether to check the distance from the home location.

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns profiles, based on user Latitude and Longitude

query Parameters

latitude required	number <double> Latitude of the location for filtering profiles.
longitude required	number <double> Longitude of the location for filtering profiles.
policy-id required	integer <int32> Policy Id associated with the request.
patient-id required	integer <int32> Patient Id for whom the profiles are being requested.
check-home-distance	boolean Default: false Flag to indicate whether to check the distance from the home location.

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns specific appointment by its ID

path Parameters

id

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Returns the list of specific appointments by policy id

path Parameters

id

required

integer <int32>

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Report Management

downloadReport

query Parameters

companyId required	integer <int32> Example: companyId=16 ID of the company for which the report is requested
reportId required	integer <int32> Example: reportId=1 ID of the report which is requested
fromDate	string <date> Example: fromDate=2022-01-01 Start date of the period for which the report is requested
toDate	string <date> Example: toDate=2022-01-01 End date of the period for which the report is requested

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Insurer Management

Returns information about the availability of profiles according to the specified parameters

query Parameters

latitude required	number <double>
longitude required	number <double>
companyId required	integer <int32>
specialty required	string Enum: "GENERAL" "DENTIST" "ORTHOPEDIST" "PEDIATRICIAN" "GYNECOLOGIST" "PULMONOLOGIST" "GASTROENTEROLOGIST" "OPHTALMOLOGIST" "DERMATOLOGIST" "NEUROLOGIST" "ENT" "PSYCHIATRIST" "CARDIOLOGIST" "UROLOGIST" "ALTERNATIVE" "OTHER" "EMERGENCY" "MORE" "MASSEUSE" "ONCOLOGIST" "SURGEON" "INTERNIST" "HEMATOLOGIST" "NEPHROLOGIST" "RHEUMATOLOGIST" "GERIATRICIAN" "ALLERGOLOGIST" "ONLINE_DOCTOR" "IMAGING" "LABS"
language required	string Enum: "AA" "AB" "AE" "AF" "AK" "AM" "AN" "AR" "AS" "AV" "AY" "AZ" "BA" "BE" "BG" "BH" "BI" "BM" "BN" "BO" "BR" "BS" "CA" "CE" "CH" "CO" "CR" "CS" "CU" "CV" "CY" "DA" "DE" "DV" "DZ" "EE" "EL" "EN" "EO" "ES" "ET" "EU" "FA" "FF" "FI" "FJ" "FO" "FR" "FY" "GA" "GD" "GL" "GN" "GU" "GV" "HA" "HE" "HI" "HO" "HR" "HT" "HU" "HY" "HZ" "IA" "ID" "IE" "IG" "II" "IK" "IO" "IS" "IT" "IU" "JA" "JV" "KA" "KG" "KI" "KJ" "KK" "KL" "KM" "KN" "KO" "KR" "KS" "KU" "KV" "KW" "KY" "LA" "LB" "LG" "LI" "LN" "LO" "LT" "LU" "LV" "MG" "MH" "MI" "MK" "ML" "MN" "MR" "MS" "MT" "MY" "NA" "NB" "ND" "NE" "NG" "NL" "NN" "NO" "NR" "NV" "NY" "OC" "OJ" "OM" "OR" "OS" "PA" "PI" "PL" "PS" "PT" "QU" "RM" "RN" "RO" "RU" "RW" "SA" "SC" "SD" "SE" "SG" "SI" "SK" "SL" "SM" "SN" "SO" "SQ" "SR" "SS" "ST" "SU" "SV" "SW" "TA" "TE" "TG" "TH" "TI" "TK" "TL" "TN" "TO" "TR" "TS" "TT" "TW" "TY" "UG" "UK" "UR" "UZ" "VE" "VI" "VO" "WA" "WO" "XH" "YI" "YO" "ZA" "ZH" "YUE" "ZU"

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Messages

Loading new or previous messages for a user's chat

query Parameters

message-id required	integer <int32>
new-messages	boolean Default: false

header Parameters

X-Token

required

string

Example: c88e6e5b-e9f8-425c-9461-c83af0a1b91e

Access Token

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Utilities

Downloads the specified file from the file data store

path Parameters

name

required

string

Example: 42dde57da2832ba84b50f9ae0637069a9770aa8e9fb65195141fb5145a5841527012aea6115a07015d3f24f1ab8fdcb9f0e76c3c760ef0b98f5e786db0fa9e0c.png

File name

header Parameters

Accept

string

Value: "image/*,application/pdf"

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Downloads the specified file from the file data store

path Parameters

name

required

string

Example: 42dde57da2832ba84b50f9ae0637069a9770aa8e9fb65195141fb5145a5841527012aea6115a07015d3f24f1ab8fdcb9f0e76c3c760ef0b98f5e786db0fa9e0c.png

File name

header Parameters

Accept

string

Value: "image/*,application/pdf"

Responses

Response samples

405

Content type

application/json

{"error": "USERNAME",
"message": "NullPointerException",
"data": {"property1": { },
"property2": { }
},
"trace": "string",
"timestamp": "2023-03-10T14:10:15.987"
}

Air Doctor (v2.0)

Account Management

Creates or updates the user and returns user's access token

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Updates user details, returning minimum information (fast call)

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Requests a reset password email (the email is sent automatically and immediately by the system)

query Parameters

Responses

Response samples

Adds or updates a person under the policy or for the user outside of policy

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Invalidates the token (effectively - log out)

header Parameters

Responses

Response samples

Deletes the specified user from Air-Doctor database

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Checks whether a user with the specified email is already registered

query Parameters

Responses

Response samples

Downloads all the data, stored by Air-Doctor about the user (as a single ZIP file)

header Parameters

Responses

Response samples

User's Insurance

Requests an addition of a policy to the user's account

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Requests policy removal from the user's account

path Parameters

header Parameters

Responses

Response samples

Requests an addition of a policy to the user's account (fast call, not returning updated user)

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request contact (callback) from insurance company (for supporting companies)

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Promo code Management

Checks if a provided promo code is valid for a specific location and patient

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Policies Management

Wildcard query of insurance policies (insurance carrier use only; returns up to 1000 records)

query Parameters

header Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required