{"components":{"schemas":{"AbnormalFlagEnum":{"enum":["Abnormal","Abnormal (applies to non-numeric results)","Above high normal","Alert high","Alert low","Below low normal","Beta-lactamase Pos (B-lactamase antibiotic resistant).","Better-use when direction not relevant","Critical","Critical abnormal","Intermediate result","Intermediate. Indicates for microbiology susceptibilities only.","Moderately susceptible. Indicates for microbiology susceptibilities only.","Negative","Negative result","Normal (applies to non-numeric results)","Not Applicable","Panic high","Panic low","Positive result","Resistant. Indicates for microbiology susceptibilities only.","Significant change down","Significant change up","Susceptible. Indicates for microbiology susceptibilities only.","Very High","Very susceptible. Indicates for microbiology susceptibilities only.","Worse-use when direction not relevant"],"type":"string"},"AccountTypeEnum":{"description":"* `regular` - Regular staff\n* `oncall` - On call (not paid)\n* `ft_non_prescribing` - Full-Time Non-Prescribing\n* `pt_prescribing` - Limited Use","enum":["regular","oncall","ft_non_prescribing","pt_prescribing"],"type":"string"},"Actor":{"properties":{"name":{"type":"string"},"type":{"readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":["integer","null"]}},"required":["name"],"type":"object"},"AddSignaturesToNote":{"properties":{"id":{"readOnly":true,"type":"integer"},"signatures":{"allOf":[{"$ref":"#/components/schemas/VisitNoteSignatureList"}],"description":"Requires special co-signature permissions. If enabled, users can add co-signatures to the visit note by providing them in this field."},"signed_by":{"description":"The user id of the provider who signed the visit note. (Requires special permission).","format":"int64","type":["integer","null"]},"signed_date":{"description":"The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).","format":"date-time","type":["string","null"]}},"type":"object"},"Address":{"properties":{"address_line1":{"maxLength":200,"type":"string"},"address_line2":{"maxLength":35,"type":["string","null"]},"city":{"maxLength":50,"type":"string"},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"AllergyStatus":{"enum":["Active","Inactive"],"type":"string"},"AmendmentRequest":{"properties":{"amendment_source":{"$ref":"#/components/schemas/AmendmentSourceEnum"},"request_date":{"format":"date-time","type":["string","null"]},"request_description":{"type":"string"},"status":{"$ref":"#/components/schemas/AmendmentRequestStatusEnum"},"status_updated_date":{"format":"date-time","type":["string","null"]}},"required":["amendment_source","request_description","status"],"type":"object"},"AmendmentRequestStatusEnum":{"enum":["accepted","denied"],"type":"string"},"AmendmentSourceEnum":{"enum":["Patient","Provider or Organization"],"type":"string"},"AncillaryCompany":{"properties":{"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":200,"type":"string"}},"required":["name"],"type":"object"},"Appointment":{"properties":{"appointment_type_id":{"description":"The ID of an existing appointment type to assign to the appointment. Provide this instead of 'reason' to reference a specific appointment type rather than matching or creating one by name. If both 'reason' and 'appointment_type_id' are supplied, 'reason' takes precedence.","format":"int64","type":["integer","null"]},"billing_details":{"description":"The billing details for the appointment.","oneOf":[{"$ref":"#/components/schemas/AppointmentBillingDetails"},{"type":"null"}]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"type":["string","null"]},"duration":{"description":"The duration of the appointment in minutes. If duration is not provided, the default duration will be used given a reason.","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"instructions":{"type":["string","null"]},"is_blocking":{"readOnly":true,"type":"boolean"},"last_modified_date":{"format":"date-time","readOnly":true,"type":"string"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"mode":{"$ref":"#/components/schemas/ModeEnum"},"patient":{"format":"int64","type":["integer","null"]},"payment":{"oneOf":[{"$ref":"#/components/schemas/Payment"},{"type":"null"}]},"physician":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"reason":{"maxLength":50,"type":["string","null"]},"recurring_event_schedule":{"format":"int64","type":["integer","null"]},"scheduled_date":{"format":"date-time","type":"string"},"service_location":{"description":"The ID of the service location where the appointment will occur.","properties":{"address_line1":{"nullable":true,"type":"string"},"address_line2":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"created_date":{"format":"date-time","nullable":true,"type":"string"},"deleted_date":{"format":"date-time","nullable":true,"type":"string"},"id":{"format":"int64","type":"integer"},"is_primary":{"type":"boolean"},"name":{"type":"string"},"phone":{"nullable":true,"type":"string"},"place_of_service":{"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,31,32,33,34,41,42,49,50,51,52,53,54,55,56,57,60,61,62,65,66,71,72,81,99],"nullable":true,"type":"integer"},"state":{"nullable":true,"type":"string"},"zip":{"nullable":true,"type":"string"}},"type":["object","integer","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/AppointmentStatus"},{"type":"null"}]},"telehealth_details":{"deprecated":true,"type":["string","null"]},"time_slot_status":{"oneOf":[{"$ref":"#/components/schemas/TimeSlotStatusEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"time_slot_type":{"$ref":"#/components/schemas/TimeSlotTypeEnum"},"transportation_details":{"description":"The transportation details for the appointment.","oneOf":[{"$ref":"#/components/schemas/TransportationDetails"},{"type":"null"}]}},"required":["patient","physician","practice","scheduled_date"],"type":"object"},"AppointmentBillingDetails":{"properties":{"billing_note":{"type":["string","null"]},"prior_authorization":{"maxLength":50,"type":["string","null"]},"referring_provider":{"maxLength":100,"type":["string","null"]},"referring_provider_state":{"maxLength":2,"type":["string","null"]}},"type":"object"},"AppointmentStatus":{"properties":{"room":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/AppointmentStatusStatusEnum"},"status_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"status_detail":{"type":["string","null"]}},"required":["status"],"type":"object"},"AppointmentStatusStatusEnum":{"enum":["Billed","Cancelled","Checked In","Checked Out","Confirmed","In Room","In Room - Vitals Taken","Not Seen","Scheduled","With Doctor"],"type":"string"},"AppointmentType":{"properties":{"abbreviation":{"type":"string"},"color":{"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"default_duration":{"type":"integer"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"type":"string"},"elation_note_template_ids":{"items":{"type":"integer"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_telehealth":{"type":"boolean"},"name":{"type":"string"},"patient_bookable":{"type":"boolean"},"patient_form_hours_prior":{"type":"integer"},"patient_forms":{"items":{"type":"integer"},"type":"array"},"practice":{"format":"int64","type":"integer"},"sequence":{"readOnly":true,"type":"integer"},"visit_note_format":{"oneOf":[{"$ref":"#/components/schemas/VisitNoteFormatEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"visit_note_templates":{"items":{"format":"int64","type":"integer"},"type":"array"},"visit_note_type":{"format":"int64","type":["integer","null"]}},"required":["default_duration","name","practice"],"type":"object"},"AscvdEligibility":{"description":"Response schema for the ASCVD (G0537) eligibility endpoint (docs only).","properties":{"criteria":{"items":{"$ref":"#/components/schemas/AscvdEligibilityCriterion"},"type":"array"},"eligible":{"type":"boolean"},"supporting_dx":{"items":{"type":"string"},"type":"array"}},"required":["criteria","eligible","supporting_dx"],"type":"object"},"AscvdEligibilityCriterion":{"properties":{"detail":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"met":{"type":"boolean"}},"required":["detail","key","label","met"],"type":"object"},"AttachmentTypeEnum":{"description":"* `Entity` - Entity\n* `RefPanel` - RefPanel\n* `PatientDemog` - PatientDemog\n* `ImmHistory` - ImmHistory\n* `MedsList` - MedsList\n* `CompMedsList` - CompMedsList\n* `WhoHeightChart` - WhoHeightChart\n* `WhoWeightChart` - WhoWeightChart\n* `WhoHcChart` - WhoHcChart\n* `WhoWflChart` - WhoWflChart\n* `CdcHeightChart` - CdcHeightChart\n* `CdcWeightChart` - CdcWeightChart\n* `CdcBmiChart` - CdcBmiChart\n* `CdcHcChart` - CdcHcChart\n* `PremieHeightChart` - PremieHeightChart\n* `PremieWeightChart` - PremieWeightChart\n* `PremieHcChart` - PremieHcChart\n* `DsinfantHeightChart` - DsinfantHeightChart\n* `DsinfantWeightChart` - DsinfantWeightChart\n* `DsinfantHcChart` - DsinfantHcChart\n* `DsHeightChart` - DsHeightChart\n* `DsWeightChart` - DsWeightChart\n* `DsBmiChart` - DsBmiChart\n* `DsHcChart` - DsHcChart","enum":["Entity","RefPanel","PatientDemog","ImmHistory","MedsList","CompMedsList","WhoHeightChart","WhoWeightChart","WhoHcChart","WhoWflChart","CdcHeightChart","CdcWeightChart","CdcBmiChart","CdcHcChart","PremieHeightChart","PremieWeightChart","PremieHcChart","DsinfantHeightChart","DsinfantWeightChart","DsinfantHcChart","DsHeightChart","DsWeightChart","DsBmiChart","DsHcChart"],"type":"string"},"AuthorizationForEnum":{"enum":["Consult (One Visit Only)","Procedure / Testing Only","Referral For Treatment, includes Consult Visit"],"type":"string"},"BiDiLabConnection":{"properties":{"alias":{"description":"Get the alias of the connection.","readOnly":true,"type":["string","null"]},"enabled":{"description":"Get the enabled status of the connection.","readOnly":true,"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"priority":{"maximum":65535,"minimum":0,"type":"integer"},"protocol":{"description":"Get the protocol of the connection.","readOnly":true,"type":["string","null"]}},"type":"object"},"Bill":{"properties":{"billing_date":{"description":"The date the bill was billed.","format":"date-time","type":"string"},"billing_error":{"maxLength":200,"type":"string"},"billing_provider":{"format":"int64","readOnly":true,"type":"integer"},"billing_raw_error":{"type":"string"},"billing_status":{"allOf":[{"$ref":"#/components/schemas/BillingStatusEnum"}],"readOnly":true},"cpts":{"description":"CPT objects for the bill.","items":{"$ref":"#/components/schemas/ListCPT"},"readOnly":true,"type":"array"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deferred_bill":{"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"last_modified_date":{"format":"date-time","readOnly":true,"type":"string"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"notes":{"description":"Additional billing notes.","type":["string","null"]},"ordering_provider":{"allOf":[{"$ref":"#/components/schemas/ReferringProvider"}],"readOnly":true},"patient":{"format":"int64","readOnly":true,"type":"integer"},"payment":{"allOf":[{"$ref":"#/components/schemas/Payment"}],"description":"Patient payment for the bill.","readOnly":true},"physician":{"format":"int64","readOnly":true,"type":"integer"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"prior_authorization":{"maxLength":50,"type":["string","null"]},"ref_number":{"maxLength":50,"type":["string","null"]},"referring_provider":{"allOf":[{"$ref":"#/components/schemas/ReferringProvider"}],"readOnly":true},"rendering_provider":{"format":"int64","readOnly":true,"type":"integer"},"service_date":{"format":"date-time","readOnly":true,"type":"string"},"service_date_timezone":{"description":"The timezone for the service_date. Use this to convert service_date from UTC to local time. Returns the service location's timezone if available, otherwise falls back to the practice's default timezone.","readOnly":true,"type":"string"},"service_location":{"properties":{"address_line1":{"description":"The service location address.","type":"string"},"address_line2":{"description":"The service location suite.","type":"string"},"city":{"default":"","maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"email":{"format":"email","maxLength":254,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_primary":{"default":false,"type":"boolean"},"name":{"maxLength":200,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"place_of_service":{"enum":["Ambulance - Air or Water","Ambulance - Land","Ambulatory Surgical Center","Assisted Living Facility","Birthing Center","Community Mental Health Center","Comprehensive Inpatient Rehabilitation Facility","Comprehensive Outpatient Rehabilitation Facility","Custodial Care Facility","Emergency Room - Hospital","End-Stage Renal Disease Treatment Facility","Federally Qualified Health Center","Group Home","Home","Homeless Shelter","Hospice","Independent Clinic","Independent Laboratory","Indian Health ServiceFree-standing Facility","Indian Health ServiceProvider-based Facility","Inpatient Hospital","Inpatient Psychiatric Facility","Intermediate Care Facility/Individuals with Intellectual Disabilities","Mass Immunization Center","Military Treatment Facility","Mobile Unit","Non-residential Substance Abuse Treatment Facility","Nursing Facility","Off Campus Outpatient-Hospital","Office","On Campus-Outpatient Hospital","Other Place of Service","Outreach Site/Street","Pharmacy","Place of Employment-Worksite","Prison/Correctional Facility","Programs of All-Inclusive Care for the Elderly (PACE) Center","Psychiatric Facility-Partial Hospitalization","Psychiatric Residential Treatment Center","Public Health Clinic","Residential Substance Abuse Treatment Facility","Rural Health Clinic","School","Skilled Nursing Facility","Telehealth Provided Other than in Patient’s Home","Telehealth Provided in Patient’s Home","Temporary Lodging","Tribal 638Free-standingFacility","Tribal 638Provider-basedFacility","Urgent Care Facility","Walk-in Retail Health Clinic"],"type":"string"},"place_of_service_code":{"type":"integer"},"practice":{"description":"The id of the practice that the service location belongs to.","format":"int64","type":"integer"},"state":{"type":"string"},"status":{"default":"active","enum":["active","inactive","suspended"],"readOnly":true,"type":"string"},"timezone":{"description":"* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/Perth` - Australia/Perth\n* `Australia/Sydney` - Australia/Sydney\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `US/Alaska` - US/Alaska\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `UTC` - UTC","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Inuvik","America/Iqaluit","America/Jamaica","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Riyadh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","GMT","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Wake","Pacific/Wallis","US/Alaska","US/Arizona","US/Central","US/Eastern","US/Hawaii","US/Mountain","US/Pacific","UTC","",null],"type":["string","null"]},"zip":{"default":"","maxLength":10,"type":"string"}},"required":["address_line1","name","practice","state"],"type":"object"},"supervising_provider":{"format":"int64","readOnly":true,"type":"integer"},"visit_note_deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"visit_note_id":{"readOnly":true,"type":"integer"},"visit_note_signed_date":{"format":"date-time","readOnly":true,"type":"string"}},"required":["billing_date","billing_error","billing_raw_error"],"type":"object"},"BillSingleInstance":{"properties":{"billing_provider":{"format":"int64","type":["integer","null"]},"cpts":{"items":{"$ref":"#/components/schemas/CPT"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"notes":{"default":"","description":"Additional billing notes.","maxLength":1000,"type":"string"},"ordering_provider":{"allOf":[{"$ref":"#/components/schemas/ReferringProvider"}],"description":"The id of the provider who orders non-physician services for the patient."},"patient":{"format":"int64","type":"integer"},"payment":{"format":"int64","type":"integer"},"payment_amount":{"default":"0.00","description":"Dollar amount of the patient payment.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"physician":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"prior_authorization":{"maxLength":50,"type":["string","null"]},"referring_provider":{"$ref":"#/components/schemas/ReferringProvider"},"rendering_provider":{"format":"int64","type":["integer","null"]},"service_location":{"description":"The id of the service location the bill is associated with.","format":"int64","type":"integer"},"show_dual_coding":{"default":false,"type":["boolean","null"]},"supervising_provider":{"description":"The id of the provider who has undertaken primary responsibility for the patient's health.","format":"int64","type":["integer","null"]},"visit_note":{"format":"int64","type":"integer"}},"required":["cpts","patient","physician","practice","service_location","visit_note"],"type":"object"},"BillTypeEnum":{"description":"* `thirdparty` - Third Party (e.g. Insurance)\n* `patient` - Patient\n* `client` - Client\n* `workerscomp` - Worker's Comp\n* `specialbilling` - Special Billing","enum":["thirdparty","patient","client","workerscomp","specialbilling"],"type":"string"},"BillUpdate":{"properties":{"billing_date":{"description":"The date the bill was billed. Required if marking a bill as processed.","format":"date-time","type":["string","null"]},"billing_error":{"description":"The error message for the bill. Required if marking a bill as failed. This is the human readable error that users will see.","maxLength":200,"type":["string","null"]},"billing_provider":{"format":"int64","type":["integer","null"]},"billing_raw_error":{"description":"Further details on the billing error. Optional when marking a bill as failed. Useful when debugging why a bill failed to process.","type":["string","null"]},"cpts":{"description":"CPT objects for the bill.","items":{"$ref":"#/components/schemas/CPT"},"type":"array"},"metadata":{"additionalProperties":{},"type":"object"},"notes":{"description":"Additional billing notes.","maxLength":1000,"type":["string","null"]},"ordering_provider":{"description":"The id of the provider who orders non-physician services for the patient.","oneOf":[{"$ref":"#/components/schemas/ReferringProvider"},{"type":"null"}]},"payment_amount":{"description":"Dollar amount of the patient payment.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"place_of_service":{"oneOf":[{"$ref":"#/components/schemas/BillUpdatePlaceOfServiceEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"practice":{"format":"int64","type":"integer"},"prior_authorization":{"maxLength":50,"type":["string","null"]},"ref_number":{"description":"The reference number of the bill. Required if marking a bill as processed.","type":"string"},"referring_provider":{"oneOf":[{"$ref":"#/components/schemas/ReferringProvider"},{"type":"null"}]},"rendering_provider":{"format":"int64","type":["integer","null"]},"service_location":{"description":"The id of the service location the bill is associated with.","format":"int64","type":"integer"},"supervising_provider":{"description":"The id of the provider who has undertaken primary responsibility for the patient's health.","format":"int64","type":["integer","null"]},"visit_note":{"format":"int64","type":"integer"}},"type":"object"},"BillUpdatePlaceOfServiceEnum":{"enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","31","32","33","34","41","42","49","50","51","52","53","54","55","56","57","60","61","62","65","66","71","72","81","99"],"type":"string"},"BillingStatusEnum":{"enum":["Unbilled","Billed","UnresolvedError","ResolvedError"],"type":"string"},"BlankEnum":{"enum":[""]},"BodySite":{"properties":{"code":{"description":"The HL7 code representing the body site from which a specimen was collected.","maxLength":16,"type":"string"},"deleted_date":{"description":"Represents if the body site was removed from the specimen.","format":"date-time","readOnly":true,"type":["string","null"]},"text":{"description":"A textual description of the body site from which the specimen was collected.","maxLength":64,"type":"string"}},"required":["code","text"],"type":"object"},"BodySiteCodeModifier":{"properties":{"code":{"description":"The HL7 code representing the modifier on the body site from which a specimen was collected.","maxLength":3,"type":"string"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"text":{"description":"A textual description of the modifier of the body site from which the specimen was collected.","maxLength":64,"type":"string"}},"required":["code","text"],"type":"object"},"BulletWithMeta":{"properties":{"author":{"description":"The author of the bullet.","type":"integer"},"category":{"allOf":[{"$ref":"#/components/schemas/CategoryEnum"}],"description":"The category of the bullet."},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"edit":{"format":"int64","type":["integer","null"]},"note_document":{"description":"A document referenced by the bullet.","oneOf":[{"$ref":"#/components/schemas/VisitNoteDocument"},{"type":"null"}]},"replaced_by":{"format":"int64","type":["integer","null"]},"replaced_by_edit":{"format":"int64","type":["integer","null"]},"sequence":{"description":"The sequence number of the bullet.","minimum":0,"type":"integer"},"text":{"description":"The text of the bullet.","type":"string"},"updated_date":{"format":"date-time","type":["string","null"]},"version":{"maximum":65535,"minimum":0,"type":"integer"}},"required":["category","text"],"type":"object"},"CCDA":{"properties":{"base64_ccda":{"format":"binary","readOnly":true,"type":"string"},"id":{"format":"int64","type":"integer"}},"required":["id"],"type":"object"},"CPT":{"properties":{"cpt":{"type":"string"},"dxs":{"items":{"$ref":"#/components/schemas/DX"},"type":"array"},"modifier_1":{"maxLength":2,"type":["string","null"]},"modifier_2":{"maxLength":2,"type":["string","null"]},"modifier_3":{"maxLength":2,"type":["string","null"]},"modifier_4":{"maxLength":2,"type":["string","null"]},"ndc":{"maxLength":11,"type":["string","null"]},"ndc_dose":{"format":"decimal","pattern":"^-?\\d{0,7}(?:\\.\\d{0,3})?$","type":["string","null"]},"ndc_measure":{"oneOf":[{"$ref":"#/components/schemas/NdcMeasureEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"unit_charge":{"type":"string"},"units":{"type":"string"}},"required":["cpt","dxs","unit_charge","units"],"type":"object"},"CPTCode":{"properties":{"charge":{"description":"The amount of money that will be charged for the code.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"code":{"description":"The code that a user and integrators will see.","maxLength":10,"type":"string"},"description":{"description":"The description of the code that users will see.","maxLength":200,"type":"string"},"id":{"description":"The internal elation id of the billing code.","readOnly":true,"type":"integer"},"practice":{"description":"The practice who created the billing code.","format":"int64","type":"integer"},"sequence":{"description":"The position in the list of billing codes.","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["code","description","practice"],"type":"object"},"CardiacCenter":{"properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"maxLength":50,"type":"string"},"company":{"description":"Maps to the Ancillary Company object ID attribute.","format":"int64","type":"integer"},"company_name":{"description":"Maps to the Ancillary Company object name attribute.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"location_name":{"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"required":["address_line1","address_line2","company","company_name","location_name","practice"],"type":"object"},"CardiacOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"cardiac_center":{"description":"The cardiac center the order is associated with.","format":"int64","type":["integer","null"]},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"medications":{"description":"Description of beta blockers/medications the patient is taking.","maxLength":400,"type":["string","null"]},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of cardiac tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/CardiacOrderTest"}]},"type":"array"}},"required":["ancillary_company","chart_date","clinical_reason","document_date","patient","practice","prescribing_user","tests"],"type":"object"},"CardiacOrderTest":{"properties":{"code":{"maxLength":50,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":255,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["name","practice"],"type":"object"},"CategoryEnum":{"enum":["Allergies","Assessment","Assessplan","Attending","Consultant","Data","Dateprocedure","ElationNoteColOne","ElationNoteColTwo","ElationNoteCustomBlock","ElationNoteOtherData","Family","Followup","Habits","Hpi","Instr","Med","Narrative","Objective","Orders","PE","Past","Plan","Problem","Procedure","ROS","Reason","Referenced","Social","Surgical","Test","Tx"],"type":"string"},"CodeTypeEnum":{"enum":["CPT","CPTII","CVX","EL8","HCPCS","HL7","ICD10","ICD9","LOINC","RXNORM","SNOMED"],"type":"string"},"CodedDocumentTag":{"properties":{"code":{"description":"The code of the tag.","maxLength":50,"type":["string","null"]},"code_type":{"description":"The type of the tag's code.","oneOf":[{"$ref":"#/components/schemas/CodeTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"concept_name":{"description":"The name of the tag's concept.","oneOf":[{"$ref":"#/components/schemas/ConceptNameEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"context":{"description":"The context of the tag. Choices = rejected, ordered or reviewed.","maxLength":15,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"maxLength":500,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"practice_created":{"description":"The id of the tag's practice.","format":"int64","type":["integer","null"]},"snomed_result_code":{"readOnly":true,"type":["string","null"]},"value":{"maxLength":100,"type":"string"}},"required":["value"],"type":"object"},"Comment":{"properties":{"author":{"description":"Elation ID of the physician or staff member to attribute this comment to.","format":"int64","type":"integer","writeOnly":true},"create_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"letter":{"format":"int64","readOnly":true,"type":"integer"},"message":{"default":"","type":"string"},"practice":{"format":"int64","readOnly":true,"type":"integer"}},"required":["author"],"type":"object"},"ConceptNameEnum":{"enum":["cognitive-assessment","depression-screening-adolescent-declined","depression-screening-adult-declined","diet-counsel","dietic-service-referral","dietician-referral","exercise-counsel","falls-assessment","flu-vaccine-contraindicated","flu-vaccine-declined","flu-vaccine-elsewhere","flu-vaccine-referred","hospice-care","hpv-test","nutrition-counsel","pap-smear","phys-activity-counsel","procedure-contraindicated","tobacco-counsel-long","tobacco-counsel-short","unable-to-walk","wt-mgmt-referral"],"type":"string"},"Consent":{"description":"This is the serializer for PatientConsent. It's all read-only","properties":{"application":{"readOnly":true,"type":"string"},"consented":{"readOnly":true,"type":"boolean"},"is_active":{"readOnly":true,"type":"boolean"},"last_modified_date":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"Contact":{"properties":{"accepting_insurance":{"description":"Whether the contact indicates they accept insurance.","type":["boolean","null"]},"accepting_new_patients":{"description":"Whether the contact indicates they are accepting new patients.","type":["boolean","null"]},"address":{"description":"The specific address line registered for this contact.","maxLength":200,"type":"string"},"back_office_phone":{"maxLength":20,"type":"string"},"cell_phone":{"description":"The mobile phone registered to the contact.","maxLength":20,"type":"string"},"city":{"description":"The city of the contact.","maxLength":50,"type":"string"},"contact_type":{"description":"The type of contact. {physician, medical_group}","maxLength":15,"type":"string"},"created_date":{"description":"The timestamp when the contact was created.","format":"date-time","readOnly":true,"type":["string","null"]},"credentials":{"description":"The credentials for the provider, e.g. MD or DO. Ignored if contact is a medical_group.","maxLength":200,"type":"string"},"deleted_date":{"description":"The timestamp when the contact was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"direct_address":{"maxLength":500,"type":"string"},"email":{"type":"string"},"fax":{"maxLength":15,"type":"string"},"first_name":{"description":"The first name of the contact. Ignored if contact is a medical_group.","maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_elation_confirmed":{"description":"Whether the contact has been verified by someone on the elation team to be available for search within the application. Will always be false for any contact created within a practice.","type":["boolean","null"]},"is_verified":{"description":"Whether the contact has been verified to be a available for search within the application. Will always be true for any contact created by a practice.","type":["boolean","null"]},"last_name":{"description":"The last name of the contact. Ignored if contact is a medical_group.","maxLength":60,"type":"string"},"middle_name":{"description":"The middle name of the contact. Ignored if contact is a medical_group.","maxLength":50,"type":"string"},"npi":{"type":"string"},"org_name":{"maxLength":100,"type":["string","null"]},"other_specialties":{"description":"The list of specialties after the primary specialty related to this contact.","items":{"allOf":[{"$ref":"#/components/schemas/MedicalSpecialty"}]},"type":"array"},"phone":{"maxLength":20,"type":"string"},"practice":{"description":"The id of the practice that the contact belongs to.","format":"int64","type":"integer"},"specialty":{"allOf":[{"$ref":"#/components/schemas/MedicalSpecialty"}],"description":"The id of the specialty of the contact."},"specialty_categories":{"items":{},"type":"array"},"state":{"description":"The state of the contact.","maxLength":2,"type":"string"},"suite":{"maxLength":20,"type":"string"},"user":{"description":"The user id of the contact.","readOnly":true,"type":"integer"},"zip":{"maxLength":10,"type":"string"}},"required":["contact_type","credentials","first_name","last_name","middle_name","practice"],"type":"object"},"ContactsSearchResult":{"description":"Serializer used to work with contacts found via elasticsearch","properties":{"accepting_insurance":{"type":["boolean","null"]},"accepting_new_patients":{"type":["boolean","null"]},"address_line":{"maxLength":100,"type":"string"},"city":{"maxLength":30,"type":"string"},"contact_type":{"maxLength":15,"type":"string"},"direct_address":{"maxLength":500,"type":"string"},"fax":{"maxLength":15,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_elation_confirmed":{"type":["boolean","null"]},"is_verified":{"type":["boolean","null"]},"name":{"maxLength":200,"type":"string"},"npi":{"type":"string"},"phone":{"maxLength":25,"type":"string"},"specialties":{"items":{},"type":"array"},"specialty_categories":{"items":{},"type":"array"},"state":{"maxLength":20,"type":"string"}},"required":["name"],"type":"object"},"Content":{"description":"The Content serializer. It serialize file data","properties":{"base64_content":{"type":"string"},"content_type":{"readOnly":true,"type":"string"},"original_filename":{"maxLength":200,"type":"string"}},"required":["base64_content","original_filename"],"type":"object"},"ContentSerializerNoBase64Content":{"description":"The Content serializer. It serialize file data without base64_content","properties":{"content_type":{"type":"string"},"original_filename":{"type":"string"}},"required":["content_type","original_filename"],"type":"object"},"CreateInsuranceCard":{"properties":{"image":{"allOf":[{"$ref":"#/components/schemas/ImageContent"}],"description":"Base64 encoded image of the insurance card. Only JPG and PNG files are supported."},"rank":{"description":"Primary or secondary insurances (1 or 2).","type":"integer"},"side":{"description":"Insurance card side. Usually front (1) or back (2).","type":"integer"}},"required":["image","rank","side"],"type":"object"},"CreateInsuranceEligibility":{"properties":{"group_id":{"description":"ID that matches the group record in Elation system","type":"integer"},"group_name":{"description":"Name of the group / organization. group_npi field is required if this is populated.","type":"string"},"group_npi":{"description":"NPI of the group / organization. group_name field is required if this is populated.","type":"string"}},"type":"object"},"CreatePaymentLink":{"properties":{"legal_entity_id":{"type":["integer","null"]},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"practice_stripe_account_id":{"type":["integer","null"]},"reasons":{"items":{"type":"string"},"readOnly":true,"type":"array"},"total_amount_usd":{"format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$","type":"string"}},"required":["patient","practice","total_amount_usd"],"type":"object"},"DX":{"properties":{"icd10_code":{"type":"string"},"icd9_codes":{"items":{"type":"string"},"type":"array"}},"required":["icd10_code"],"type":"object"},"DataFormatEnum":{"enum":["ccda","ccr","qrda_1"],"type":"string"},"DataImportRequest":{"description":"Used with resources that are accessed through a public API application.","properties":{"id":{"readOnly":true,"type":"integer"},"notes":{"type":["string","null"]},"physician_id":{"format":"int64","type":"integer"},"practice_id":{"format":"int64","type":"integer"},"time_created":{"format":"date-time","readOnly":true,"type":"string"}},"required":["physician_id","practice_id"],"type":"object"},"DataImportRequestDetail":{"description":"Main difference vs list is we don't want users changing the below fields after\ncreation and we want to show the import status","properties":{"id":{"readOnly":true,"type":"integer"},"notes":{"type":["string","null"]},"physician_id":{"format":"int64","readOnly":true,"type":"integer"},"practice_id":{"format":"int64","readOnly":true,"type":"integer"},"status":{"items":{"additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"}]},"type":"object"},"readOnly":true,"type":"array"},"time_created":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"DelegatePermission":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delegate_user":{"type":"integer"},"id":{"readOnly":true,"type":"integer"},"permission_type":{"$ref":"#/components/schemas/PermissionTypeEnum"},"physician":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"}},"required":["delegate_user","permission_type","physician","practice"],"type":"object"},"DeliveryMethodEnum":{"enum":["direct","email","emr","fax","passport","printed"],"type":"string"},"DiagnosisCode":{"properties":{"code":{"maxLength":50,"type":"string"},"system":{"type":"string"}},"required":["code","system"],"type":"object"},"DiscontinueMedOrder":{"properties":{"chart_date":{"description":"The timestamp at which this discontinue was available in the patient's chart","format":"date-time","type":"string"},"created_date":{"description":"The timestamp at which this discontinue was created in our database.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The timestamp at which the discontinue was marked as deleted, usually occurs when a user wants to 'undiscontinue' the medication.","format":"date-time","readOnly":true,"type":["string","null"]},"discontinue_date":{"description":"The date when the medication was discontinued.","format":"date","type":"string"},"document_date":{"description":"The timestamp at which we've documented this discontinue occurred.","format":"date-time","type":"string"},"documenting_personnel":{"description":"The user who documented this discontinue.","format":"int64","type":"integer"},"id":{"description":"The id of the discontinue medication.","readOnly":true,"type":"integer"},"is_documented":{"type":"boolean"},"last_medication_order":{"description":"The id of the last medication ordered before we discontinued this thread of med orders.","readOnly":true,"type":["integer","null"]},"med_order":{"description":"The id of the medication which we discontinued.","format":"int64","type":"integer"},"medication":{"allOf":[{"$ref":"#/components/schemas/Medication"}],"description":"The medication that was discontinued."},"patient":{"description":"The id of the patient chart.","format":"int64","type":"integer"},"practice":{"description":"The id of the practice.","format":"int64","type":"integer"},"prescribing_physician":{"description":"The id of the physician who prescribed the medication.","format":"int64","type":"integer"},"reason":{"description":"The discontinue reason.","type":["string","null"]},"signed_by":{"format":"int64","readOnly":true,"type":"integer"},"signed_date":{"description":"The timestamp at which a user signed off on the discontinue.","format":"date-time","type":["string","null"]},"supervising_physician":{"description":"If the prescribing physician requires supervision, this will reference the physician who is in that role.","format":"int64","type":["integer","null"]},"thread":{"format":"int64","type":"integer"}},"required":["med_order"],"type":"object"},"Document":{"properties":{"authoring_practice":{"format":"int64","type":"integer"},"chart_date":{"description":"The creation date of the patient chart.","format":"date-time","type":"string"},"created_date":{"description":"The creation date of the document.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The deleted date of the document.","format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"The date of the document. In most cases it's the same as the creation date. For some documents, like visit notes, it's the date of the visit note.","format":"date-time","type":"string"},"document_type":{"readOnly":true,"type":["integer","null"]},"id":{"format":"int64","type":"integer"},"last_modified":{"format":"date-time","type":"string"},"patient":{"format":"int64","type":"integer"},"sign_date":{"description":"The date of when the document was signed (if signed).","format":"date-time","readOnly":true,"type":["string","null"]},"signed_by":{"description":"The id of whoever signed the document (if signed).","readOnly":true,"type":"integer"}},"required":["authoring_practice","chart_date","document_date","id","patient"],"type":"object"},"DocumentResolutionState":{"properties":{"created_date":{"description":"The datetime when this resolution state was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.","format":"date-time","readOnly":true,"type":["string","null"]},"document":{"description":"Will be the same as the id of the lab order.","format":"int64","readOnly":true,"type":"integer"},"id":{"description":"Internal id to represent the resolution state.","readOnly":true,"type":"integer"},"note":{"description":"Any note that was added to represent why an order was cancelled.","maxLength":200,"type":["string","null"]},"resolving_document":{"description":"If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. Must be an integer ID or null.","format":"int64","type":["integer","null"]},"state":{"allOf":[{"$ref":"#/components/schemas/StateEnum"}],"description":"The resolution state of the order.\n\n* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled"}},"required":["state"],"type":"object"},"DoseUnitEnum":{"description":"* `dL` - Deciliter\n* `g` - Gram\n* `kg` - Kilogram\n* `kL` - Kiloliter\n* `L` - Liter\n* `mCi` - Millicurie\n* `mg` - Milligram\n* `mL` - Milliliter\n* `ug` - Microgram\n* `uL` - Microliter\n* `tab` - Tablet","enum":["dL","g","kg","kL","L","mCi","mg","mL","ug","uL","tab"],"type":"string"},"EligibilityAddress":{"properties":{"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"type":"object"},"EligibilityBenefits":{"properties":{"coinsurance":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"copay":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"deductible":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"limitations":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"out_of_pocket":{"items":{"additionalProperties":{},"type":"object"},"type":"array"}},"type":"object"},"EligibilityDetails":{"properties":{"coinsurance":{"description":"Coinsurance percentage value as a decimal (e.g. 0.25).","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":"string"},"coinsurance_ambiguous":{"type":"boolean"},"copay":{"description":"copayment amount in dollars.","format":"double","type":["number","null"]},"copay_ambiguous":{"description":"If true, the given copay value may not be accurate and the full eligibility report will need to be referenced for better details.","type":"boolean"},"deductible":{"description":"Deductible amount in dollars.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":"string"},"deductible_ambiguous":{"type":"boolean"},"deductible_remaining":{"description":"Remaining deductible amount in dollars.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":"string"},"deductible_remaining_ambiguous":{"type":"boolean"},"errors":{"description":"Error messages showing reason for failed eligibility check.","items":{"additionalProperties":{},"type":"object"},"type":"array"}},"type":"object"},"EligibilityPlanDetails":{"properties":{"carrier":{"type":"string"},"end_date":{"format":"date","type":["string","null"]},"group_name":{"type":"string"},"group_number":{"type":"string"},"insurance_type":{"type":["string","null"]},"member_id":{"type":"string"},"plan_name":{"type":"string"},"plan_number":{"type":"string"},"policy_name":{"type":["string","null"]},"policy_number":{"type":["string","null"]},"provider":{"$ref":"#/components/schemas/EligibilityProvider"},"start_date":{"format":"date","type":"string"}},"type":"object"},"EligibilityProvider":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"npi":{"type":"string"},"organization_name":{"type":"string"}},"type":"object"},"EligibilityStatusEnum":{"description":"* `active` - active\n* `inactive` - inactive\n* `error` - error","enum":["active","inactive","error"],"type":"string"},"EligibilitySubscriber":{"properties":{"address":{"$ref":"#/components/schemas/EligibilityAddress"},"first_name":{"type":"string"},"last_name":{"type":"string"},"member_id":{"type":"string"},"middle_name":{"type":"string"},"name":{"type":"string"},"sex_at_birth":{"type":"string"}},"type":"object"},"EligibilityUsage":{"properties":{"end_date":{"description":"End date of the usage period.","format":"date","type":"string"},"failed_checks":{"description":"Number of failed eligibility checks.","type":"integer"},"start_date":{"description":"Start date of the usage period.","format":"date","type":"string"},"successful_checks":{"description":"Number of successful eligibility checks.","type":"integer"},"total_checks":{"description":"Total number of eligibility checks performed.","type":"integer"}},"type":"object"},"Email":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"email":{"format":"email","maxLength":254,"type":["string","null"]}},"type":"object"},"EmergencyContact":{"properties":{"address_line1":{"maxLength":200,"type":["string","null"]},"address_line2":{"maxLength":35,"type":["string","null"]},"city":{"maxLength":50,"type":["string","null"]},"first_name":{"maxLength":70,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"last_name":{"maxLength":70,"type":["string","null"]},"phone":{"maxLength":20,"type":["string","null"]},"relationship":{"maxLength":30,"type":["string","null"]},"state":{"maxLength":2,"type":["string","null"]},"zip":{"maxLength":10,"type":["string","null"]}},"type":"object"},"Employer":{"properties":{"code":{"maxLength":50,"type":"string"},"description":{"readOnly":true,"type":["string","null"]},"name":{"readOnly":true,"type":["string","null"]}},"required":["code"],"type":"object"},"ErrorCodeEnum":{"enum":["Communication problem - try again later","Receiver System Error","Receiver unable to process","Transaction rejected"],"type":"string"},"ErrorDescriptionCodeEnum":{"enum":["Internal processing error has occurred.","Invalid password for receiver","Invalid password for sender.","No password on file for receiver.","No password on file for sender.","Receiver ID not on file.","Request timed out before response could be received.","Required segment UIB is missing.","Required segment UIH is missing.","Required segment UIT is missing.","Required segment UIZ is missing.","Sender ID not on file."],"type":"string"},"EthnicityEnum":{"enum":["Declined to specify","Hispanic or Latino","No ethnicity specified","Not Hispanic or Latino"],"type":"string"},"FacilityIdentifier":{"properties":{"active":{"description":"Whether the facility identifier should be used. Should be true in most cases.","type":"boolean"},"bidi_connection":{"oneOf":[{"$ref":"#/components/schemas/BiDiLabConnection"},{"type":"null"}],"readOnly":true},"compendium":{"description":"The id of the compendium that will be used when the user selects this facility identifier.","format":"int64","type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"description":"The text that will displayed to users in the lab order dialog.","maxLength":255,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_connection":{"type":["integer","null"]},"lab_facility":{"description":"The id that represents the lab.","maxLength":50,"type":"string"},"practice":{"format":"int64","type":"integer"},"practice_facility":{"description":"The id that represents the practice; often an account number provided by the lab vendor.","maxLength":50,"type":"string"},"practice_secondary_id":{"type":["string","null"]},"user_facing":{"description":"Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.","type":"boolean"},"vendor":{"properties":{"display_name":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"}},"type":"object"}},"required":["active","lab_facility","practice","practice_facility","vendor"],"type":"object"},"FastingMethodEnum":{"description":"* `fasting_12_hour` - Fasting - 12 hours\n* `fasting_8_hours` - Fasting - 8 hours\n* `fasting_2_hours` - Fasting - 2 hours\n* `fasting_none` - Non-Fasting\n* `fasting_random` - Fasting or non-fasting does not matter (Random)","enum":["fasting_12_hour","fasting_8_hours","fasting_2_hours","fasting_none","fasting_random"],"type":"string"},"File":{"properties":{"base64_content":{"type":"string","writeOnly":true},"content_type":{"maxLength":200,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"file_size":{"readOnly":true,"type":["integer","null"]},"file_url":{"readOnly":true,"type":"string"},"filename":{"type":"string"},"id":{"readOnly":true,"type":"integer"},"incoming_file":{"type":"integer"},"practice":{"format":"int64","type":["integer","null"]}},"required":["base64_content","content_type","filename"],"type":"object"},"FillStatusEnum":{"description":"* `AH` - Dispensed\n* `AJ` - PartiallyDispensed\n* `AK` - NotDispensed\n* `AL` - Transferred","enum":["AH","AJ","AK","AL"],"type":"string"},"Fulfillment":{"properties":{"detail":{"type":["string","null"]},"pharmacy_ncpdpid":{"maxLength":21,"type":["string","null"]},"service_location":{"$ref":"#/components/schemas/ServiceLocation"},"state":{"maxLength":128,"type":"string"},"time_completed":{"format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/FulfillmentTypeEnum"}},"required":["service_location","time_completed","type"],"type":"object"},"FulfillmentTypeEnum":{"description":"* `surescripts` - surescripts\n* `surescripts_cancel` - surescripts_cancel\n* `surescripts_change` - surescripts_change\n* `surescripts_nonfillable` - Surescripts-Nonfillable\n* `paper` - Paper\n* `paper_nonfillable` - Paper-Nonfillable\n* `fax` - Fax\n* `phone` - Phone\n* `mdtoolboxepcs` - MDToolbox EPCS","enum":["surescripts","surescripts_cancel","surescripts_change","surescripts_nonfillable","paper","paper_nonfillable","fax","phone","mdtoolboxepcs"],"type":"string"},"FundingSourceEnum":{"enum":["Privately funded vaccine stock","Publicly funded vaccine stock","Publicly funded vaccine stock - Non-VFC","Publicly funded vaccine stock - VFC"],"type":"string"},"GenderIdentityEnum":{"enum":["man","nonbinary","option_not_listed","prefer_not_to_say","transgender_man","transgender_woman","two_spirit","unknown","woman"],"type":"string"},"GroupEnum":{"description":"* `main` - main\n* `other` - other","enum":["main","other"],"type":"string"},"Guarantor":{"properties":{"address":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"email":{"format":"email","maxLength":254,"type":["string","null"]},"first_name":{"maxLength":105,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"last_name":{"maxLength":105,"type":["string","null"]},"phone":{"maxLength":20,"type":["string","null"]},"relationship":{"oneOf":[{"$ref":"#/components/schemas/InsurerRelationshipType"},{"$ref":"#/components/schemas/NullEnum"}]},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"Handout":{"description":"Contains only webhooks\nAll other fields inherited","properties":{"content":{"$ref":"#/components/schemas/Content"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"description":"The name of the handout.","maxLength":255,"type":"string"},"practice_created":{"format":"int64","type":"integer"},"received_date":{"format":"date-time","readOnly":true,"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/HandoutType"},"vis_barcode":{"description":"Should only be set if the type == VIS.","maxLength":30,"type":["string","null"]}},"required":["content","name","practice_created","type"],"type":"object"},"HandoutType":{"enum":["Patient Resource","VIS"],"type":"string"},"HandoutsSerializerNoBase64Content":{"description":"Handout serializer that returns content without base64_content","properties":{"content":{"$ref":"#/components/schemas/ContentSerializerNoBase64Content"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"description":"The name of the handout.","maxLength":255,"type":"string"},"practice_created":{"format":"int64","type":"integer"},"received_date":{"format":"date-time","readOnly":true,"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/HandoutType"},"vis_barcode":{"description":"Should only be set if the type == VIS.","maxLength":30,"type":["string","null"]}},"required":["content","name","practice_created","type"],"type":"object"},"ICD10Code":{"properties":{"code":{"maxLength":50,"type":"string"},"description":{"maxLength":500,"type":["string","null"]}},"required":["code"],"type":"object"},"Image":{"properties":{"base64_content":{"type":"string","writeOnly":true},"content_type":{"type":"string","writeOnly":true},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"file_size":{"readOnly":true,"type":["integer","null"]},"height":{"readOnly":true,"type":["integer","null"]},"id":{"readOnly":true,"type":"integer"},"image_url":{"readOnly":true,"type":"string"},"incoming_file":{"type":"integer"},"original_extension":{"maxLength":10,"type":"string"},"original_height":{"type":"integer"},"original_padded":{"type":"integer"},"original_rotation":{"type":"integer"},"original_width":{"type":"integer"},"practice":{"format":"int64","type":["integer","null"]},"quality_score":{"readOnly":true,"type":["integer","null"]},"quality_score_by":{"readOnly":true,"type":["integer","null"]},"received_date":{"format":"date-time","type":"string"},"rotation":{"readOnly":true,"type":"integer"},"sequence":{"readOnly":true,"type":["integer","null"]},"width":{"readOnly":true,"type":["integer","null"]}},"required":["base64_content","content_type"],"type":"object"},"ImageContent":{"properties":{"base64_content":{"type":"string"},"original_filename":{"type":"string"}},"required":["base64_content","original_filename"],"type":"object"},"ImagingCenter":{"properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"maxLength":50,"type":"string"},"company":{"description":"Maps to the Ancillary Company object ID attribute.","format":"int64","type":"integer"},"company_name":{"description":"Maps to the Ancillary Company object name attribute.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"location_name":{"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"required":["address_line1","address_line2","company","company_name","location_name","practice"],"type":"object"},"ImagingOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"imaging_center":{"description":"The imaging center the order is associated with.","format":"int64","type":["integer","null"]},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"statmethod":{"description":"The type of report to get for the order if urgent.","maxLength":100,"type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of imaging tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ImagingOrderTest"}]},"type":"array"}},"required":["ancillary_company","chart_date","clinical_reason","document_date","patient","practice","prescribing_user","tests"],"type":"object"},"ImagingOrderTest":{"properties":{"code":{"maxLength":50,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":255,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["name","practice"],"type":"object"},"ImmunizationVaccine":{"properties":{"cdc_name":{"readOnly":true,"type":["string","null"]},"cdc_type":{"readOnly":true,"type":["string","null"]},"cvx":{"maximum":2147483647,"minimum":-2147483648,"type":["integer","null"]},"name":{"readOnly":true,"type":"string"}},"type":"object"},"ImoCodeRelation":{"properties":{"icd10":{"items":{"type":"string"},"type":"array"},"icd9":{"items":{"type":"string"},"type":"array"},"snomed":{"type":"string"}},"type":"object"},"InactiveReasonEnum":{"description":"* `left_good_terms` - Patient Left on Good Terms\n* `left_bad_terms` - Patient Left on Bad Terms\n* `practice_ended` - Practice Ended Relationship\n* `other` - Other\n* `unknown` - Unknown","enum":["left_good_terms","left_bad_terms","practice_ended","other","unknown"],"type":"string"},"IncomingFileGroup":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"external_fax_id":{"type":["string","null"]},"file_size":{"readOnly":true,"type":["integer","null"]},"files":{"items":{"$ref":"#/components/schemas/File"},"type":["array","null"]},"from_number":{"readOnly":true,"type":["string","null"]},"group_name":{"maxLength":200,"type":"string"},"id":{"readOnly":true,"type":"integer"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":["array","null"]},"page_count":{"readOnly":true,"type":["integer","null"]},"practice":{"format":"int64","type":"integer"},"practice_fax":{"type":["string","null"]},"process_complete_time":{"format":"date-time","type":["string","null"]},"process_result":{"readOnly":true,"type":["string","null"]},"process_start_time":{"format":"date-time","type":["string","null"]},"process_state":{"allOf":[{"$ref":"#/components/schemas/ProcessStateEnum"}],"readOnly":true},"received_time":{"format":"date-time","type":["string","null"]},"source":{"allOf":[{"$ref":"#/components/schemas/SourceEnum"}],"readOnly":true},"subject":{"readOnly":true,"type":["string","null"]},"to_company":{"readOnly":true,"type":["string","null"]},"to_name":{"readOnly":true,"type":["string","null"]},"to_number":{"readOnly":true,"type":["string","null"]},"transmit_time":{"format":"date-time","type":["string","null"]}},"required":["group_name","practice"],"type":"object"},"InfoSourceEnum":{"enum":["Historical information - from birth certificate","Historical information - from other provider","Historical information - from other registry","Historical information - from parent's recall","Historical information - from parent's written record","Historical information - from public agency","Historical information - from school record","Historical information - source unspecified","New immunization record"],"type":"string"},"Injection":{"properties":{"contraindication":{"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"dose":{"format":"decimal","pattern":"^-?\\d{0,18}(?:\\.\\d{0,9})?$","type":["string","null"]},"dose_in_series":{"minimum":0,"type":["integer","null"]},"dose_unit":{"oneOf":[{"$ref":"#/components/schemas/DoseUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"expiration_date":{"format":"date","type":["string","null"]},"given_by":{"oneOf":[{"$ref":"#/components/schemas/Actor"},{"type":"null"}]},"given_date":{"format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"is_confidential":{"readOnly":true,"type":"boolean"},"is_new":{"type":"boolean"},"is_permanent":{"type":"boolean"},"lot_number":{"maxLength":255,"type":["string","null"]},"manufacturer":{"type":["string","null"]},"method":{"oneOf":[{"$ref":"#/components/schemas/MethodEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"ndc":{"type":["string","null"]},"notes":{"type":["string","null"]},"ordered_by":{"oneOf":[{"$ref":"#/components/schemas/Actor"},{"type":"null"}]},"packaged_medication_id":{"format":"int64","readOnly":true,"type":["integer","null"]},"patient":{"format":"int64","readOnly":true,"type":"integer"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"procedures":{"oneOf":[{"$ref":"#/components/schemas/ProcedureCodes"},{"type":"null"}]},"reason":{"type":["string","null"]},"reference_medication_id":{"format":"int64","readOnly":true,"type":"integer"},"service_location_id":{"format":"int64","type":["integer","null"]},"site":{"oneOf":[{"$ref":"#/components/schemas/SiteEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]}},"required":["dose","given_date","ndc"],"type":"object"},"Insurance":{"properties":{"address":{"maxLength":200,"type":["string","null"]},"carrier":{"maxLength":200,"type":["string","null"]},"city":{"maxLength":50,"type":["string","null"]},"copay":{"format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deductible":{"format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"end_date":{"format":"date","type":["string","null"]},"extension":{"maxLength":6,"type":["string","null"]},"group_id":{"maxLength":50,"type":["string","null"]},"id":{"type":["integer","null"]},"insurance_company":{"format":"int64","type":["integer","null"]},"insurance_plan":{"format":"int64","type":["integer","null"]},"insured_person_address":{"maxLength":200,"type":["string","null"]},"insured_person_city":{"maxLength":50,"type":["string","null"]},"insured_person_dob":{"maxLength":50,"type":["string","null"]},"insured_person_first_name":{"maxLength":200,"type":["string","null"]},"insured_person_gender":{"maxLength":1,"type":["string","null"]},"insured_person_id":{"maxLength":50,"type":["string","null"]},"insured_person_last_name":{"maxLength":200,"type":["string","null"]},"insured_person_ssn":{"maxLength":11,"type":["string","null"]},"insured_person_state":{"maxLength":2,"type":["string","null"]},"insured_person_zip":{"maxLength":10,"type":["string","null"]},"member_id":{"maxLength":50,"type":["string","null"]},"payment_program":{"$ref":"#/components/schemas/PaymentProgramEnum"},"phone":{"maxLength":20,"type":["string","null"]},"plan":{"maxLength":200,"type":["string","null"]},"rank":{"$ref":"#/components/schemas/RankEnum"},"relationship_to_insured":{"oneOf":[{"$ref":"#/components/schemas/InsurerRelationshipType"},{"$ref":"#/components/schemas/NullEnum"}]},"start_date":{"format":"date","type":["string","null"]},"state":{"maxLength":2,"type":["string","null"]},"suite":{"maxLength":35,"type":["string","null"]},"zip":{"maxLength":10,"type":["string","null"]}},"required":["rank"],"type":"object"},"InsuranceCard":{"properties":{"images":{"items":{"$ref":"#/components/schemas/InsuranceCardImage"},"type":"array"},"rank":{"description":"Primary or secondary insurances (1 or 2).","type":"integer"}},"required":["images","rank"],"type":"object"},"InsuranceCardImage":{"properties":{"side":{"description":"Insurance card side. Usually front (1) or back (2).","type":"integer"},"ttl":{"type":"integer"},"url":{"format":"uri","type":"string"}},"required":["side","ttl","url"],"type":"object"},"InsuranceCompany":{"properties":{"address":{"maxLength":200,"type":"string"},"aliases":{"description":"A string used to create alternate terms that will come up in search results (for example \"BC\" for Blue Cross).","maxLength":300,"type":["string","null"]},"carrier":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"eligibility_payer_id":{"maxLength":200,"type":["string","null"]},"extension":{"maxLength":6,"type":["string","null"]},"external_vendor_id":{"description":"The ID used by a vendor to represent the carrier in their system.","maxLength":200,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_type":{"description":"An enumerator representing the type of insurance the carrier offers.","oneOf":[{"$ref":"#/components/schemas/InsuranceTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"is_credentialed":{"description":"Whether or not the practice has credentials to submit claims to the carrier.","type":["boolean","null"]},"is_enrolled":{"type":["boolean","null"]},"payer_id":{"description":"The Payer ID of the insurance carrier.","maxLength":200,"type":["string","null"]},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"suite":{"maxLength":40,"type":["string","null"]},"zip":{"maxLength":10,"type":"string"}},"required":["carrier","practice"],"type":"object"},"InsuranceCompanySingleInstance":{"properties":{"address":{"maxLength":200,"type":"string"},"aliases":{"description":"A string used to create alternate terms that will come up in search results (for example \"BC\" for Blue Cross).","maxLength":300,"type":["string","null"]},"carrier":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"eligibility_payer_id":{"maxLength":200,"type":["string","null"]},"extension":{"maxLength":6,"type":["string","null"]},"external_vendor_id":{"description":"The ID used by a vendor to represent the carrier in their system.","maxLength":200,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_type":{"description":"An enumerator representing the type of insurance the carrier offers.","oneOf":[{"$ref":"#/components/schemas/InsuranceTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"is_credentialed":{"description":"Whether or not the practice has credentials to submit claims to the carrier.","type":["boolean","null"]},"is_enrolled":{"type":["boolean","null"]},"patients":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"payer_id":{"description":"The Payer ID of the insurance carrier.","maxLength":200,"type":["string","null"]},"phone":{"maxLength":20,"type":["string","null"]},"plans":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"suite":{"maxLength":40,"type":["string","null"]},"zip":{"maxLength":10,"type":"string"}},"required":["carrier","practice"],"type":"object"},"InsuranceEligibility":{"properties":{"eligibility_check_timestamp":{"description":"Eligibility check timestamp in ISO format.","format":"date-time","type":"string"},"eligibility_details":{"$ref":"#/components/schemas/EligibilityDetails"},"eligibility_status":{"allOf":[{"$ref":"#/components/schemas/EligibilityStatusEnum"}],"description":"Status of eligibility check.\n\n* `active` - active\n* `inactive` - inactive\n* `error` - error"},"patient_id":{"description":"Patient's id in Elation system.","type":"integer"},"patient_insurance_id":{"description":"Patient's insurance id in Elation system.","type":"integer"},"practice_id":{"description":"Practice's id in Elation system.","type":"integer"}},"type":"object"},"InsuranceEligibilityFullReport":{"properties":{"benefits":{"$ref":"#/components/schemas/EligibilityBenefits"},"eligibility_check_timestamp":{"description":"Eligibility check timestamp in ISO format.","format":"date-time","type":"string"},"eligibility_provider":{"$ref":"#/components/schemas/EligibilityProvider"},"patient_id":{"description":"Patient's id in Elation system.","type":"integer"},"patient_insurance_id":{"description":"Patient's insurance id in Elation system.","type":"integer"},"plan_details":{"$ref":"#/components/schemas/EligibilityPlanDetails"},"practice_id":{"description":"Practice's id in Elation system.","type":"integer"},"service_type_code":{"type":"string"},"subscriber":{"$ref":"#/components/schemas/EligibilitySubscriber"}},"type":"object"},"InsurancePlan":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_company":{"description":"The insurance company that the plan is associated with.","format":"int64","type":"integer"},"name":{"maxLength":200,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["insurance_company","name","practice"],"type":"object"},"InsurancePlanSingleInstance":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_company":{"description":"The insurance company that the plan is associated with.","format":"int64","type":"integer"},"name":{"maxLength":200,"type":"string"},"patients":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"practice":{"format":"int64","type":"integer"}},"required":["insurance_company","name","practice"],"type":"object"},"InsuranceTypeEnum":{"enum":["Capitated","Commercial","Managed Medicaid","Medicaid","Medicare","Medicare Advantage","Medicare Supplement","Self Pay","Workers Compensation/Third Party Liability","None"],"type":"string"},"InsurerRelationshipType":{"enum":["Child","Other","Spouse"],"type":"string"},"InternalPracticeNoteSerializerProxy":{"properties":{"document":{"description":"The report (document) ID this note belongs to","readOnly":true,"type":"integer"},"id":{"description":"The id of the internal note.","readOnly":true,"type":"integer"},"text":{"description":"The internal note text content","maxLength":256,"type":"string"}},"required":["text"],"type":"object"},"LabOrder":{"properties":{"answers":{"description":"List of the answers provided for the Ask on Entry (AOE) questions if required by any lab order tests.","items":{"$ref":"#/components/schemas/LabOrderAOEAnswer"},"type":["array","null"]},"bill_type":{"description":"Who is financially responsible for the order.\n\n* `thirdparty` - Third Party (e.g. Insurance)\n* `patient` - Patient\n* `client` - Client\n* `workerscomp` - Worker's Comp\n* `specialbilling` - Special Billing","oneOf":[{"$ref":"#/components/schemas/BillTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"ccs":{"description":"List of physician ids who should be cc'd on any reports.","items":{"format":"int64","type":["integer","null"]},"type":"array"},"chart_date":{"description":"Date at which this order was first seen in the patient's chart.","format":"date-time","type":"string"},"confidential":{"default":false,"description":"Whether the provider has marked the order as confidential. Should not be shared with a patient.","type":"boolean"},"content":{"allOf":[{"$ref":"#/components/schemas/LabOrderContent"}],"description":"Represents the content of the lab order report."},"created_date":{"description":"Time at which elation created this order. Can be different from chart_date when the order was imported into a chart from a different source and document_date when documenting an order that happened at some other time.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"Time at which this order was created in whichever system created it. Could be historical or same as the create_date.","format":"date-time","type":"string"},"facility":{"description":"An identifier that represents the facility placing the order. Usually assigned by the lab vendor.","oneOf":[{"$ref":"#/components/schemas/FacilityIdentifier"},{"type":"null"}]},"follow_up_method":{"description":"Freetext field communicating how the patient should receive their results.","type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"ordering_physician":{"description":"The id of the physician who created the order.","format":"int64","type":"integer"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"practice":{"description":"The id of the practice.","format":"int64","type":"integer"},"printable_view":{"format":"uri","type":"string"},"requisition":{"description":"The requisition id of the order. Can be different from the order id if and when the order was created outside of Elation.","type":"integer"},"resolution":{"description":"The current state of the order's resolution.","oneOf":[{"$ref":"#/components/schemas/DocumentResolutionState"},{"type":"null"}]},"signed_by":{"description":"The id of the physician who signed off on the order.","format":"int64","type":["integer","null"]},"signed_date":{"description":"The time when the order was signed.","format":"date-time","type":["string","null"]},"site":{"description":"The location where the patient will have the lab performed. Sites are specific to their lab vendor.","oneOf":[{"$ref":"#/components/schemas/LabVendorPatientSite"},{"type":"null"}]},"special_insurance":{"description":"Used primarily to support specific electronic lab order integrations.","oneOf":[{"$ref":"#/components/schemas/PracticeSpecialInsuranceCodeName"},{"type":"null"}]},"specimens":{"description":"Record of any specimens collected when creating the order.","items":{"$ref":"#/components/schemas/LabOrderSpecimen"},"type":["array","null"]},"submissions":{"description":"Record of the attempts to submit.","items":{"$ref":"#/components/schemas/LabOrderSubmission"},"type":["array","null"]},"tags":{"description":"Any tags associated with the lab order.","items":{"format":"int64","type":["integer","null"]},"type":"array"},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"vendor":{"format":"int64","type":["integer","null"]}},"required":["document_date","ordering_physician","patient","practice"],"type":"object"},"LabOrderAOEAnswer":{"properties":{"created_date":{"description":"When the answer was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"When the answer was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"question":{"description":"The id of the AOE question for which this answer pertains.","format":"int64","type":"integer"},"test":{"description":"The id of the test for which this answer pertains.","format":"int64","type":["integer","null"]},"value":{"description":"The value entered by freetext or chosen by the ordering physician.","type":["string","null"]}},"required":["question"],"type":"object"},"LabOrderAOEQuestion":{"properties":{"choices":{"items":{"$ref":"#/components/schemas/LabOrderAOEQuestionChoice"},"type":"array"},"code":{"maxLength":100,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"example_format":{"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"max_length":{"maximum":65535,"minimum":0,"type":["integer","null"]},"question_type":{"$ref":"#/components/schemas/QuestionTypeEnum"},"secondary_code":{"maxLength":100,"type":["string","null"]},"value":{"type":"string"}},"required":["choices","code","value"],"type":"object"},"LabOrderAOEQuestionChoice":{"properties":{"code":{"maxLength":100,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"value":{"type":"string"}},"required":["code","value"],"type":"object"},"LabOrderContent":{"properties":{"collection_datetime":{"description":"If lab specimen collection is done onsite, this is the time at which the collection was taken.","format":"date-time","type":["string","null"]},"fasting_method":{"description":"Instructions for patient and lab on how long they should fast before specimen collection.\n\n* `fasting_12_hour` - Fasting - 12 hours\n* `fasting_8_hours` - Fasting - 8 hours\n* `fasting_2_hours` - Fasting - 2 hours\n* `fasting_none` - Non-Fasting\n* `fasting_random` - Fasting or non-fasting does not matter (Random)","oneOf":[{"$ref":"#/components/schemas/FastingMethodEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"icd10_codes":{"description":"ICD10 diagnosis codes provided along with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient_instructions":{"description":"Notes for patient.","type":"string"},"standing_order_end_date":{"description":"Date at which standing order should be canceled.","format":"date","type":["string","null"]},"standing_order_frequency":{"description":"Number of times order should be performed on a standing basis.","maxLength":50,"type":["string","null"]},"stat_method":{"oneOf":[{"$ref":"#/components/schemas/StatMethodEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"test_center_notes":{"description":"Notes for Lab.","type":"string"},"tests":{"description":"The list of tests that should be performed by the lab. Must all be either from the same compendium or no compendium.","items":{"$ref":"#/components/schemas/LabOrderTestWithDiagnoses"},"type":"array"}},"type":"object"},"LabOrderSet":{"properties":{"compendium_code":{"description":"RM-9598 Guard against missing code/name. Can't repro issue from ticket\n    locally so being extra careful with the guards here.","readOnly":true,"type":"string"},"content":{"$ref":"#/components/schemas/LabOrderContent"},"created_date":{"description":"Time at which elation created this order. Can be different from chart_date when the order was imported into a chart from a different source and document_date when documenting an order that happened at some other time.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":["integer","null"]},"name":{"description":"The name of the lab order set.","maxLength":250,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["content","name","practice"],"type":"object"},"LabOrderSpecimen":{"properties":{"body_site":{"allOf":[{"$ref":"#/components/schemas/BodySite"}],"description":"Information about the body site where the specimen was collected."},"container_id":{"description":"An identifier representing the container used to store the specimen.","maxLength":2,"type":"string"},"description":{"description":"A freetext description of the specimen.","maxLength":100,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_order":{"format":"int64","readOnly":true,"type":"integer"},"modifiers":{"description":"Coded Modifiers indicating more information about the body site from which the specimen was collected.","items":{"$ref":"#/components/schemas/LabOrderSpecimenModifier"},"type":"array"},"test":{"description":"The lab order test for which the specimen as collected.","format":"int64","type":"integer"}},"required":["body_site","container_id","modifiers","test"],"type":"object"},"LabOrderSpecimenModifier":{"properties":{"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"modifier":{"$ref":"#/components/schemas/BodySiteCodeModifier"},"sequence":{"description":"The cardinal position in which the modifiers should be listed.","maximum":65535,"minimum":0,"type":"integer"},"specimen":{"format":"int64","type":"integer"}},"required":["modifier","sequence","specimen"],"type":"object"},"LabOrderSubmission":{"properties":{"id":{"readOnly":true,"type":"integer"},"lab_order":{"format":"int64","readOnly":true,"type":"integer"},"state":{"description":"The state of the electronic order submission.","maxLength":20,"type":"string"},"state_metadata":{"description":"Useful error information collected as part of the submission. Including ERRORs or ACKs.","maxLength":1500,"type":["string","null"]},"time_acknowledged":{"description":"The time at which a user acknowledged any error shown to them about the electronic submission.","format":"date-time","type":["string","null"]},"time_submitted":{"description":"The time the electronic order was submitted to the lab vendor.","format":"date-time","type":"string"}},"required":["time_submitted"],"type":"object"},"LabOrderTest":{"properties":{"code":{"description":"Any code associated with the test, usually provided by the lab vendor's compendium.","maxLength":50,"type":["string","null"]},"compendium":{"description":"The id of the compendium provided the lab vendor that provides the lab order test. All tests in the same order **MUST** share the same compendium.","format":"int64","type":["integer","null"]},"cpts":{"description":"A list of CPT codes associated with the lab order test.","items":{"type":"string"},"type":"array"},"created_date":{"description":"Time at which Elation created this Lab Order Test.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"Time at which this Lab Order Test was deleted. Can happen when a lab order compendium update deprecates a test.","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"description":"The id of the lab vendor who provides the lab order test.","format":"int64","type":["integer","null"]},"name":{"description":"The name of the Lab Order Test.","maxLength":255,"type":"string"},"practice_created":{"description":"The id of the practice that created the test if practice created.","format":"int64","type":["integer","null"]},"procedure_class":{"description":"Code provided by specific compendiums that indicate the \"class\" of test, e.g. histology vs cytology. Some lab vendors require that tests with specific procedure classes need to ordered separately.","maxLength":50,"type":["string","null"]},"questions":{"description":"A list of Ask on Entry (AOE) Questions that need to be answered by the orderer when creating the order.","items":{"$ref":"#/components/schemas/LabOrderTestToLabOrderAOEQuestion"},"type":"array"},"synonyms":{"description":"A list of synonyms that are useful when searching for a specific test.","items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"LabOrderTestCompendium":{"description":"The serializer for LabOrderTestCompendium","properties":{"code":{"maxLength":200,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":"integer"},"last_updated":{"format":"date-time","readOnly":true,"type":"string"},"name":{"maxLength":200,"type":"string"}},"required":["lab_vendor","name"],"type":"object"},"LabOrderTestToLabOrderAOEQuestion":{"properties":{"question":{"$ref":"#/components/schemas/LabOrderAOEQuestion"},"required":{"type":"boolean"},"sequence":{"maximum":65535,"minimum":0,"type":"integer"},"test":{"format":"int64","readOnly":true,"type":"integer"}},"required":["question","sequence"],"type":"object"},"LabOrderTestWithDiagnoses":{"properties":{"code":{"description":"Any code associated with the test, usually provided by the lab vendor's compendium.","maxLength":50,"type":["string","null"]},"compendium":{"description":"The id of the compendium provided the lab vendor that provides the lab order test. All tests in the same order **MUST** share the same compendium.","format":"int64","type":["integer","null"]},"cpts":{"description":"A list of CPT codes associated with the lab order test.","items":{"type":"string"},"type":"array"},"created_date":{"description":"Time at which Elation created this Lab Order Test.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"Time at which this Lab Order Test was deleted. Can happen when a lab order compendium update deprecates a test.","format":"date-time","readOnly":true,"type":["string","null"]},"icd10_codes":{"items":{"$ref":"#/components/schemas/ICD10Code"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"description":"The id of the lab vendor who provides the lab order test.","format":"int64","type":["integer","null"]},"name":{"description":"The name of the Lab Order Test.","maxLength":255,"type":"string"},"practice_created":{"description":"The id of the practice that created the test if practice created.","format":"int64","type":["integer","null"]},"procedure_class":{"description":"Code provided by specific compendiums that indicate the \"class\" of test, e.g. histology vs cytology. Some lab vendors require that tests with specific procedure classes need to ordered separately.","maxLength":50,"type":["string","null"]},"questions":{"description":"A list of Ask on Entry (AOE) Questions that need to be answered by the orderer when creating the order.","items":{"$ref":"#/components/schemas/LabOrderTestToLabOrderAOEQuestion"},"type":"array"},"synonyms":{"description":"A list of synonyms that are useful when searching for a specific test.","items":{"type":"string"},"type":"array"}},"required":["icd10_codes","name"],"type":"object"},"LabResult":{"properties":{"abnormal_flag":{"$ref":"#/components/schemas/AbnormalFlagEnum"},"is_abnormal":{"type":"boolean"},"note":{"type":["string","null"]},"reference_max":{"type":["string","null"]},"reference_min":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/LabResultStatus"},"test":{"$ref":"#/components/schemas/LabTest"},"test_category":{"$ref":"#/components/schemas/LabTestCategory"},"text":{"type":["string","null"]},"units":{"maxLength":20,"type":["string","null"]},"value":{"maxLength":500,"type":"string"},"value_type":{"oneOf":[{"$ref":"#/components/schemas/ValueTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]}},"required":["abnormal_flag","is_abnormal","note","reference_max","reference_min","status","test","test_category","text","value"],"type":"object"},"LabResultStatus":{"enum":["AMENDED","CORRECTED","DELETED","ERROR","FINAL","PARTIAL","PENDING","PRELIMINARY","RESULT CANCELED DUE TO NON-PERFORMANCE","RESULTS ENTERED -- NOT VERIFIED","RESULTS STATUS CHANGE TO FINAL. RESULTS DID NOT CHANGE ( DONT TRANSMIT TEST)."],"type":"string"},"LabResultsGrid":{"properties":{"accession_number":{"type":"string"},"collected_date":{"description":"The datetime the specimens for this grid of data was collected from the patient.","format":"date-time","type":"string"},"note":{"type":["string","null"]},"resulted_date":{"description":"The datetime this grid of data was calculated and resulted by the lab.","format":"date-time","type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabResult"},"type":"array"},"status":{"$ref":"#/components/schemas/LabResultStatus"}},"required":["accession_number","collected_date","note","resulted_date","results","status"],"type":"object"},"LabTest":{"properties":{"code":{"maxLength":50,"type":"string"},"loinc":{"type":["string","null"]},"name":{"maxLength":255,"type":"string"}},"required":["code","loinc","name"],"type":"object"},"LabTestCategory":{"properties":{"description":{"maxLength":200,"type":"string"},"value":{"maxLength":50,"type":"string"}},"required":["description","value"],"type":"object"},"LabVendor":{"description":"The serializer for LabVendor","properties":{"bidi_connections":{"items":{"$ref":"#/components/schemas/BiDiLabConnection"},"readOnly":true,"type":"array"},"compendiums":{"items":{"$ref":"#/components/schemas/LabOrderTestCompendium"},"type":["array","null"]},"default_compendium":{"oneOf":[{"$ref":"#/components/schemas/LabOrderTestCompendium"},{"type":"null"}]},"display_name":{"maxLength":100,"type":"string"},"has_order_compendium":{"type":"boolean"},"has_test_compendium":{"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"is_bidi":{"type":"boolean"},"is_in_house":{"type":"boolean"},"name":{"maxLength":50,"type":"string"},"orders_integration_available":{"type":"boolean"},"practice_created":{"format":"int64","type":["integer","null"]},"results_integration_available":{"type":"boolean"}},"required":["display_name","name"],"type":"object"},"LabVendorIdName":{"description":"LabVendor Serializer useful for simple, read-only reference.","properties":{"display_name":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"name":{"readOnly":true,"type":"string"}},"type":"object"},"LabVendorIntegration":{"description":"Serializer for non-internal usage to align better with APIv2 conventions","properties":{"allow_print":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":"integer"},"orders_status":{"$ref":"#/components/schemas/LabVendorIntegrationStatus"},"practice":{"format":"int64","type":"integer"},"results_status":{"$ref":"#/components/schemas/LabVendorIntegrationStatus"}},"required":["lab_vendor","orders_status","practice","results_status"],"type":"object"},"LabVendorIntegrationStatus":{"enum":["blocked","completed_testing","live","not_requested","pending_testing","waiting_on_lab"],"type":"string"},"LabVendorPatientSite":{"description":"The serializer for LabVendorPatientSite","properties":{"address":{"description":"The address of the site.","maxLength":200,"type":"string"},"city":{"description":"The city of the site.","maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":200,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice_created":{"format":"int64","type":["integer","null"]},"state":{"maxLength":2,"type":"string"},"suite":{"maxLength":40,"type":["string","null"]},"vendor":{"$ref":"#/components/schemas/LabVendorIdName"},"zip":{"maxLength":10,"type":"string"}},"required":["name"],"type":"object"},"Language":{"properties":{"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object"},"LegalGenderMarkerDisplayEnum":{"enum":["F","M","None Selected","X","None"],"type":"string"},"LegalGenderMarkerEnum":{"enum":["F","M","U","X","None"],"type":"string"},"Letter":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/LetterAttachment"},"type":"array"},"body":{"description":"The body of the letter.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethodEnum"},"direct_message_status":{"readOnly":true,"type":["string","null"]},"direct_message_to":{"maxLength":200,"type":["string","null"]},"display_to":{"readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"email_to":{"maxLength":200,"type":["string","null"]},"failure_unacknowledged":{"type":"string"},"fax_attachments":{"type":"boolean"},"fax_status":{"readOnly":true,"type":"string"},"fax_to":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_processed":{"readOnly":true,"type":"boolean"},"letter_type":{"readOnly":true,"type":"string"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"referral_order":{"format":"int64","type":["integer","null"]},"send_out":{"type":"boolean"},"send_to_contact":{"$ref":"#/components/schemas/SendToContact"},"send_to_elation_user":{"description":"If a letter is sent to another elation user, this will be that user's id.","readOnly":true,"type":"integer"},"send_to_name":{"maxLength":200,"type":["string","null"]},"sign_date":{"format":"date-time","type":["string","null"]},"signed_by":{"description":"The user who signed the letter.","format":"int64","type":["integer","null"]},"subject":{"description":"The subject of the letter (Not needed with referral_order).","maxLength":200,"type":"string"},"tags":{"description":"A list of Document Tags associated with the letter.","items":{"format":"int64","type":"integer"},"type":"array"},"to_number":{"readOnly":true,"type":["string","null"]},"viewed_at":{"format":"date-time","type":["string","null"]},"with_archive":{"type":"boolean"}},"required":["patient","practice","send_to_contact"],"type":"object"},"LetterAttachment":{"properties":{"attachment_type":{"$ref":"#/components/schemas/AttachmentTypeEnum"},"entity_date":{"format":"date-time","type":["string","null"]},"entity_description":{"type":["string","null"]},"entity_id":{"format":"int64","type":"integer"},"entity_type":{"readOnly":true,"type":["integer","null"]},"handout":{"format":"int64","type":["integer","null"]},"id":{"readOnly":true,"type":"integer"},"summary":{"type":["string","null"]}},"required":["attachment_type"],"type":"object"},"LetterCategory":{"properties":{"id":{"format":"int64","type":"integer"},"key":{"maxLength":25,"type":"string"},"role":{"$ref":"#/components/schemas/RoleEnum"},"text":{"maxLength":100,"type":"string"}},"required":["id","key","text"],"type":"object"},"ListCPT":{"properties":{"alt_dxs":{"items":{"type":"string"},"type":"array"},"cpt":{"type":"string"},"description":{"description":"Description of the billing code from the practice's billing settings. Null if the code has been deleted since the bill was created.","type":["string","null"]},"dxs":{"items":{"type":"string"},"type":"array"},"modifiers":{"items":{"type":"string"},"type":"array"},"ndc":{"description":"11 digit NDC code, zero padded to 5-4-2 format.","type":"string"},"ndc_dose":{"description":"NDC units administered.  Precision to 3 decimal places.","format":"decimal","pattern":"^-?\\d{0,7}(?:\\.\\d{0,3})?$","type":"string"},"ndc_measure":{"description":"NDC unit of measure: null, \"F2\", \"GR\", \"ME\", \"ML\" or \"UN\"","type":"string"},"unit_charge":{"description":"Charge per CPT unit.","type":"string"},"units":{"description":"Number of units billed for the CPT.","type":"string"}},"required":["alt_dxs","cpt","description","dxs","modifiers","ndc","ndc_dose","ndc_measure","unit_charge","units"],"type":"object"},"MedOrder":{"properties":{"allow_substitutions":{"readOnly":true,"type":["boolean","null"]},"auth_refills":{"description":"The number of refills, excluding this order, that the patient is authorized for.","minimum":0,"type":["integer","null"]},"chart_date":{"format":"date-time","readOnly":true,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"days_supply":{"maximum":65535,"minimum":0,"type":["integer","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"directions":{"description":"The directions for the medication order.","maxLength":1000,"type":["string","null"]},"document_date":{"description":"The timestamp for when this prescription was first documented. Will be the same as the creation time unless this an historical data import.","format":"date-time","type":"string"},"documenting_personnel":{"description":"Physician object required if is_doc_med is true when creating.","format":"int64","type":["integer","null"]},"fulfillment":{"oneOf":[{"$ref":"#/components/schemas/Fulfillment"},{"type":"null"}],"readOnly":true},"icd10_codes":{"items":{"$ref":"#/components/schemas/ICD10Code"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_doc_med":{"description":"If the medication order is intended to document a med instead of draft a prescription. When it is true, the object will be automatically signed as a documented medication, otherwise the object will be created as a draft prescription.","type":"boolean"},"last_modified":{"format":"date-time","readOnly":true,"type":"string"},"medication":{"allOf":[{"$ref":"#/components/schemas/Medication"}],"description":"Medication object (must provide one of id, ndc, rxnorm_cuis required)."},"medication_type":{"allOf":[{"$ref":"#/components/schemas/MedicationTypeEnum"}],"description":"If this is OTC or a prescription.\n\n* `otc` - otc\n* `prescription` - prescription"},"notes":{"description":"Any notes for the patient.","type":["string","null"]},"num_samples":{"maxLength":50,"type":["string","null"]},"order_type":{"allOf":[{"$ref":"#/components/schemas/OrderTypeEnum"}],"description":"If the medication order is new, a refill or a change in dosage.\n\n* `New` - New\n* `Refill` - Refill\n* `DoseChange` - Change"},"patient":{"description":"The patient the medication order is for.","format":"int64","type":"integer"},"pharmacy_instructions":{"description":"Any notes for the pharmacy.","type":["string","null"]},"practice":{"description":"The practice the medication order is for.","format":"int64","type":"integer"},"prescribing_physician":{"description":"The physician who is prescribing the medication.","format":"int64","type":"integer"},"qty":{"description":"The quantity of the medication.","format":"decimal","pattern":"^-?\\d{0,18}(?:\\.\\d{0,9})?$","type":["string","null"]},"qty_units":{"description":"The units that match the amount, e.g. capsules.\n\n* `BAG` - BAG\n* `BOTTLE` - BOTTLE\n* `BOX` - BOX\n* `CAPSULE` - CAPSULE\n* `CARTRIDGE` - CARTRIDGE\n* `CONTAINER` - CONTAINER\n* `DROP` - DROP\n* `GRAM` - GRAM\n* `INHALER` - INHALER\n* `INTERNATIONAL UNITE` - INTERNATIONAL UNITE\n* `KIT` - KIT\n* `LITER` - LITER\n* `LOZENGE` - LOZENGE\n* `MILLIGRAM` - MILLIGRAM\n* `MILLILITER` - MILLILITER\n* `MILLION UNITS` - MILLION UNITS\n* `MUTUALLY DEFINED` - MUTUALLY DEFINED\n* `FLUID OUNCE` - FLUID OUNCE\n* `NOT SPECIFIED` - NOT SPECIFIED\n* `PACK` - PACK\n* `PACKET` - PACKET\n* `PINT` - PINT\n* `SUPPOSITORY` - SUPPOSITORY\n* `SYRINGE` - SYRINGE\n* `TABLESPOON` - TABLESPOON\n* `TABLET` - TABLET\n* `TEASPOON` - TEASPOON\n* `TRANSDERMAL PATCH` - TRANSDERMAL PATCH\n* `TUBE` - TUBE\n* `UNIT` - UNIT\n* `VIAL` - VIAL\n* `EACH` - EACH\n* `GUM` - GUM\n* `AMPULE` - AMPULE\n* `APPLICATOR` - APPLICATOR\n* `APPLICATORFUL` - APPLICATORFUL\n* `BAR` - BAR\n* `BEAD` - BEAD\n* `BLISTER` - BLISTER\n* `BLOCK` - BLOCK\n* `BOLUS` - BOLUS\n* `CAN` - CAN\n* `CANISTER` - CANISTER\n* `CAPLET` - CAPLET\n* `CARTON` - CARTON\n* `CASE` - CASE\n* `CASSETTE` - CASSETTE\n* `CYLINDER` - CYLINDER\n* `DISK` - DISK\n* `DOSE PACK` - DOSE PACK\n* `DUAL PACK` - DUAL PACK\n* `FILM` - FILM\n* `GALLON` - GALLON\n* `IMPLANT` - IMPLANT\n* `INHALATION` - INHALATION\n* `INHALER REFILL` - INHALER REFILL\n* `INSERT` - INSERT\n* `INTRAVENOUS BAG` - INTRAVENOUS BAG\n* `KILOGRAM` - KILOGRAM\n* `METRIC DROP` - METRIC DROP\n* `MILLIMETER` - MILLIMETER\n* `NEBULE` - NEBULE\n* `NEEDLE FREE INJECTION` - NEEDLE FREE INJECTION\n* `OCULAR SYSTEM` - OCULAR SYSTEM\n* `OUNCE` - OUNCE\n* `PACKAGE` - PACKAGE\n* `PAD` - PAD\n* `PAPER` - PAPER\n* `PATCH` - PATCH\n* `PEN NEEDLE` - PEN NEEDLE\n* `POUCH` - POUCH\n* `POUND` - POUND\n* `PRE-FILLED PEN SYRINGE` - PRE-FILLED PEN SYRINGE\n* `PUFF` - PUFF\n* `QUART` - QUART\n* `RING` - RING\n* `SACHET` - SACHET\n* `SCOOPFUL` - SCOOPFUL\n* `SPONGE` - SPONGE\n* `SPRAY` - SPRAY\n* `STICK` - STICK\n* `STRIP` - STRIP\n* `SWAB` - SWAB\n* `TABMINDER` - TABMINDER\n* `TAMPON` - TAMPON\n* `TRAY` - TRAY\n* `TROCHE` - TROCHE\n* `` - \n* `WAFER` - WAFER","oneOf":[{"$ref":"#/components/schemas/QtyUnitsEnum"},{"$ref":"#/components/schemas/BlankEnum"}]},"send_rx_reminder":{"readOnly":true,"type":"boolean"},"show_in_chart_feed":{"type":"boolean"},"signed_by":{"format":"int64","readOnly":true,"type":["integer","null"]},"signed_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"start_date":{"description":"The date on which the prescription started or will start.","format":"date","type":"string"},"thread":{"$ref":"#/components/schemas/Thread"}},"required":["auth_refills","icd10_codes","is_doc_med","medication","medication_type","order_type","patient","practice","prescribing_physician","qty","qty_units","start_date","thread"],"type":"object"},"MedOrderTemplate":{"description":"Contains only webhooks\nAll other fields inherited","properties":{"auth_refills":{"maximum":99,"minimum":0,"type":["integer","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"directions":{"maxLength":300,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"medication":{"allOf":[{"$ref":"#/components/schemas/Medication"}],"description":"When creating, must contains only one from id, ndcs or rxnorm_cuis fields."},"practice":{"format":"int64","type":"integer"},"qty":{"format":"decimal","pattern":"^-?\\d{0,18}(?:\\.\\d{0,9})?$","type":["string","null"]},"qty_units":{"oneOf":[{"$ref":"#/components/schemas/QtyUnitsEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"rank":{"readOnly":true,"type":"integer"},"specific_ndc":{"type":["string","null"]}},"required":["medication","practice"],"type":"object"},"MedicalSpecialty":{"properties":{"abbreviation":{"maxLength":20,"type":"string"},"category":{"$ref":"#/components/schemas/MedicalSpecialtyCategory"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":100,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]}},"required":["abbreviation","name"],"type":"object"},"MedicalSpecialtyCategory":{"properties":{"abbreviation":{"maxLength":20,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object"},"Medication":{"properties":{"active_ndcs":{"items":{"type":"string"},"type":"array"},"brand_name":{"readOnly":true,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"creation_type":{"allOf":[{"$ref":"#/components/schemas/MedicationDrugType"}],"default":"user","readOnly":true},"form":{"readOnly":true,"type":"string"},"generic_name":{"readOnly":true,"type":"string"},"id":{"description":"The id of the medication.","format":"int64","type":"integer"},"is_controlled":{"default":false,"description":"Whether the drug is a controlled substance or not.","type":"boolean"},"market_end_date":{"format":"date-time","type":["string","null"]},"name":{"description":"The name that will display for the medication in the search and when referenced by the prescription or documented med.","type":"string"},"ndcs":{"description":"The NDCs of the medication (must contain only one ndc code when creating).","items":{"type":"string"},"type":"array"},"obsolete_date":{"description":"The date at which this practice medication became obsolete.","format":"date-time","type":["string","null"]},"practice":{"description":"The practice that created the medication. `null` for medications from the standard formulary.","format":"int64","type":"integer"},"route":{"readOnly":true,"type":"string"},"rxnorm_cuis":{"description":"The Rxnorm.cui code of the medication (must contain only one cui code when creating).","items":{"type":"string"},"type":"array"},"strength":{"description":"The strength of the drug, e.g. 40mg.","maxLength":255,"type":["string","null"]},"type":{"allOf":[{"$ref":"#/components/schemas/MedicationType"}],"default":"prescription","description":"Whether the practice medication is an OTC or Prescription drug.\n\n* `otc` - otc\n* `prescription` - prescription\n* `discontinued` - discontinued"}},"type":"object"},"MedicationDrugType":{"description":"* `user` - user\n* `medispan` - medispan\n* `ss` - surescripts\n* `disp` - dispensary","enum":["user","medispan","ss","disp"],"type":"string"},"MedicationHistoryDownloadFill":{"properties":{"create_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"days_supply":{"type":"string"},"diagnoses":{"items":{"format":"int64","type":"integer"},"type":"array"},"directions":{"type":"string"},"history_download":{"format":"int64","type":"integer"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"last_fill_date":{"format":"date-time","type":"string"},"medication":{"format":"int64","type":"integer"},"medication_description":{"type":"string"},"medication_order":{"format":"int64","type":"integer"},"note":{"type":"string"},"patient":{"format":"int64","type":"integer"},"pharmacy_ncpdpid":{"type":"string"},"practice":{"format":"int64","type":"integer"},"prescriber":{"format":"int64","type":"integer"},"prescribing_physician":{"format":"int64","type":"integer"},"prior_auth":{"type":"string"},"prior_auth_qualifier":{"$ref":"#/components/schemas/PriorAuthQualifierEnum"},"quantity":{"type":"string"},"quantity_note":{"type":"string"},"quantity_unit":{"type":"string"},"refills":{"items":{"format":"int64","type":"integer"},"type":"array"},"requesting_physician":{"format":"int64","type":"integer"},"requesting_physician_action":{"$ref":"#/components/schemas/RequestingPhysicianActionEnum"},"substitutions":{"type":"string"},"written_date":{"format":"date-time","type":"string"}},"required":["days_supply","diagnoses","directions","history_download","is_active","last_fill_date","medication","medication_description","medication_order","note","patient","pharmacy_ncpdpid","practice","prescriber","prescribing_physician","prior_auth","prior_auth_qualifier","quantity","quantity_note","quantity_unit","refills","requesting_physician","requesting_physician_action","substitutions","written_date"],"type":"object"},"MedicationType":{"description":"* `otc` - otc\n* `prescription` - prescription\n* `discontinued` - discontinued","enum":["otc","prescription","discontinued"],"type":"string"},"MedicationTypeEnum":{"description":"* `otc` - otc\n* `prescription` - prescription","enum":["otc","prescription"],"type":"string"},"MessageThread":{"properties":{"chart_date":{"description":"When the message thread's patient chart was created.","format":"date-time","type":"string"},"created_date":{"description":"When the message thread was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"When the message thread was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"document_date":{"description":"When the message thread's document was created.","format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"is_urgent":{"default":false,"description":"Whether the message is currently urgent.","type":"boolean"},"members":{"description":"List of Thread Members, when creating only need to specify the id of the thread member and their status.","items":{"$ref":"#/components/schemas/ThreadMember"},"type":"array"},"messages":{"description":"List of Thread Messages, when creating only need to provide the body, send_date and sender.","items":{"$ref":"#/components/schemas/ThreadMessage"},"type":"array"},"patient":{"description":"The patient chart for which the thread is about.","format":"int64","type":"integer"},"practice":{"description":"The id of the practice that owns the patient chart.","format":"int64","type":"integer"},"signed_by":{"description":"The user who signed the thread","format":"int64","type":["integer","null"]},"signed_date":{"description":"The date and time when the thread was signed","format":"date-time","type":["string","null"]}},"required":["chart_date","document_date","patient","practice"],"type":"object"},"MethodEnum":{"description":"* `Intravenous` - Intravenous\n* `Intramuscular` - Intramuscular\n* `Subcutaneous` - Subcutaneous\n* `Intradermal` - Intradermal\n* `Other` - Other","enum":["Intravenous","Intramuscular","Subcutaneous","Intradermal","Other"],"type":"string"},"ModeEnum":{"enum":["IN_PERSON","VIDEO"],"type":"string"},"MultiStateIdentifiers":{"properties":{"id":{"readOnly":true,"type":"integer"},"primary_state":{"maxLength":2,"type":["string","null"]},"state_identifiers":{}},"required":["state_identifiers"],"type":"object"},"NdcMeasureEnum":{"description":"* `GR` - GR\n* `F2` - F2\n* `ME` - ME\n* `ML` - ML\n* `UN` - UN","enum":["GR","F2","ME","ML","UN"],"type":"string"},"NonVisitNote":{"properties":{"bullets":{"description":"The bullets of the non visit note.","items":{"$ref":"#/components/schemas/NonVisitNoteBullet"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"note_documents":{"description":"The documents referenced by the non visit note.","items":{"oneOf":[{"$ref":"#/components/schemas/NonVisitNoteDocument"},{"type":"null"}]},"type":"array"},"note_items":{"description":"The items in the clinical record on the left hand side of the chart referenced by the non visit note.","items":{"oneOf":[{"$ref":"#/components/schemas/NonVisitNotePatientItem"},{"type":"null"}]},"type":"array"},"patient":{"format":"int64","type":"integer"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"tags":{"description":"The ids of the document tags you want to attach.","items":{"format":"int64","type":"integer"},"type":"array"},"type":{"description":"The type of the non visit note.","type":"string"}},"required":["chart_date","document_date","patient","type"],"type":"object"},"NonVisitNoteBullet":{"properties":{"author":{"description":"The author of the bullet.","type":"integer"},"id":{"type":"integer"},"text":{"description":"The text of the bullet.","type":"string"},"updated_date":{"format":"date-time","readOnly":true,"type":"string"},"version":{"maximum":65535,"minimum":0,"type":"integer"}},"required":["text"],"type":"object"},"NonVisitNoteDocument":{"properties":{"document":{"$ref":"#/components/schemas/Document"},"id":{"readOnly":true,"type":"integer"},"summary":{"type":["string","null"]}},"required":["document"],"type":"object"},"NonVisitNotePatientItem":{"properties":{"id":{"readOnly":true,"type":"integer"},"item":{"$ref":"#/components/schemas/PatientItem"}},"required":["item"],"type":"object"},"NullEnum":{"type":"null"},"OrderStatusEnum":{"enum":["CANCELED","COMPLETED","DISCONTINUED","ERROR, ORDER NOT FOUND","IN PROCESS","ON HOLD","REPLACED","SCHEDULED"],"type":"string"},"OrderTypeEnum":{"description":"* `New` - New\n* `Refill` - Refill\n* `DoseChange` - Change","enum":["New","Refill","DoseChange"],"type":"string"},"PackagedMedication":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"din":{"description":"Drug Identification Number.","readOnly":true,"type":["string","null"]},"gpi":{"description":"Generic Product Identifier.","readOnly":true,"type":["string","null"]},"has_outer_packaged_drug":{"readOnly":true,"type":["boolean","null"]},"hri":{"description":"Health Related Item.","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_active":{"readOnly":true,"type":"boolean"},"is_clinic_pack":{"description":"`true` if the packaged medication is a clinic pack.","readOnly":true,"type":["boolean","null"]},"is_repackaged":{"description":"`true` if the packaged medication is a repackaged medication.","readOnly":true,"type":["boolean","null"]},"labeler_id":{"format":"int64","readOnly":true,"type":"integer"},"market_end_date":{"format":"date-time","type":["string","null"]},"medispanppid":{"readOnly":true,"type":["string","null"]},"multi_source":{"readOnly":true,"type":["string","null"]},"name":{"readOnly":true,"type":"string"},"ndc":{"description":"National Drug Code.","readOnly":true,"type":["string","null"]},"obsolete_date":{"format":"date-time","type":["string","null"]},"packaging_name":{"readOnly":true,"type":["string","null"]},"reference_medication_id":{"format":"int64","readOnly":true,"type":"integer"},"size_description":{"readOnly":true,"type":["string","null"]},"upc":{"description":"Universal Product Code.","readOnly":true,"type":["string","null"]}},"type":"object"},"PackagedMedicationLabeler":{"properties":{"id":{"format":"int64","type":"integer"},"medispanid":{"maxLength":32,"type":"string"},"name":{"maxLength":255,"type":"string"}},"required":["id","medispanid","name"],"type":"object"},"PaginatedAncillaryCompanyList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/AncillaryCompany"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedAppointmentList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Appointment"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedAppointmentTypeList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/AppointmentType"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedBillList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Bill"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCPTCodeList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CPTCode"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCardiacCenterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CardiacCenter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCardiacOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CardiacOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCardiacOrderTestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CardiacOrderTest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCodedDocumentTagList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CodedDocumentTag"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedCommentList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Comment"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedContactList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedContactsSearchResultList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ContactsSearchResult"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedDataImportRequestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DataImportRequest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedDelegatePermissionList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DelegatePermission"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedDiscontinueMedOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DiscontinueMedOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedFacilityIdentifierList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FacilityIdentifier"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedHandoutsSerializerNoBase64ContentList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/HandoutsSerializerNoBase64Content"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedImagingCenterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ImagingCenter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedImagingOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ImagingOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedImagingOrderTestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ImagingOrderTest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedIncomingFileGroupList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/IncomingFileGroup"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedInjectionList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Injection"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedInsuranceCompanyList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/InsuranceCompany"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedInsurancePlanList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/InsurancePlan"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabOrderSetList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabOrderSet"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabOrderTestCompendiumList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabOrderTestCompendium"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabOrderTestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabOrderTest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabVendorIntegrationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabVendorIntegration"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabVendorList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabVendor"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLabVendorPatientSiteList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LabVendorPatientSite"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLanguageList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Language"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLetterCategoryList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LetterCategory"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedLetterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Letter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMedOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MedOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMedOrderTemplateList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MedOrderTemplate"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMedicalSpecialtyList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MedicalSpecialty"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMedicationHistoryDownloadFillList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MedicationHistoryDownloadFill"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMedicationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Medication"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedMessageThreadList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MessageThread"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedNonVisitNoteList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/NonVisitNote"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPackagedMedicationLabelerList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PackagedMedicationLabeler"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPackagedMedicationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PackagedMedication"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientAllergyDocumentationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientAllergyDocumentation"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientAllergyList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientAllergy"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientChartImportList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientChartImport"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientDrugIntoleranceList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientDrugIntolerance"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientFamilyHistoryList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientFamilyHistory"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientFormList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientForm"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientFormRequestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientFormRequest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientFormSubmissionList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientFormSubmission"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientHistoryList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientHistory"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientImmunizationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientImmunization"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientImplantableDeviceList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientImplantableDevice"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientLetterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientLetter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientLiabilityList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientLiability"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Patient"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientProblemList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientProblem"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientProviderTeamList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientProviderTeam"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPatientSmokingStatusList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PatientSmokingStatus"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPharmacyList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Pharmacy"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPhysicianList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Physician"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPracticeFaxList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PracticeFax"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPracticeList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Practice"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPracticePrintHeaderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PracticePrintHeader"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPracticeToStaffList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PracticeToStaff"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPrescriptionFillList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PrescriptionFill"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPublishedEventList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PublishedEvent"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPulmonaryCenterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PulmonaryCenter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPulmonaryOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PulmonaryOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedPulmonaryOrderTestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/PulmonaryOrderTest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedRecurringEventGroupList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/RecurringEventGroup"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedReferenceMedicationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ReferenceMedication"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedReferralOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ReferralOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedReportList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Report"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedReportTypeList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ReportType"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedRxHistoryDownloadList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/RxHistoryDownload"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedRxRefillRequestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/RxRefillRequest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedServiceLocationList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ServiceLocation"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedSleepCenterList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SleepCenter"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedSleepOrderList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SleepOrder"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedSleepOrderTestList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SleepOrderTest"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedStaffGroupList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/StaffGroup"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedSubscriptionList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedSupportMessageList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SupportMessage"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedThreadMemberList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ThreadMember"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedThreadMessageList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ThreadMessage"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedUserList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedVaccineList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Vaccine"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedVisitNoteList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/VisitNote"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedVisitNoteTemplateList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/VisitNoteTemplate"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedVisitNoteTypeList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/VisitNoteType"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedVitalsCollectionList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/VitalsCollection"},"type":"array"}},"required":["results"],"type":"object"},"PaginatedXmlPatientSummaryList":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/XmlPatientSummary"},"type":"array"}},"required":["results"],"type":"object"},"PatchedAddSignaturesToNote":{"properties":{"id":{"readOnly":true,"type":"integer"},"signatures":{"allOf":[{"$ref":"#/components/schemas/VisitNoteSignatureList"}],"description":"Requires special co-signature permissions. If enabled, users can add co-signatures to the visit note by providing them in this field."},"signed_by":{"description":"The user id of the provider who signed the visit note. (Requires special permission).","format":"int64","type":["integer","null"]},"signed_date":{"description":"The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).","format":"date-time","type":["string","null"]}},"type":"object"},"PatchedAppointment":{"properties":{"appointment_type_id":{"description":"The ID of an existing appointment type to assign to the appointment. Provide this instead of 'reason' to reference a specific appointment type rather than matching or creating one by name. If both 'reason' and 'appointment_type_id' are supplied, 'reason' takes precedence.","format":"int64","type":["integer","null"]},"billing_details":{"description":"The billing details for the appointment.","oneOf":[{"$ref":"#/components/schemas/AppointmentBillingDetails"},{"type":"null"}]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"type":["string","null"]},"duration":{"description":"The duration of the appointment in minutes. If duration is not provided, the default duration will be used given a reason.","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"instructions":{"type":["string","null"]},"is_blocking":{"readOnly":true,"type":"boolean"},"last_modified_date":{"format":"date-time","readOnly":true,"type":"string"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"mode":{"$ref":"#/components/schemas/ModeEnum"},"patient":{"format":"int64","type":["integer","null"]},"payment":{"oneOf":[{"$ref":"#/components/schemas/Payment"},{"type":"null"}]},"physician":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"reason":{"maxLength":50,"type":["string","null"]},"recurring_event_schedule":{"format":"int64","type":["integer","null"]},"scheduled_date":{"format":"date-time","type":"string"},"service_location":{"description":"The ID of the service location where the appointment will occur.","properties":{"address_line1":{"nullable":true,"type":"string"},"address_line2":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"created_date":{"format":"date-time","nullable":true,"type":"string"},"deleted_date":{"format":"date-time","nullable":true,"type":"string"},"id":{"format":"int64","type":"integer"},"is_primary":{"type":"boolean"},"name":{"type":"string"},"phone":{"nullable":true,"type":"string"},"place_of_service":{"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,31,32,33,34,41,42,49,50,51,52,53,54,55,56,57,60,61,62,65,66,71,72,81,99],"nullable":true,"type":"integer"},"state":{"nullable":true,"type":"string"},"zip":{"nullable":true,"type":"string"}},"type":["object","integer","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/AppointmentStatus"},{"type":"null"}]},"telehealth_details":{"deprecated":true,"type":["string","null"]},"time_slot_status":{"oneOf":[{"$ref":"#/components/schemas/TimeSlotStatusEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"time_slot_type":{"$ref":"#/components/schemas/TimeSlotTypeEnum"},"transportation_details":{"description":"The transportation details for the appointment.","oneOf":[{"$ref":"#/components/schemas/TransportationDetails"},{"type":"null"}]}},"type":"object"},"PatchedAppointmentType":{"properties":{"abbreviation":{"type":"string"},"color":{"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"default_duration":{"type":"integer"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"type":"string"},"elation_note_template_ids":{"items":{"type":"integer"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"is_telehealth":{"type":"boolean"},"name":{"type":"string"},"patient_bookable":{"type":"boolean"},"patient_form_hours_prior":{"type":"integer"},"patient_forms":{"items":{"type":"integer"},"type":"array"},"practice":{"format":"int64","type":"integer"},"sequence":{"readOnly":true,"type":"integer"},"visit_note_format":{"oneOf":[{"$ref":"#/components/schemas/VisitNoteFormatEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"visit_note_templates":{"items":{"format":"int64","type":"integer"},"type":"array"},"visit_note_type":{"format":"int64","type":["integer","null"]}},"type":"object"},"PatchedBillUpdate":{"properties":{"billing_date":{"description":"The date the bill was billed. Required if marking a bill as processed.","format":"date-time","type":["string","null"]},"billing_error":{"description":"The error message for the bill. Required if marking a bill as failed. This is the human readable error that users will see.","maxLength":200,"type":["string","null"]},"billing_provider":{"format":"int64","type":["integer","null"]},"billing_raw_error":{"description":"Further details on the billing error. Optional when marking a bill as failed. Useful when debugging why a bill failed to process.","type":["string","null"]},"cpts":{"description":"CPT objects for the bill.","items":{"$ref":"#/components/schemas/CPT"},"type":"array"},"metadata":{"additionalProperties":{},"type":"object"},"notes":{"description":"Additional billing notes.","maxLength":1000,"type":["string","null"]},"ordering_provider":{"description":"The id of the provider who orders non-physician services for the patient.","oneOf":[{"$ref":"#/components/schemas/ReferringProvider"},{"type":"null"}]},"payment_amount":{"description":"Dollar amount of the patient payment.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"place_of_service":{"oneOf":[{"$ref":"#/components/schemas/BillUpdatePlaceOfServiceEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"practice":{"format":"int64","type":"integer"},"prior_authorization":{"maxLength":50,"type":["string","null"]},"ref_number":{"description":"The reference number of the bill. Required if marking a bill as processed.","type":"string"},"referring_provider":{"oneOf":[{"$ref":"#/components/schemas/ReferringProvider"},{"type":"null"}]},"rendering_provider":{"format":"int64","type":["integer","null"]},"service_location":{"description":"The id of the service location the bill is associated with.","format":"int64","type":"integer"},"supervising_provider":{"description":"The id of the provider who has undertaken primary responsibility for the patient's health.","format":"int64","type":["integer","null"]},"visit_note":{"format":"int64","type":"integer"}},"type":"object"},"PatchedCPTCode":{"properties":{"charge":{"description":"The amount of money that will be charged for the code.","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","type":["string","null"]},"code":{"description":"The code that a user and integrators will see.","maxLength":10,"type":"string"},"description":{"description":"The description of the code that users will see.","maxLength":200,"type":"string"},"id":{"description":"The internal elation id of the billing code.","readOnly":true,"type":"integer"},"practice":{"description":"The practice who created the billing code.","format":"int64","type":"integer"},"sequence":{"description":"The position in the list of billing codes.","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"PatchedCardiacOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"cardiac_center":{"description":"The cardiac center the order is associated with.","format":"int64","type":["integer","null"]},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"medications":{"description":"Description of beta blockers/medications the patient is taking.","maxLength":400,"type":["string","null"]},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of cardiac tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/CardiacOrderTest"}]},"type":"array"}},"type":"object"},"PatchedCodedDocumentTag":{"properties":{"code":{"description":"The code of the tag.","maxLength":50,"type":["string","null"]},"code_type":{"description":"The type of the tag's code.","oneOf":[{"$ref":"#/components/schemas/CodeTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"concept_name":{"description":"The name of the tag's concept.","oneOf":[{"$ref":"#/components/schemas/ConceptNameEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"context":{"description":"The context of the tag. Choices = rejected, ordered or reviewed.","maxLength":15,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"maxLength":500,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"practice_created":{"description":"The id of the tag's practice.","format":"int64","type":["integer","null"]},"snomed_result_code":{"readOnly":true,"type":["string","null"]},"value":{"maxLength":100,"type":"string"}},"type":"object"},"PatchedContact":{"properties":{"accepting_insurance":{"description":"Whether the contact indicates they accept insurance.","type":["boolean","null"]},"accepting_new_patients":{"description":"Whether the contact indicates they are accepting new patients.","type":["boolean","null"]},"address":{"description":"The specific address line registered for this contact.","maxLength":200,"type":"string"},"back_office_phone":{"maxLength":20,"type":"string"},"cell_phone":{"description":"The mobile phone registered to the contact.","maxLength":20,"type":"string"},"city":{"description":"The city of the contact.","maxLength":50,"type":"string"},"contact_type":{"description":"The type of contact. {physician, medical_group}","maxLength":15,"type":"string"},"created_date":{"description":"The timestamp when the contact was created.","format":"date-time","readOnly":true,"type":["string","null"]},"credentials":{"description":"The credentials for the provider, e.g. MD or DO. Ignored if contact is a medical_group.","maxLength":200,"type":"string"},"deleted_date":{"description":"The timestamp when the contact was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"direct_address":{"maxLength":500,"type":"string"},"email":{"type":"string"},"fax":{"maxLength":15,"type":"string"},"first_name":{"description":"The first name of the contact. Ignored if contact is a medical_group.","maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_elation_confirmed":{"description":"Whether the contact has been verified by someone on the elation team to be available for search within the application. Will always be false for any contact created within a practice.","type":["boolean","null"]},"is_verified":{"description":"Whether the contact has been verified to be a available for search within the application. Will always be true for any contact created by a practice.","type":["boolean","null"]},"last_name":{"description":"The last name of the contact. Ignored if contact is a medical_group.","maxLength":60,"type":"string"},"middle_name":{"description":"The middle name of the contact. Ignored if contact is a medical_group.","maxLength":50,"type":"string"},"npi":{"type":"string"},"org_name":{"maxLength":100,"type":["string","null"]},"other_specialties":{"description":"The list of specialties after the primary specialty related to this contact.","items":{"allOf":[{"$ref":"#/components/schemas/MedicalSpecialty"}]},"type":"array"},"phone":{"maxLength":20,"type":"string"},"practice":{"description":"The id of the practice that the contact belongs to.","format":"int64","type":"integer"},"specialty":{"allOf":[{"$ref":"#/components/schemas/MedicalSpecialty"}],"description":"The id of the specialty of the contact."},"specialty_categories":{"items":{},"type":"array"},"state":{"description":"The state of the contact.","maxLength":2,"type":"string"},"suite":{"maxLength":20,"type":"string"},"user":{"description":"The user id of the contact.","readOnly":true,"type":"integer"},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"PatchedDataImportRequestDetail":{"description":"Main difference vs list is we don't want users changing the below fields after\ncreation and we want to show the import status","properties":{"id":{"readOnly":true,"type":"integer"},"notes":{"type":["string","null"]},"physician_id":{"format":"int64","readOnly":true,"type":"integer"},"practice_id":{"format":"int64","readOnly":true,"type":"integer"},"status":{"items":{"additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"}]},"type":"object"},"readOnly":true,"type":"array"},"time_created":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"PatchedFacilityIdentifier":{"properties":{"active":{"description":"Whether the facility identifier should be used. Should be true in most cases.","type":"boolean"},"bidi_connection":{"oneOf":[{"$ref":"#/components/schemas/BiDiLabConnection"},{"type":"null"}],"readOnly":true},"compendium":{"description":"The id of the compendium that will be used when the user selects this facility identifier.","format":"int64","type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"description":"The text that will displayed to users in the lab order dialog.","maxLength":255,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_connection":{"type":["integer","null"]},"lab_facility":{"description":"The id that represents the lab.","maxLength":50,"type":"string"},"practice":{"format":"int64","type":"integer"},"practice_facility":{"description":"The id that represents the practice; often an account number provided by the lab vendor.","maxLength":50,"type":"string"},"practice_secondary_id":{"type":["string","null"]},"user_facing":{"description":"Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.","type":"boolean"},"vendor":{"properties":{"display_name":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"}},"type":"object"}},"type":"object"},"PatchedHandout":{"description":"Contains only webhooks\nAll other fields inherited","properties":{"content":{"$ref":"#/components/schemas/Content"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"description":"The name of the handout.","maxLength":255,"type":"string"},"practice_created":{"format":"int64","type":"integer"},"received_date":{"format":"date-time","readOnly":true,"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/HandoutType"},"vis_barcode":{"description":"Should only be set if the type == VIS.","maxLength":30,"type":["string","null"]}},"type":"object"},"PatchedImagingOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"imaging_center":{"description":"The imaging center the order is associated with.","format":"int64","type":["integer","null"]},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"statmethod":{"description":"The type of report to get for the order if urgent.","maxLength":100,"type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of imaging tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ImagingOrderTest"}]},"type":"array"}},"type":"object"},"PatchedInsuranceCompanySingleInstance":{"properties":{"address":{"maxLength":200,"type":"string"},"aliases":{"description":"A string used to create alternate terms that will come up in search results (for example \"BC\" for Blue Cross).","maxLength":300,"type":["string","null"]},"carrier":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"eligibility_payer_id":{"maxLength":200,"type":["string","null"]},"extension":{"maxLength":6,"type":["string","null"]},"external_vendor_id":{"description":"The ID used by a vendor to represent the carrier in their system.","maxLength":200,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_type":{"description":"An enumerator representing the type of insurance the carrier offers.","oneOf":[{"$ref":"#/components/schemas/InsuranceTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"is_credentialed":{"description":"Whether or not the practice has credentials to submit claims to the carrier.","type":["boolean","null"]},"is_enrolled":{"type":["boolean","null"]},"patients":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"payer_id":{"description":"The Payer ID of the insurance carrier.","maxLength":200,"type":["string","null"]},"phone":{"maxLength":20,"type":["string","null"]},"plans":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"suite":{"maxLength":40,"type":["string","null"]},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"PatchedInsurancePlanSingleInstance":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"insurance_company":{"description":"The insurance company that the plan is associated with.","format":"int64","type":"integer"},"name":{"maxLength":200,"type":"string"},"patients":{"items":{"type":"integer"},"readOnly":true,"type":"array"},"practice":{"format":"int64","type":"integer"}},"type":"object"},"PatchedInternalPracticeNoteSerializerProxy":{"properties":{"document":{"description":"The report (document) ID this note belongs to","readOnly":true,"type":"integer"},"id":{"description":"The id of the internal note.","readOnly":true,"type":"integer"},"text":{"description":"The internal note text content","maxLength":256,"type":"string"}},"type":"object"},"PatchedLabOrder":{"properties":{"answers":{"description":"List of the answers provided for the Ask on Entry (AOE) questions if required by any lab order tests.","items":{"$ref":"#/components/schemas/LabOrderAOEAnswer"},"type":["array","null"]},"bill_type":{"description":"Who is financially responsible for the order.\n\n* `thirdparty` - Third Party (e.g. Insurance)\n* `patient` - Patient\n* `client` - Client\n* `workerscomp` - Worker's Comp\n* `specialbilling` - Special Billing","oneOf":[{"$ref":"#/components/schemas/BillTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"ccs":{"description":"List of physician ids who should be cc'd on any reports.","items":{"format":"int64","type":["integer","null"]},"type":"array"},"chart_date":{"description":"Date at which this order was first seen in the patient's chart.","format":"date-time","type":"string"},"confidential":{"default":false,"description":"Whether the provider has marked the order as confidential. Should not be shared with a patient.","type":"boolean"},"content":{"allOf":[{"$ref":"#/components/schemas/LabOrderContent"}],"description":"Represents the content of the lab order report."},"created_date":{"description":"Time at which elation created this order. Can be different from chart_date when the order was imported into a chart from a different source and document_date when documenting an order that happened at some other time.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"Time at which this order was created in whichever system created it. Could be historical or same as the create_date.","format":"date-time","type":"string"},"facility":{"description":"An identifier that represents the facility placing the order. Usually assigned by the lab vendor.","oneOf":[{"$ref":"#/components/schemas/FacilityIdentifier"},{"type":"null"}]},"follow_up_method":{"description":"Freetext field communicating how the patient should receive their results.","type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"ordering_physician":{"description":"The id of the physician who created the order.","format":"int64","type":"integer"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"practice":{"description":"The id of the practice.","format":"int64","type":"integer"},"printable_view":{"format":"uri","type":"string"},"requisition":{"description":"The requisition id of the order. Can be different from the order id if and when the order was created outside of Elation.","type":"integer"},"resolution":{"description":"The current state of the order's resolution.","oneOf":[{"$ref":"#/components/schemas/DocumentResolutionState"},{"type":"null"}]},"signed_by":{"description":"The id of the physician who signed off on the order.","format":"int64","type":["integer","null"]},"signed_date":{"description":"The time when the order was signed.","format":"date-time","type":["string","null"]},"site":{"description":"The location where the patient will have the lab performed. Sites are specific to their lab vendor.","oneOf":[{"$ref":"#/components/schemas/LabVendorPatientSite"},{"type":"null"}]},"special_insurance":{"description":"Used primarily to support specific electronic lab order integrations.","oneOf":[{"$ref":"#/components/schemas/PracticeSpecialInsuranceCodeName"},{"type":"null"}]},"specimens":{"description":"Record of any specimens collected when creating the order.","items":{"$ref":"#/components/schemas/LabOrderSpecimen"},"type":["array","null"]},"submissions":{"description":"Record of the attempts to submit.","items":{"$ref":"#/components/schemas/LabOrderSubmission"},"type":["array","null"]},"tags":{"description":"Any tags associated with the lab order.","items":{"format":"int64","type":["integer","null"]},"type":"array"},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"vendor":{"format":"int64","type":["integer","null"]}},"type":"object"},"PatchedLabOrderSet":{"properties":{"compendium_code":{"description":"RM-9598 Guard against missing code/name. Can't repro issue from ticket\n    locally so being extra careful with the guards here.","readOnly":true,"type":"string"},"content":{"$ref":"#/components/schemas/LabOrderContent"},"created_date":{"description":"Time at which elation created this order. Can be different from chart_date when the order was imported into a chart from a different source and document_date when documenting an order that happened at some other time.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":["integer","null"]},"name":{"description":"The name of the lab order set.","maxLength":250,"type":"string"},"practice":{"format":"int64","type":"integer"}},"type":"object"},"PatchedLabOrderTestCompendium":{"description":"The serializer for LabOrderTestCompendium","properties":{"code":{"maxLength":200,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":"integer"},"last_updated":{"format":"date-time","readOnly":true,"type":"string"},"name":{"maxLength":200,"type":"string"}},"type":"object"},"PatchedLabVendor":{"description":"The serializer for LabVendor","properties":{"bidi_connections":{"items":{"$ref":"#/components/schemas/BiDiLabConnection"},"readOnly":true,"type":"array"},"compendiums":{"items":{"$ref":"#/components/schemas/LabOrderTestCompendium"},"type":["array","null"]},"default_compendium":{"oneOf":[{"$ref":"#/components/schemas/LabOrderTestCompendium"},{"type":"null"}]},"display_name":{"maxLength":100,"type":"string"},"has_order_compendium":{"type":"boolean"},"has_test_compendium":{"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"is_bidi":{"type":"boolean"},"is_in_house":{"type":"boolean"},"name":{"maxLength":50,"type":"string"},"orders_integration_available":{"type":"boolean"},"practice_created":{"format":"int64","type":["integer","null"]},"results_integration_available":{"type":"boolean"}},"type":"object"},"PatchedLabVendorIntegration":{"description":"Serializer for non-internal usage to align better with APIv2 conventions","properties":{"allow_print":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"lab_vendor":{"format":"int64","type":"integer"},"orders_status":{"$ref":"#/components/schemas/LabVendorIntegrationStatus"},"practice":{"format":"int64","type":"integer"},"results_status":{"$ref":"#/components/schemas/LabVendorIntegrationStatus"}},"type":"object"},"PatchedLabVendorPatientSite":{"description":"The serializer for LabVendorPatientSite","properties":{"address":{"description":"The address of the site.","maxLength":200,"type":"string"},"city":{"description":"The city of the site.","maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":200,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice_created":{"format":"int64","type":["integer","null"]},"state":{"maxLength":2,"type":"string"},"suite":{"maxLength":40,"type":["string","null"]},"vendor":{"$ref":"#/components/schemas/LabVendorIdName"},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"PatchedLetter":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/LetterAttachment"},"type":"array"},"body":{"description":"The body of the letter.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"delivery_method":{"$ref":"#/components/schemas/DeliveryMethodEnum"},"direct_message_status":{"readOnly":true,"type":["string","null"]},"direct_message_to":{"maxLength":200,"type":["string","null"]},"display_to":{"readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"email_to":{"maxLength":200,"type":["string","null"]},"failure_unacknowledged":{"type":"string"},"fax_attachments":{"type":"boolean"},"fax_status":{"readOnly":true,"type":"string"},"fax_to":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_processed":{"readOnly":true,"type":"boolean"},"letter_type":{"readOnly":true,"type":"string"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"referral_order":{"format":"int64","type":["integer","null"]},"send_out":{"type":"boolean"},"send_to_contact":{"$ref":"#/components/schemas/SendToContact"},"send_to_elation_user":{"description":"If a letter is sent to another elation user, this will be that user's id.","readOnly":true,"type":"integer"},"send_to_name":{"maxLength":200,"type":["string","null"]},"sign_date":{"format":"date-time","type":["string","null"]},"signed_by":{"description":"The user who signed the letter.","format":"int64","type":["integer","null"]},"subject":{"description":"The subject of the letter (Not needed with referral_order).","maxLength":200,"type":"string"},"tags":{"description":"A list of Document Tags associated with the letter.","items":{"format":"int64","type":"integer"},"type":"array"},"to_number":{"readOnly":true,"type":["string","null"]},"viewed_at":{"format":"date-time","type":["string","null"]},"with_archive":{"type":"boolean"}},"type":"object"},"PatchedMedOrderTemplate":{"description":"Contains only webhooks\nAll other fields inherited","properties":{"auth_refills":{"maximum":99,"minimum":0,"type":["integer","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"directions":{"maxLength":300,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"medication":{"allOf":[{"$ref":"#/components/schemas/Medication"}],"description":"When creating, must contains only one from id, ndcs or rxnorm_cuis fields."},"practice":{"format":"int64","type":"integer"},"qty":{"format":"decimal","pattern":"^-?\\d{0,18}(?:\\.\\d{0,9})?$","type":["string","null"]},"qty_units":{"oneOf":[{"$ref":"#/components/schemas/QtyUnitsEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"rank":{"readOnly":true,"type":"integer"},"specific_ndc":{"type":["string","null"]}},"type":"object"},"PatchedMedicalSpecialty":{"properties":{"abbreviation":{"maxLength":20,"type":"string"},"category":{"$ref":"#/components/schemas/MedicalSpecialtyCategory"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":100,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]}},"type":"object"},"PatchedMedication":{"properties":{"active_ndcs":{"items":{"type":"string"},"type":"array"},"brand_name":{"readOnly":true,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"creation_type":{"allOf":[{"$ref":"#/components/schemas/MedicationDrugType"}],"default":"user","readOnly":true},"form":{"readOnly":true,"type":"string"},"generic_name":{"readOnly":true,"type":"string"},"id":{"description":"The id of the medication.","format":"int64","type":"integer"},"is_controlled":{"default":false,"description":"Whether the drug is a controlled substance or not.","type":"boolean"},"market_end_date":{"format":"date-time","type":["string","null"]},"name":{"description":"The name that will display for the medication in the search and when referenced by the prescription or documented med.","type":"string"},"ndcs":{"description":"The NDCs of the medication (must contain only one ndc code when creating).","items":{"type":"string"},"type":"array"},"obsolete_date":{"description":"The date at which this practice medication became obsolete.","format":"date-time","type":["string","null"]},"practice":{"description":"The practice that created the medication. `null` for medications from the standard formulary.","format":"int64","type":"integer"},"route":{"readOnly":true,"type":"string"},"rxnorm_cuis":{"description":"The Rxnorm.cui code of the medication (must contain only one cui code when creating).","items":{"type":"string"},"type":"array"},"strength":{"description":"The strength of the drug, e.g. 40mg.","maxLength":255,"type":["string","null"]},"type":{"allOf":[{"$ref":"#/components/schemas/MedicationType"}],"default":"prescription","description":"Whether the practice medication is an OTC or Prescription drug.\n\n* `otc` - otc\n* `prescription` - prescription\n* `discontinued` - discontinued"}},"type":"object"},"PatchedMessageThread":{"properties":{"chart_date":{"description":"When the message thread's patient chart was created.","format":"date-time","type":"string"},"created_date":{"description":"When the message thread was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"When the message thread was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"document_date":{"description":"When the message thread's document was created.","format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"is_urgent":{"default":false,"description":"Whether the message is currently urgent.","type":"boolean"},"members":{"description":"List of Thread Members, when creating only need to specify the id of the thread member and their status.","items":{"$ref":"#/components/schemas/ThreadMember"},"type":"array"},"messages":{"description":"List of Thread Messages, when creating only need to provide the body, send_date and sender.","items":{"$ref":"#/components/schemas/ThreadMessage"},"type":"array"},"patient":{"description":"The patient chart for which the thread is about.","format":"int64","type":"integer"},"practice":{"description":"The id of the practice that owns the patient chart.","format":"int64","type":"integer"},"signed_by":{"description":"The user who signed the thread","format":"int64","type":["integer","null"]},"signed_date":{"description":"The date and time when the thread was signed","format":"date-time","type":["string","null"]}},"type":"object"},"PatchedNonVisitNote":{"properties":{"bullets":{"description":"The bullets of the non visit note.","items":{"$ref":"#/components/schemas/NonVisitNoteBullet"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"note_documents":{"description":"The documents referenced by the non visit note.","items":{"oneOf":[{"$ref":"#/components/schemas/NonVisitNoteDocument"},{"type":"null"}]},"type":"array"},"note_items":{"description":"The items in the clinical record on the left hand side of the chart referenced by the non visit note.","items":{"oneOf":[{"$ref":"#/components/schemas/NonVisitNotePatientItem"},{"type":"null"}]},"type":"array"},"patient":{"format":"int64","type":"integer"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"tags":{"description":"The ids of the document tags you want to attach.","items":{"format":"int64","type":"integer"},"type":"array"},"type":{"description":"The type of the non visit note.","type":"string"}},"type":"object"},"PatchedPatient":{"properties":{"actual_name":{"maxLength":150,"type":["string","null"]},"address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"caregiver_practice":{"format":"int64","type":"integer"},"consents":{"items":{"$ref":"#/components/schemas/Consent"},"type":"array"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_insurances":{"items":{"$ref":"#/components/schemas/Insurance"},"readOnly":true,"type":"array"},"dob":{"format":"date","type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":["array","null"]},"emergency_contact":{"oneOf":[{"$ref":"#/components/schemas/EmergencyContact"},{"type":"null"}]},"employer":{"oneOf":[{"$ref":"#/components/schemas/Employer"},{"type":"null"}]},"ethnicity":{"$ref":"#/components/schemas/EthnicityEnum"},"first_name":{"maxLength":70,"type":"string"},"gender_identity":{"$ref":"#/components/schemas/GenderIdentityEnum"},"guarantor":{"oneOf":[{"$ref":"#/components/schemas/Guarantor"},{"type":"null"}]},"id":{"readOnly":true,"type":"integer"},"insurances":{"items":{"$ref":"#/components/schemas/Insurance"},"type":"array"},"last_modified":{"format":"date-time","type":"string"},"last_name":{"maxLength":70,"type":"string"},"legal_gender_marker":{"oneOf":[{"$ref":"#/components/schemas/LegalGenderMarkerEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"legal_gender_marker_display":{"oneOf":[{"$ref":"#/components/schemas/LegalGenderMarkerDisplayEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"master_patient":{"format":"int64","readOnly":true,"type":"integer"},"merged_into_chart":{"readOnly":true,"type":["integer","null"]},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"middle_name":{"maxLength":50,"type":"string"},"mothers_maiden_name":{"maxLength":70,"type":["string","null"]},"notes":{"type":["string","null"]},"occupation":{"maxLength":100,"readOnly":true,"type":["string","null"]},"patient_status":{"oneOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}]},"phones":{"items":{"$ref":"#/components/schemas/Phone"},"type":"array"},"preference":{"oneOf":[{"$ref":"#/components/schemas/PatientPreference"},{"type":"null"}]},"preferred_contact":{"oneOf":[{"$ref":"#/components/schemas/PreferredContactEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"preferred_language":{"type":["string","null"]},"preferred_service_location":{"format":"int64","type":["integer","null"]},"previous_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"previous_first_name":{"maxLength":70,"type":["string","null"]},"previous_last_name":{"maxLength":70,"type":["string","null"]},"previous_name":{"oneOf":[{"$ref":"#/components/schemas/PatientPreviousName"},{"type":"null"}]},"primary_care_provider":{"description":"A read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider.","format":"int64","readOnly":true,"type":"integer"},"primary_care_provider_npi":{"description":"Represents the patient's primary care provider. This person may be in a different practice.","maxLength":10,"type":["string","null"]},"primary_physician":{"description":"Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.","format":"int64","type":"integer"},"pronouns":{"oneOf":[{"$ref":"#/components/schemas/PronounsEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"pronouns_display":{"oneOf":[{"$ref":"#/components/schemas/PronounsDisplayEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"race":{"$ref":"#/components/schemas/RaceEnum"},"sex":{"allOf":[{"$ref":"#/components/schemas/PatientSexEnum"}],"default":"Unknown"},"sexual_orientation":{"$ref":"#/components/schemas/SexualOrientationEnum"},"sms_opt_in_status":{"type":["boolean","null"]},"ssn":{"maxLength":37,"type":["string","null"]},"suffix":{"maxLength":20,"type":"string"},"tags":{"items":{},"type":["array","null"]},"timezone":{"oneOf":[{"$ref":"#/components/schemas/TimezoneEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"verified":{"default":true,"type":"boolean"},"vip":{"type":["boolean","null"]}},"type":"object"},"PatchedPatientAllergy":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"medispandnid":{"readOnly":true,"type":"string"},"medispanid":{"readOnly":true,"type":"string"},"name":{"description":"The name of the allergy drug.","type":"string"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"reaction":{"description":"The reaction to the drug.","maxLength":200,"type":["string","null"]},"severity":{"allOf":[{"$ref":"#/components/schemas/PatientAllergySeverityEnum"}],"description":"How severe the reaction is."},"start_date":{"description":"The date the allergy started.","format":"date","type":["string","null"]},"status":{"$ref":"#/components/schemas/AllergyStatus"}},"type":"object"},"PatchedPatientChartImportDetail":{"description":"This space intentionally left blank","properties":{"chart_json":{},"data_import_id":{"format":"int64","readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"import_errors":{"readOnly":true,"type":["string","null"]},"patient_id":{"type":"integer"},"section_status_json":{"readOnly":true,"type":"string"},"source_patient_id":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/PatientChartImportStatus"}],"default":"open"},"time_completed":{"format":"date-time","readOnly":true,"type":["string","null"]},"time_started_processing":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"PatchedPatientDrugIntolerance":{"properties":{"created_date":{"description":"When the record was created in Elation's systems.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"When the record was recorded deleted in Elation's systems.","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"description":"The Drug Intolerance's name; e.g. what drug the patient cannot tolerate.","type":"string"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"reaction":{"description":"The type of reaction the patient experiences when taking the drug","maxLength":200,"type":["string","null"]},"severity":{"description":"The severity of the patient's reaction.\n\n* `` - unknown\n* `255604002` - mild\n* `6736007` - moderate\n* `24484000` - severe","oneOf":[{"$ref":"#/components/schemas/PatientDrugIntoleranceSeverityEnum"},{"$ref":"#/components/schemas/BlankEnum"}]},"start_date":{"description":"The date of onset for the drug intolerance.","format":"date","type":["string","null"]},"status":{"allOf":[{"$ref":"#/components/schemas/PatientDrugIntoleranceStatusEnum"}],"description":"Whether the drug intolerance is active or not.\n\n* `1` - Active\n* `2` - Inactive","maximum":65535,"minimum":0}},"type":"object"},"PatchedPatientFormRequest":{"properties":{"appointment":{"description":"The ID of an appointment to associate with this form request. When the appointment is in the past, the notification_date validation is skipped.","format":"int64","type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"forms_url":{"format":"uri","readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"notification_date":{"description":"This is the date that the request will appear in the Practice's action queue. Must be in the future unless an appointment in the past is provided. Defaults to one week from today.","format":"date","type":"string"},"patient":{"description":"The ID of the patient that should be associated with the request.","format":"int64","type":"integer"},"patient_forms":{"description":"The IDs of the forms that should be associated to the request. Please note that you must create these forms before trying to create a request.","items":{"type":"integer"},"type":"array"},"practice":{"readOnly":true,"type":"integer"}},"type":"object"},"PatchedPatientLetter":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/LetterAttachment"},"type":"array"},"body":{"type":"string"},"category":{"format":"int64","readOnly":true,"type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"files":{"description":"Files attached to this letter. Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references.","items":{"$ref":"#/components/schemas/S3RetrievingDocumentFile"},"type":["array","null"]},"id":{"readOnly":true,"type":"integer"},"is_patient_initiated":{"type":["boolean","null"]},"is_processed":{"readOnly":true,"type":"boolean"},"letter_type":{"readOnly":true,"type":"string"},"patient":{"format":"int64","type":"integer"},"patient_read_time":{"format":"date-time","type":["string","null"]},"practice":{"format":"int64","type":"integer"},"send_out":{"type":"boolean"},"send_to_patient":{"readOnly":true,"type":"boolean"},"sign_date":{"format":"date-time","type":["string","null"]},"signed_by":{"description":"The user who signed the letter.","format":"int64","type":["integer","null"]},"subject":{"maxLength":200,"type":"string"},"tags":{"description":"A list of Document Tags associated with the letter.","items":{"format":"int64","type":"integer"},"type":"array"},"viewed_at":{"format":"date-time","type":["string","null"]}},"type":"object"},"PatchedPatientProblem":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"maxLength":200,"type":"string"},"dx":{"description":"The diagnoses for imo codes.","items":{"$ref":"#/components/schemas/ImoCodeRelation"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"rank":{"type":"integer"},"resolved_date":{"description":"Date the problem was resolved. Set only if `status` is `Resolved`.","format":"date","type":["string","null"]},"start_date":{"format":"date","type":"string"},"status":{"$ref":"#/components/schemas/PatientProblemStatusEnum"},"synopsis":{"type":"string"},"verification_status":{"oneOf":[{"$ref":"#/components/schemas/VerificationStatusEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]}},"type":"object"},"PatchedPatientProviderTeamMemberUpdate":{"properties":{"activity_summary_last_refreshed":{"description":"The last known time when this team member's activity was synced.","format":"date-time","readOnly":true,"type":"string"},"earliest_activity":{"description":"Displays the earliest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"group":{"allOf":[{"$ref":"#/components/schemas/GroupEnum"}],"default":"main","description":"Can either be `main` or `other`. By default members are placed in the `main` group. Only members in the `main` group will be displayed on the Patient chart in the web application.\n\n* `main` - main\n* `other` - other"},"latest_activity":{"description":"Displays the latest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"patient_id":{"description":"The id of the Patient that this team is associated with.","readOnly":true,"type":"integer"},"patient_provider_team_id":{"description":"Patient Provider team ID","readOnly":true,"type":"integer"},"patient_provider_team_member_id":{"readOnly":true,"type":"integer"},"physician_id":{"description":"The Physician that this team member represents.","readOnly":true,"type":"integer"},"rank":{"description":"Used for displaying a sorted patient provider team in the patient chart. Rank is sequential and begins at 1.","minimum":1,"readOnly":true,"type":"integer"},"treatment_reason":{"description":"The reason why this physician is in this team","type":["string","null"]}},"type":"object"},"PatchedPhysician":{"properties":{"credentials":{"maxLength":20,"type":["string","null"]},"email":{"format":"email","type":"string"},"fax":{"description":"The physician's fax number.","readOnly":true,"type":"string"},"first_name":{"maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"description":"Whether or not the physician is still active at the practice.","readOnly":true,"type":"boolean"},"last_name":{"maxLength":60,"type":"string"},"license":{"type":"string"},"license_state":{"type":"string"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"npi":{"type":"string"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"specialty":{"readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":["integer","null"]}},"type":"object"},"PatchedPractice":{"properties":{"address_line1":{"maxLength":200,"type":"string"},"address_line2":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"elation_root_oid":{"readOnly":true,"type":"string"},"employers":{"items":{"$ref":"#/components/schemas/Employer"},"readOnly":true,"type":["array","null"]},"id":{"readOnly":true,"type":"integer"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"name":{"maxLength":200,"type":"string"},"physicians":{"items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"service_locations":{"items":{"$ref":"#/components/schemas/ServiceLocation"},"readOnly":true,"type":["array","null"]},"state":{"maxLength":2,"type":"string"},"status":{"default":"active","readOnly":true,"type":"string"},"timezone":{"readOnly":true,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"type":"object"},"PatchedPublishedEvent":{"properties":{"error_content":{"type":["string","null"]},"event_id":{"readOnly":true,"type":"integer"},"event_type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"processed_date":{"format":"date-time","type":"string"},"resource":{"readOnly":true,"type":"string"},"resource_id":{"readOnly":true,"type":"integer"},"status_code":{"maximum":2147483647,"minimum":-2147483648,"type":["integer","null"]},"target":{"readOnly":true,"type":"string"}},"type":"object"},"PatchedPulmonaryOrder":{"properties":{"allergies":{"description":"Any allergies the patient has.","type":["string","null"]},"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"pulmonary_center":{"description":"The pulmonary center the order is associated with.","format":"int64","type":["integer","null"]},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of pulmonary tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/PulmonaryOrderTest"}]},"type":"array"}},"type":"object"},"PatchedReferralOrder":{"properties":{"auth_number":{"maxLength":20,"type":["string","null"]},"authorization_for":{"oneOf":[{"$ref":"#/components/schemas/AuthorizationForEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"authorization_for_short":{"type":["string","null"]},"consultant_name":{"maxLength":1024,"type":["string","null"]},"date_for_reEval":{"format":"date","type":["string","null"]},"icd10_codes":{"items":{"$ref":"#/components/schemas/ICD10Code"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"letter":{"deprecated":true,"description":"The letter associated with this referral order. Use referral_letter for the full nested letter object.","format":"int64","readOnly":true,"type":"integer"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"referral_letter":{"allOf":[{"$ref":"#/components/schemas/ReferralLetter"}],"description":"Nested letter object with full details.","readOnly":true},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"short_consultant_name":{"maxLength":1024,"type":["string","null"]},"sign_date":{"description":"The datetime when this referral order was signed.","format":"date-time","readOnly":true,"type":["string","null"]},"signed_by":{"description":"The ID of the user who signed this referral order.","readOnly":true,"type":"integer"},"specialty":{"$ref":"#/components/schemas/MedicalSpecialty"}},"type":"object"},"PatchedServiceLocation":{"properties":{"address_line1":{"description":"The service location address.","type":"string"},"address_line2":{"description":"The service location suite.","type":"string"},"city":{"default":"","maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"email":{"format":"email","maxLength":254,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_primary":{"default":false,"type":"boolean"},"name":{"maxLength":200,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"place_of_service":{"$ref":"#/components/schemas/ServiceLocationPlaceOfServiceEnum"},"place_of_service_code":{"type":"integer"},"practice":{"description":"The id of the practice that the service location belongs to.","format":"int64","type":"integer"},"state":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/ServiceLocationStatusEnum"}],"default":"active","readOnly":true},"timezone":{"oneOf":[{"$ref":"#/components/schemas/TimezoneEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"zip":{"default":"","maxLength":10,"type":"string"}},"type":"object"},"PatchedSleepOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"sleep_center":{"description":"The sleep center the order is associated with.","format":"int64","type":["integer","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of sleep tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/SleepOrderTest"}]},"type":"array"}},"type":"object"},"PatchedStaffGroup":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_elation_group":{"description":"Whether the staff group is an Elation group.","type":"boolean"},"name":{"description":"The name of the staff group.","maxLength":50,"type":"string"},"practice":{"description":"The id of the practice that the staff group belongs to.","format":"int64","type":"integer"},"users":{"description":"A list of user ids inside the group.","items":{"type":"integer"},"type":"array"}},"type":"object"},"PatchedThreadMember":{"properties":{"ack_time":{"description":"The time at which the member acknowledged the message thread.","format":"date-time","type":"string"},"group":{"description":"The id of the group referenced by this thread member. Should only ever be one of either a user or group set for the thread member.","format":"int64","type":["integer","null"]},"id":{"readOnly":true,"type":"integer"},"status":{"allOf":[{"$ref":"#/components/schemas/ThreadMemberStatusEnum"}],"description":"Whether this member has acknowledged the message thread."},"thread":{"description":"The id of the thread this thread member is a member of.","format":"int64","type":"integer"},"user":{"description":"The id of the user referenced by this thread member. Should only ever be one of either a user or group set for the thread member.","type":["integer","null"]}},"type":"object"},"PatchedUpdateReport":{"properties":{"id":{"readOnly":true,"type":"integer"},"is_urgent":{"default":false,"type":"boolean"},"signed_by":{"description":"Signer to apply.","format":"int64","type":["integer","null"]},"signed_date":{"description":"Signature timestamp to apply.","format":"date-time","type":["string","null"]}},"type":"object"},"PatchedUser":{"properties":{"account_type":{"oneOf":[{"$ref":"#/components/schemas/AccountTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"credentialed":{"default":false,"type":"boolean"},"email":{"maxLength":255,"type":"string"},"first_name":{"maxLength":50,"type":"string"},"has_chart_access":{"default":true,"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"is_practice_admin":{"default":false,"type":"boolean"},"is_read_only":{"default":false,"type":"boolean"},"last_name":{"maxLength":60,"type":"string"},"physician_qualifications":{"$ref":"#/components/schemas/PhysicianQualifications"},"practice":{"format":"int64","type":"integer"},"user_type":{"$ref":"#/components/schemas/UserTypeEnum"}},"type":"object"},"PatchedVisitNoteTemplate":{"properties":{"content":{"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":50,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]}},"type":"object"},"PatchedVisitNoteType":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_mu_office_visit":{"type":"boolean"},"name":{"maxLength":50,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]},"rank":{"readOnly":true,"type":"integer"},"snomed_code":{"$ref":"#/components/schemas/SnomedCode"}},"type":"object"},"PatchedVitalsCollection":{"properties":{"bmi":{"format":"double","type":["number","null"]},"bmi_percentile":{"description":"The BMI percentile of the patient. Optional. Will be automatically calculated from height and weight otherwise.","readOnly":true,"type":["integer","null"]},"bp":{"description":"The blood pressure of the patient. Will allow multiple items in array.","items":{"$ref":"#/components/schemas/VitalBP"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"custom_observations":{"additionalProperties":{"properties":{"label":{"type":"string"},"note":{"type":["string","null"]},"units":{"type":["string","null"]},"value":{"type":"string"}},"type":"object"},"type":"object"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"hc":{"description":"The head circumference of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHC"},"type":"array"},"height":{"description":"The height of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHeight"},"type":"array"},"hr":{"description":"The heart rate of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHR"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"length_for_weight_percentile":{"description":"The length for weight percentile for the patient.","format":"double","readOnly":true,"type":["number","null"]},"non_visit_note":{"description":"The non-visit note that the vital belongs to. Will only allow unsigned non-visit notes.","format":"int64","type":["integer","null"]},"oxygen":{"description":"The oxygen saturation of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalOxygen"},"type":"array"},"pain":{"description":"The pain of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalPain"},"type":"array"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"rr":{"description":"The respiratory rate of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalRR"},"type":"array"},"signed_by":{"format":"int64","readOnly":true,"type":"integer"},"signed_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"temperature":{"description":"The temperature of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalTemperature"},"type":"array"},"visit_note":{"description":"The visit note that the vital belongs to. Will only allow unsigned visit notes.","format":"int64","type":["integer","null"]},"weight":{"description":"The weight of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalWeight"},"type":"array"}},"type":"object"},"Patient":{"properties":{"actual_name":{"maxLength":150,"type":["string","null"]},"address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"caregiver_practice":{"format":"int64","type":"integer"},"consents":{"items":{"$ref":"#/components/schemas/Consent"},"type":"array"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_insurances":{"items":{"$ref":"#/components/schemas/Insurance"},"readOnly":true,"type":"array"},"dob":{"format":"date","type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":["array","null"]},"emergency_contact":{"oneOf":[{"$ref":"#/components/schemas/EmergencyContact"},{"type":"null"}]},"employer":{"oneOf":[{"$ref":"#/components/schemas/Employer"},{"type":"null"}]},"ethnicity":{"$ref":"#/components/schemas/EthnicityEnum"},"first_name":{"maxLength":70,"type":"string"},"gender_identity":{"$ref":"#/components/schemas/GenderIdentityEnum"},"guarantor":{"oneOf":[{"$ref":"#/components/schemas/Guarantor"},{"type":"null"}]},"id":{"readOnly":true,"type":"integer"},"insurances":{"items":{"$ref":"#/components/schemas/Insurance"},"type":"array"},"last_modified":{"format":"date-time","type":"string"},"last_name":{"maxLength":70,"type":"string"},"legal_gender_marker":{"oneOf":[{"$ref":"#/components/schemas/LegalGenderMarkerEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"legal_gender_marker_display":{"oneOf":[{"$ref":"#/components/schemas/LegalGenderMarkerDisplayEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"master_patient":{"format":"int64","readOnly":true,"type":"integer"},"merged_into_chart":{"readOnly":true,"type":["integer","null"]},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"middle_name":{"maxLength":50,"type":"string"},"mothers_maiden_name":{"maxLength":70,"type":["string","null"]},"notes":{"type":["string","null"]},"occupation":{"maxLength":100,"readOnly":true,"type":["string","null"]},"patient_status":{"oneOf":[{"$ref":"#/components/schemas/Status"},{"type":"null"}]},"phones":{"items":{"$ref":"#/components/schemas/Phone"},"type":"array"},"preference":{"oneOf":[{"$ref":"#/components/schemas/PatientPreference"},{"type":"null"}]},"preferred_contact":{"oneOf":[{"$ref":"#/components/schemas/PreferredContactEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"preferred_language":{"type":["string","null"]},"preferred_service_location":{"format":"int64","type":["integer","null"]},"previous_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"previous_first_name":{"maxLength":70,"type":["string","null"]},"previous_last_name":{"maxLength":70,"type":["string","null"]},"previous_name":{"oneOf":[{"$ref":"#/components/schemas/PatientPreviousName"},{"type":"null"}]},"primary_care_provider":{"description":"A read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider.","format":"int64","readOnly":true,"type":"integer"},"primary_care_provider_npi":{"description":"Represents the patient's primary care provider. This person may be in a different practice.","maxLength":10,"type":["string","null"]},"primary_physician":{"description":"Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.","format":"int64","type":"integer"},"pronouns":{"oneOf":[{"$ref":"#/components/schemas/PronounsEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"pronouns_display":{"oneOf":[{"$ref":"#/components/schemas/PronounsDisplayEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"race":{"$ref":"#/components/schemas/RaceEnum"},"sex":{"allOf":[{"$ref":"#/components/schemas/PatientSexEnum"}],"default":"Unknown"},"sexual_orientation":{"$ref":"#/components/schemas/SexualOrientationEnum"},"sms_opt_in_status":{"type":["boolean","null"]},"ssn":{"maxLength":37,"type":["string","null"]},"suffix":{"maxLength":20,"type":"string"},"tags":{"items":{},"type":["array","null"]},"timezone":{"oneOf":[{"$ref":"#/components/schemas/TimezoneEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"verified":{"default":true,"type":"boolean"},"vip":{"type":["boolean","null"]}},"required":["caregiver_practice","dob","first_name","last_name","primary_physician","sex"],"type":"object"},"PatientAllergy":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"medispandnid":{"readOnly":true,"type":"string"},"medispanid":{"readOnly":true,"type":"string"},"name":{"description":"The name of the allergy drug.","type":"string"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"reaction":{"description":"The reaction to the drug.","maxLength":200,"type":["string","null"]},"severity":{"allOf":[{"$ref":"#/components/schemas/PatientAllergySeverityEnum"}],"description":"How severe the reaction is."},"start_date":{"description":"The date the allergy started.","format":"date","type":["string","null"]},"status":{"$ref":"#/components/schemas/AllergyStatus"}},"required":["name","patient"],"type":"object"},"PatientAllergyDocumentation":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"patient":{"format":"int64","type":"integer"}},"required":["patient"],"type":"object"},"PatientAllergySeverityEnum":{"enum":["mild","moderate","severe","unknown"],"type":"string"},"PatientChartImport":{"description":"This space intentionally left blank","properties":{"data_import_id":{"format":"int64","readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"import_errors":{"readOnly":true,"type":["string","null"]},"patient_id":{"type":"integer"},"section_status_json":{"readOnly":true,"type":"string"},"source_patient_id":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/PatientChartImportStatus"}],"default":"open"},"time_completed":{"format":"date-time","readOnly":true,"type":["string","null"]},"time_started_processing":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"PatientChartImportDetail":{"description":"This space intentionally left blank","properties":{"chart_json":{},"data_import_id":{"format":"int64","readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"import_errors":{"readOnly":true,"type":["string","null"]},"patient_id":{"type":"integer"},"section_status_json":{"readOnly":true,"type":"string"},"source_patient_id":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/PatientChartImportStatus"}],"default":"open"},"time_completed":{"format":"date-time","readOnly":true,"type":["string","null"]},"time_started_processing":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"PatientChartImportStatus":{"description":"* `completed` - Completed\n* `failed` - Failed\n* `not_applicable` - Not Applicable\n* `open` - Open\n* `pending` - Pending\n* `processing` - Processing","enum":["completed","failed","not_applicable","open","pending","processing"],"type":"string"},"PatientDrugIntolerance":{"properties":{"created_date":{"description":"When the record was created in Elation's systems.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"When the record was recorded deleted in Elation's systems.","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"description":"The Drug Intolerance's name; e.g. what drug the patient cannot tolerate.","type":"string"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"reaction":{"description":"The type of reaction the patient experiences when taking the drug","maxLength":200,"type":["string","null"]},"severity":{"description":"The severity of the patient's reaction.\n\n* `` - unknown\n* `255604002` - mild\n* `6736007` - moderate\n* `24484000` - severe","oneOf":[{"$ref":"#/components/schemas/PatientDrugIntoleranceSeverityEnum"},{"$ref":"#/components/schemas/BlankEnum"}]},"start_date":{"description":"The date of onset for the drug intolerance.","format":"date","type":["string","null"]},"status":{"allOf":[{"$ref":"#/components/schemas/PatientDrugIntoleranceStatusEnum"}],"description":"Whether the drug intolerance is active or not.\n\n* `1` - Active\n* `2` - Inactive","maximum":65535,"minimum":0}},"required":["name","patient"],"type":"object"},"PatientDrugIntoleranceSeverityEnum":{"description":"* `` - unknown\n* `255604002` - mild\n* `6736007` - moderate\n* `24484000` - severe","enum":["255604002","6736007","24484000"],"type":"string"},"PatientDrugIntoleranceStatusEnum":{"description":"* `1` - Active\n* `2` - Inactive","enum":[1,2],"type":"integer"},"PatientFamilyHistory":{"properties":{"created_date":{"description":"The date the family history was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The date the family history was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"icd9_code":{"description":"The icd9 code of the family history.","type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"rank":{"type":"integer"},"relationship":{"allOf":[{"$ref":"#/components/schemas/PatientFamilyHistoryRelationshipEnum"}],"description":"The relationship of the family member of the family history."},"snomed_code":{"description":"The SNOMED code for the family history.","type":["string","null"]},"text":{"description":"The value (or text) of the family history.","type":"string"}},"required":["patient","relationship"],"type":"object"},"PatientFamilyHistoryRelationshipEnum":{"enum":["Aunt","Brother","Daughter","Father","Grandfather","Grandmother","Mother","Other","Sister","Son","Uncle"],"type":"string"},"PatientForm":{"properties":{"appointment_types":{"items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"created_by":{"type":["integer","null"]},"created_date":{"format":"date-time","type":"string"},"deleted_by":{"type":["integer","null"]},"deleted_date":{"format":"date-time","type":"string"},"form_name":{"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_modified_by":{"type":["integer","null"]},"last_modified_date":{"format":"date-time","type":"string"},"practice":{"format":"int64","type":"integer"},"sequence":{"maximum":65535,"minimum":0,"type":"integer"},"topics":{}},"required":["created_date","deleted_date","form_name","last_modified_date","practice","sequence","topics"],"type":"object"},"PatientFormRequest":{"properties":{"appointment":{"description":"The ID of an appointment to associate with this form request. When the appointment is in the past, the notification_date validation is skipped.","format":"int64","type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"forms_url":{"format":"uri","readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"notification_date":{"description":"This is the date that the request will appear in the Practice's action queue. Must be in the future unless an appointment in the past is provided. Defaults to one week from today.","format":"date","type":"string"},"patient":{"description":"The ID of the patient that should be associated with the request.","format":"int64","type":"integer"},"patient_forms":{"description":"The IDs of the forms that should be associated to the request. Please note that you must create these forms before trying to create a request.","items":{"type":"integer"},"type":"array"},"practice":{"readOnly":true,"type":"integer"}},"required":["patient","patient_forms"],"type":"object"},"PatientFormSubmission":{"properties":{"appointment":{"description":"ID of the appointment this submission is linked to.","format":"int64","type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"Date of the clinical document. For past appointments, set this to the appointment date so the record appears at the correct position in the chart feed.","format":"date-time","type":["string","null"]},"form_name":{"readOnly":true,"type":"string"},"form_response_json":{"description":"Form response data in the patient form submission JSON format."},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"ID of the patient.","format":"int64","type":"integer"},"patient_form":{"description":"ID of the PatientForm to create a response for.","format":"int64","type":"integer"},"reported_date_time":{"description":"Date and time the form was reported.","format":"date-time","type":["string","null"]},"topics":{"readOnly":true}},"required":["form_response_json","patient","patient_form"],"type":"object"},"PatientHistory":{"properties":{"created_date":{"description":"The date the history was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The date the history was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The id of the patient.","format":"int64","type":"integer"},"rank":{"description":"The rank (or sequence) of the history.","maximum":65535,"minimum":0,"type":"integer"},"text":{"description":"The value (or text) of the history.","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PatientHistoryTypeEnum"}],"description":"The type of the history."}},"required":["patient","text","type"],"type":"object"},"PatientHistoryTypeEnum":{"enum":["Cognitive Status","Consultation","Diet","Exercise","Family","Functional Status","Habits","Health Maintenance","Immunization","Legal","Past","Past Surgical","Psychological","Social"],"type":"string"},"PatientId":{"properties":{"id":{"format":"int64","type":"integer"}},"required":["id"],"type":"object"},"PatientImmunization":{"properties":{"administered_date":{"format":"date-time","type":"string"},"administering_physician":{"format":"int64","type":["integer","null"]},"allowed_sharing":{"description":"Whether this immunization should be sent to Immunization Registry (true/false/null)","type":["boolean","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"maxLength":255,"type":["string","null"]},"dose_in_series":{"maximum":2147483647,"minimum":-2147483648,"type":["integer","null"]},"expiration_date":{"format":"date","type":["string","null"]},"funding_source":{"oneOf":[{"$ref":"#/components/schemas/FundingSourceEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"id":{"readOnly":true,"type":"integer"},"info_source":{"oneOf":[{"$ref":"#/components/schemas/InfoSourceEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"lot_number":{"maxLength":255,"type":["string","null"]},"manufacturer_code":{"maxLength":255,"type":["string","null"]},"manufacturer_name":{"maxLength":255,"type":["string","null"]},"method":{"maxLength":255,"type":["string","null"]},"ndc":{"description":"Should be 10-11 digits, 2 dashes.","maxLength":31,"type":["string","null"]},"notes":{"type":["string","null"]},"ordering_physician":{"format":"int64","type":["integer","null"]},"patient":{"format":"int64","type":"integer"},"patient_consent":{"type":["boolean","null"]},"practice":{"format":"int64","type":["integer","null"]},"priority_population":{"description":"For Immunization Registry Integrations (less than 9 symbols).","maxLength":8,"type":["string","null"]},"publicity_code":{"oneOf":[{"$ref":"#/components/schemas/PublicityCodeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"qty":{"type":["string","null"]},"qty_units":{"maxLength":100,"type":["string","null"]},"reason":{"type":["string","null"]},"service_location_id":{"format":"int64","type":["integer","null"]},"site":{"maxLength":255,"type":["string","null"]},"vaccine":{"$ref":"#/components/schemas/ImmunizationVaccine"},"vfc_eligibility":{"oneOf":[{"$ref":"#/components/schemas/VfcEligibilityEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"vis":{"type":["string","null"]},"vis_given_date":{"format":"date","type":["string","null"]}},"required":["administered_date","administering_physician","ordering_physician","patient","qty","vaccine"],"type":"object"},"PatientImplantableDevice":{"properties":{"brand_name":{"maxLength":255,"type":"string"},"company_name":{"maxLength":255,"type":"string"},"contains_rubber_latex":{"type":["boolean","null"]},"device_description":{"type":"string"},"device_id":{"maxLength":255,"type":"string"},"distinct_id":{"maxLength":255,"type":["string","null"]},"expiration_date":{"format":"date","type":"string"},"human_tissue_code":{"maxLength":255,"type":"string"},"human_tissue_device":{"type":["boolean","null"]},"id":{"format":"int64","type":"integer"},"implant_date":{"format":"date","type":"string"},"location":{"maxLength":255,"type":"string"},"lot_batch_id":{"maxLength":255,"type":"string"},"manufacture_date":{"format":"date","type":"string"},"mri_safety":{"type":"string"},"patient_id":{"format":"int64","readOnly":true,"type":"integer"},"procedure_cpt":{"maxLength":10,"type":["string","null"]},"reason_for_inactive":{"type":"string"},"serial_number":{"maxLength":255,"type":"string"},"status":{"$ref":"#/components/schemas/AllergyStatus"},"udi":{"maxLength":255,"type":"string"},"version_model":{"maxLength":255,"type":"string"}},"required":["brand_name","company_name","device_description","device_id","expiration_date","human_tissue_code","id","implant_date","location","lot_batch_id","manufacture_date","mri_safety","reason_for_inactive","serial_number","status","udi","version_model"],"type":"object"},"PatientItem":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_confidential":{"type":"boolean"},"patient":{"format":"int64","type":"integer"},"type":{"type":"string"}},"required":["is_confidential","patient","type"],"type":"object"},"PatientLetter":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/LetterAttachment"},"type":"array"},"body":{"type":"string"},"category":{"format":"int64","readOnly":true,"type":["integer","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delivery_date":{"format":"date-time","type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"files":{"description":"Files attached to this letter. Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references.","items":{"$ref":"#/components/schemas/S3RetrievingDocumentFile"},"type":["array","null"]},"id":{"readOnly":true,"type":"integer"},"is_patient_initiated":{"type":["boolean","null"]},"is_processed":{"readOnly":true,"type":"boolean"},"letter_type":{"readOnly":true,"type":"string"},"patient":{"format":"int64","type":"integer"},"patient_read_time":{"format":"date-time","type":["string","null"]},"practice":{"format":"int64","type":"integer"},"send_out":{"type":"boolean"},"send_to_patient":{"readOnly":true,"type":"boolean"},"sign_date":{"format":"date-time","type":["string","null"]},"signed_by":{"description":"The user who signed the letter.","format":"int64","type":["integer","null"]},"subject":{"maxLength":200,"type":"string"},"tags":{"description":"A list of Document Tags associated with the letter.","items":{"format":"int64","type":"integer"},"type":"array"},"viewed_at":{"format":"date-time","type":["string","null"]}},"required":["patient","practice"],"type":"object"},"PatientLiability":{"properties":{"date_of_service":{"format":"date-time","readOnly":true,"type":["string","null"]},"external_memo":{"maxLength":2000,"type":["string","null"]},"id":{"format":"int64","type":"integer"},"internal_memo":{"maxLength":500,"type":"string"},"invoice_number":{"maxLength":50,"type":"string"},"legal_entity_id":{"maximum":2147483647,"minimum":-2147483648,"type":["integer","null"]},"paid_at":{"format":"date-time","readOnly":true,"type":["string","null"]},"patient_id":{"format":"int64","readOnly":true,"type":["integer","null"]},"payment_charges":{"items":{"$ref":"#/components/schemas/PaymentCharge"},"readOnly":true,"type":"array"},"payment_requests":{"items":{"$ref":"#/components/schemas/PaymentRequest"},"readOnly":true,"type":"array"},"practice_id":{"format":"int64","readOnly":true,"type":"integer"},"practice_stripe_account_id":{"format":"int64","readOnly":true,"type":["integer","null"]},"reasons":{"items":{"type":"string"},"type":"array"},"total_amount_usd":{"format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$","type":"string"},"voided_at":{"format":"date-time","readOnly":true,"type":["string","null"]}},"required":["id","reasons","total_amount_usd"],"type":"object"},"PatientMatchingResultEnum":{"enum":["COMPLETE_MATCH","MULTIPLE_MATCHES","NO_MATCH"],"type":"string"},"PatientOutstandingBalance":{"properties":{"balance":{"description":"The outstanding balance in cents.","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"patient_id":{"format":"int64","readOnly":true,"type":"integer"}},"required":["balance"],"type":"object"},"PatientPhoto":{"properties":{"base_64":{"type":"string","writeOnly":true},"content_type":{"readOnly":true,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"file":{"description":"Patient profile image URL generation method\nArgs:\n    obj: PatientPhoto object\n\nReturns: The URL where you can get the image","readOnly":true,"type":"string"},"file_size":{"readOnly":true,"type":"integer"},"height":{"readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"last_updated":{"format":"date-time","readOnly":true,"type":"string"},"original_filename":{"type":"string"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"width":{"readOnly":true,"type":"integer"}},"required":["base_64","original_filename","patient","practice"],"type":"object"},"PatientPreference":{"properties":{"preferred_pharmacy_1":{"type":["string","null"]},"preferred_pharmacy_2":{"type":["string","null"]}},"type":"object"},"PatientPreviousName":{"properties":{"first_name":{"maxLength":70,"type":["string","null"]},"last_name":{"maxLength":70,"type":["string","null"]},"middle_name":{"maxLength":50,"type":["string","null"]},"suffix":{"maxLength":20,"type":["string","null"]}},"type":"object"},"PatientProblem":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"maxLength":200,"type":"string"},"dx":{"description":"The diagnoses for imo codes.","items":{"$ref":"#/components/schemas/ImoCodeRelation"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"rank":{"type":"integer"},"resolved_date":{"description":"Date the problem was resolved. Set only if `status` is `Resolved`.","format":"date","type":["string","null"]},"start_date":{"format":"date","type":"string"},"status":{"$ref":"#/components/schemas/PatientProblemStatusEnum"},"synopsis":{"type":"string"},"verification_status":{"oneOf":[{"$ref":"#/components/schemas/VerificationStatusEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]}},"required":["description","dx","patient","start_date","status"],"type":"object"},"PatientProblemStatusEnum":{"enum":["Active","Controlled","Resolved"],"type":"string"},"PatientProviderTeam":{"properties":{"patient_id":{"description":"The id of the Patient object that this team is associated with.","readOnly":true,"type":"integer"},"patient_provider_team_id":{"type":"integer"},"team_members":{"description":"The list of providers that are providing care to the above patient.","items":{"$ref":"#/components/schemas/PatientProviderTeamMember"},"readOnly":true,"type":"array"}},"required":["patient_provider_team_id"],"type":"object"},"PatientProviderTeamMember":{"properties":{"activity_summary_last_refreshed":{"description":"The last known time when this team member's activity was synced.","format":"date-time","readOnly":true,"type":"string"},"earliest_activity":{"description":"Displays the earliest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"group":{"allOf":[{"$ref":"#/components/schemas/GroupEnum"}],"default":"main","description":"Can either be `main` or `other`. By default members are placed in the `main` group. Only members in the `main` group will be displayed on the Patient chart in the web application.\n\n* `main` - main\n* `other` - other"},"latest_activity":{"description":"Displays the latest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"patient_id":{"description":"The id of the Patient that this team is associated with.","readOnly":true,"type":"integer"},"patient_provider_team_id":{"description":"Patient Provider team ID","type":"integer"},"patient_provider_team_member_id":{"readOnly":true,"type":"integer"},"physician_id":{"description":"The Physician that this team member represents.","type":"integer"},"rank":{"description":"Used for displaying a sorted patient provider team in the patient chart. Rank is sequential and begins at 1.","minimum":1,"readOnly":true,"type":"integer"},"treatment_reason":{"description":"The reason why this physician is in this team","type":["string","null"]}},"required":["patient_provider_team_id","physician_id"],"type":"object"},"PatientProviderTeamMemberUpdate":{"properties":{"activity_summary_last_refreshed":{"description":"The last known time when this team member's activity was synced.","format":"date-time","readOnly":true,"type":"string"},"earliest_activity":{"description":"Displays the earliest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"group":{"allOf":[{"$ref":"#/components/schemas/GroupEnum"}],"default":"main","description":"Can either be `main` or `other`. By default members are placed in the `main` group. Only members in the `main` group will be displayed on the Patient chart in the web application.\n\n* `main` - main\n* `other` - other"},"latest_activity":{"description":"Displays the latest known interaction between the team member and the patient.","format":"date-time","readOnly":true,"type":"string"},"patient_id":{"description":"The id of the Patient that this team is associated with.","readOnly":true,"type":"integer"},"patient_provider_team_id":{"description":"Patient Provider team ID","readOnly":true,"type":"integer"},"patient_provider_team_member_id":{"readOnly":true,"type":"integer"},"physician_id":{"description":"The Physician that this team member represents.","readOnly":true,"type":"integer"},"rank":{"description":"Used for displaying a sorted patient provider team in the patient chart. Rank is sequential and begins at 1.","minimum":1,"readOnly":true,"type":"integer"},"treatment_reason":{"description":"The reason why this physician is in this team","type":["string","null"]}},"type":"object"},"PatientSexEnum":{"enum":["Female","Male","Other","Unknown"],"type":"string"},"PatientSmokingStatus":{"properties":{"as_of_date":{"format":"date","type":["string","null"]},"id":{"format":"int64","type":"integer"},"patient_id":{"format":"int64","readOnly":true,"type":"integer"},"recorded_date":{"format":"date-time","readOnly":true,"type":"string"},"smoking_status_category":{"type":"integer"},"smoking_status_code":{"readOnly":true,"type":"integer"},"smoking_status_description":{"readOnly":true,"type":"string"}},"required":["id","smoking_status_category"],"type":"object"},"Payment":{"properties":{"amount":{"format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","type":"string"},"appointment":{"format":"int64","type":["integer","null"]},"bill":{"format":"int64","type":["integer","null"]},"create_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"delete_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"when_collected":{"format":"date-time","type":"string"}},"required":["amount","when_collected"],"type":"object"},"PaymentCharge":{"properties":{"amount_refunded_usd":{"format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$","type":"string"},"amount_usd":{"format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$","type":"string"},"completed_at":{"format":"date-time","readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_status_change_at":{"format":"date-time","readOnly":true,"type":"string"},"payment_method_description":{"maxLength":100,"type":"string"},"reference_number":{"maxLength":50,"type":["string","null"]},"refunded_at":{"format":"date-time","readOnly":true,"type":"string"}},"required":["amount_usd"],"type":"object"},"PaymentProgramEnum":{"enum":["Commercial - HMSA","Commercial - Other","Commercial - SFHP","Medicaid","Medicare Advantage","Medicare Part B","Worker's Compensation"],"type":"string"},"PaymentRequest":{"properties":{"amount_usd":{"format":"decimal","pattern":"^-?\\d{0,6}(?:\\.\\d{0,2})?$","type":"string"},"collected_at":{"format":"date-time","type":"string"},"id":{"readOnly":true,"type":"integer"},"last_reminder_sent_at":{"format":"date-time","type":"string"},"last_status_change_at":{"format":"date-time","readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/PaymentRequestStatusEnum"}},"required":["amount_usd","status"],"type":"object"},"PaymentRequestStatusEnum":{"enum":["Attempting to collect payment","Not attempting to collect","Payment collected"],"type":"string"},"PermissionTypeEnum":{"enum":["bills","messages","orders","referrals","rxs"],"type":"string"},"Pharmacy":{"properties":{"active_end_time":{"format":"date-time","type":"string"},"active_start_time":{"format":"date-time","type":"string"},"address_line1":{"maxLength":105,"type":["string","null"]},"address_line2":{"maxLength":105,"type":["string","null"]},"city":{"maxLength":105,"type":["string","null"]},"fax":{"maxLength":75,"type":["string","null"]},"id":{"format":"int64","type":"integer"},"ncpdpid":{"maxLength":21,"type":"string"},"npi":{"maxLength":30,"type":["string","null"]},"phone_primary":{"maxLength":75,"type":["string","null"]},"specialty_types":{"maxLength":150,"type":["string","null"]},"state":{"maxLength":6,"type":["string","null"]},"store_name":{"maxLength":105,"type":["string","null"]},"zip":{"maxLength":33,"type":["string","null"]}},"required":["active_end_time","active_start_time","id","ncpdpid"],"type":"object"},"Phone":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"phone":{"type":"string"},"phone_type":{"$ref":"#/components/schemas/PhoneTypeEnum"}},"required":["phone","phone_type"],"type":"object"},"PhoneTypeEnum":{"enum":["Fax","Home","Main","Mobile","Night","Other","Work"],"type":"string"},"Physician":{"properties":{"credentials":{"maxLength":20,"type":["string","null"]},"email":{"format":"email","type":"string"},"fax":{"description":"The physician's fax number.","readOnly":true,"type":"string"},"first_name":{"maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_active":{"description":"Whether or not the physician is still active at the practice.","readOnly":true,"type":"boolean"},"last_name":{"maxLength":60,"type":"string"},"license":{"type":"string"},"license_state":{"type":"string"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"npi":{"type":"string"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"specialty":{"readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":["integer","null"]}},"required":["email","first_name","last_name","license","license_state","npi"],"type":"object"},"PhysicianQualifications":{"properties":{"credentials":{"maxLength":50,"type":"string"},"dea":{"maxLength":50,"type":"string"},"license":{"maxLength":50,"type":"string"},"license_state":{"maxLength":2,"type":"string"},"npi":{"maxLength":10,"type":["string","null"]}},"required":["credentials","license","license_state"],"type":"object"},"Practice":{"properties":{"address_line1":{"maxLength":200,"type":"string"},"address_line2":{"maxLength":200,"type":"string"},"city":{"maxLength":50,"type":"string"},"elation_root_oid":{"readOnly":true,"type":"string"},"employers":{"items":{"$ref":"#/components/schemas/Employer"},"readOnly":true,"type":["array","null"]},"id":{"readOnly":true,"type":"integer"},"metadata":{"properties":{"data":{"type":"object"},"object_id":{"type":"string"},"object_web_link":{"type":"string"}},"type":["object","null"]},"name":{"maxLength":200,"type":"string"},"physicians":{"items":{"format":"int64","type":"integer"},"readOnly":true,"type":"array"},"service_locations":{"items":{"$ref":"#/components/schemas/ServiceLocation"},"readOnly":true,"type":["array","null"]},"state":{"maxLength":2,"type":"string"},"status":{"default":"active","readOnly":true,"type":"string"},"timezone":{"readOnly":true,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"required":["address_line1","address_line2","name"],"type":"object"},"PracticeFax":{"properties":{"fax":{"maxLength":20,"type":["string","null"]},"id":{"format":"int64","type":"integer"},"incoming_files_count":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"name":{"maxLength":50,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["id","name","practice"],"type":"object"},"PracticePrintHeader":{"properties":{"content_type":{"description":"The type of print header; whether its pure text or is an image. {0, 1} 0=text 1=image.","maxLength":5,"type":"string"},"created_date":{"description":"The timestamp when the print header was created.","format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"description":"The timestamp when the print header was deleted.","format":"date-time","readOnly":true,"type":["string","null"]},"header":{"description":"The text header. Will be null if not a text print header.","maxLength":500,"type":"string"},"header_image":{"allOf":[{"$ref":"#/components/schemas/UploadedPhoto"}],"description":"The header image. Will be null if not an image header."},"id":{"readOnly":true,"type":"integer"},"image_placement":{"description":"Specifies where the image header is placed. {0, 1, 2, 3} 0=left 1=right 2=center 3=fit to width.","maxLength":12,"type":"string"},"name":{"description":"The name of the print header displayed in the app.","maxLength":200,"type":"string"},"practice":{"description":"The practice that owns this print header.","format":"int64","readOnly":true,"type":"integer"}},"required":["name"],"type":"object"},"PracticeSpecialInsuranceCodeName":{"properties":{"code":{"maxLength":5,"type":"string"},"name":{"maxLength":64,"type":"string"}},"required":["code","name"],"type":"object"},"PracticeToStaff":{"properties":{"created_date":{"description":"When staff was added to the system.","format":"date-time","readOnly":true,"type":["string","null"]},"dob":{"format":"date","type":["string","null"]},"email":{"description":"Get office email using fallbacks","readOnly":true,"type":["string","null"]},"first_name":{"maxLength":50,"type":"string"},"id":{"readOnly":true,"type":"integer"},"last_name":{"maxLength":60,"type":"string"},"middle_name":{"maxLength":50,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","readOnly":true,"type":"integer"},"prefix":{"maxLength":20,"type":"string"},"sex":{"$ref":"#/components/schemas/PracticeToStaffSexEnum"},"suffix":{"maxLength":20,"type":"string"},"user_id":{"readOnly":true,"type":["integer","null"]}},"required":["last_name"],"type":"object"},"PracticeToStaffSexEnum":{"enum":["Female","Intersex/Other","Male","None selected"],"type":"string"},"PreferredContactEnum":{"enum":["email","passport","phone","sms"],"type":"string"},"PrescriptionFill":{"properties":{"fill_date":{"format":"date","type":["string","null"]},"fill_status":{"$ref":"#/components/schemas/FillStatusEnum"},"id":{"readOnly":true,"type":"integer"},"medication_order":{"format":"int64","type":"integer"},"note_from_pharmacy":{"maxLength":200,"type":["string","null"]},"patient":{"format":"int64","type":"integer"},"pharmacy_ncpdpid":{"maxLength":21,"title":"Pharmacy this fill occurred at","type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["fill_status","medication_order","patient","pharmacy_ncpdpid","practice"],"type":"object"},"PriorAuthQualifierEnum":{"description":"* `94` - Pharmacy or Prescriber File ID\n* `0B` - State License Number\n* `1C` - Medicare Number\n* `1D` - Medicaid Number\n* `1E` - Dentist License Number\n* `1G` - UPIN\n* `1J` - Facility ID Number\n* `1M` - PPO Number\n* `2U` - Payer Identification Number\n* `ADI` - Processor Identification Number\n* `BO` - BIN Location Number\n* `C1` - Commercial\n* `EA` - Medical Record Identification Number\n* `EJ` - Patient Account Number\n* `D3` - NCPDP Provider ID Number\n* `DH` - DEA Number\n* `G1` - Prior Authorization\n* `GI` - Secondary Provider Number\n* `HI` - HIN\n* `HPI` - National Provider ID\n* `IP` - Individual Policy Number\n* `NC` - Secondary Coverage Company Number\n* `NF` - National Association of Insurance Commissioner Code\n* `PD` - Promotion Number\n* `SY` - Social Security Number\n* `WI` - Waiver\n* `ZZ` - Mutually Defined","enum":["94","0B","1C","1D","1E","1G","1J","1M","2U","ADI","BO","C1","EA","EJ","D3","DH","G1","GI","HI","HPI","IP","NC","NF","PD","SY","WI","ZZ"],"type":"string"},"ProcedureCodes":{"properties":{"code":{"maxLength":10,"type":"string"},"dxs":{"items":{"$ref":"#/components/schemas/DiagnosisCode"},"type":"array"},"modifier_1":{"maxLength":255,"type":["string","null"]},"modifier_2":{"maxLength":255,"type":["string","null"]},"modifier_3":{"maxLength":255,"type":["string","null"]},"modifier_4":{"maxLength":255,"type":["string","null"]}},"required":["code","dxs"],"type":"object"},"ProcessStateEnum":{"enum":["complete","error","pending","processing"],"type":"string"},"PronounsDisplayEnum":{"enum":["He/Him/His","Option not listed","She/Her/Hers","They/Them/Theirs","None"],"type":"string"},"PronounsEnum":{"enum":["he_him_his","not_listed","she_her_hers","they_them_theirs","None"],"type":"string"},"ProviderAvailabilityBlock":{"properties":{"end_time":{"format":"time","type":"string"},"id":{"readOnly":true,"type":"integer"},"provider_id":{"format":"int64","type":"integer"},"service_location_id":{"format":"int64","type":["integer","null"]},"start_time":{"format":"time","type":"string"},"timezone":{"readOnly":true,"type":"string"},"use_service_location_timezone":{"type":"boolean"},"weekday":{"type":"integer"}},"required":["end_time","provider_id","start_time","weekday"],"type":"object"},"ProviderAvailabilityBlockSerializerPracticeTimeZone":{"properties":{"end_time":{"format":"time","type":"string"},"id":{"readOnly":true,"type":"integer"},"provider_id":{"format":"int64","type":"integer"},"service_location_id":{"format":"int64","type":["integer","null"]},"start_time":{"format":"time","type":"string"},"timezone":{"readOnly":true,"type":"string"},"use_service_location_timezone":{"type":"boolean"},"weekday":{"type":"integer"}},"required":["end_time","provider_id","start_time","weekday"],"type":"object"},"PublicityCodeEnum":{"enum":["No reminder/recall","Only recall to provider, no reminder","Only reminder to provider, no recall","Recall only - any method","Recall only - no calls","Recall to provider","Reminder only - any method","Reminder only - no calls","Reminder to provider","Reminder/recall - any method","Reminder/recall - no calls","Reminder/recall - to provider"],"type":"string"},"PublishedEvent":{"properties":{"error_content":{"type":["string","null"]},"event_id":{"readOnly":true,"type":"integer"},"event_type":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"processed_date":{"format":"date-time","type":"string"},"resource":{"readOnly":true,"type":"string"},"resource_id":{"readOnly":true,"type":"integer"},"status_code":{"maximum":2147483647,"minimum":-2147483648,"type":["integer","null"]},"target":{"readOnly":true,"type":"string"}},"required":["processed_date"],"type":"object"},"PulmonaryCenter":{"properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"maxLength":50,"type":"string"},"company":{"description":"Maps to the Ancillary Company object ID attribute.","format":"int64","type":"integer"},"company_name":{"description":"Maps to the Ancillary Company object name attribute.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"location_name":{"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"required":["address_line1","address_line2","company","company_name","location_name","practice"],"type":"object"},"PulmonaryOrder":{"properties":{"allergies":{"description":"Any allergies the patient has.","type":["string","null"]},"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"pulmonary_center":{"description":"The pulmonary center the order is associated with.","format":"int64","type":["integer","null"]},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of pulmonary tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/PulmonaryOrderTest"}]},"type":"array"}},"required":["allergies","ancillary_company","chart_date","clinical_reason","document_date","patient","practice","prescribing_user"],"type":"object"},"PulmonaryOrderTest":{"properties":{"code":{"maxLength":50,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":255,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["name","practice"],"type":"object"},"QtyUnitsEnum":{"description":"* `BAG` - BAG\n* `BOTTLE` - BOTTLE\n* `BOX` - BOX\n* `CAPSULE` - CAPSULE\n* `CARTRIDGE` - CARTRIDGE\n* `CONTAINER` - CONTAINER\n* `DROP` - DROP\n* `GRAM` - GRAM\n* `INHALER` - INHALER\n* `INTERNATIONAL UNITE` - INTERNATIONAL UNITE\n* `KIT` - KIT\n* `LITER` - LITER\n* `LOZENGE` - LOZENGE\n* `MILLIGRAM` - MILLIGRAM\n* `MILLILITER` - MILLILITER\n* `MILLION UNITS` - MILLION UNITS\n* `MUTUALLY DEFINED` - MUTUALLY DEFINED\n* `FLUID OUNCE` - FLUID OUNCE\n* `NOT SPECIFIED` - NOT SPECIFIED\n* `PACK` - PACK\n* `PACKET` - PACKET\n* `PINT` - PINT\n* `SUPPOSITORY` - SUPPOSITORY\n* `SYRINGE` - SYRINGE\n* `TABLESPOON` - TABLESPOON\n* `TABLET` - TABLET\n* `TEASPOON` - TEASPOON\n* `TRANSDERMAL PATCH` - TRANSDERMAL PATCH\n* `TUBE` - TUBE\n* `UNIT` - UNIT\n* `VIAL` - VIAL\n* `EACH` - EACH\n* `GUM` - GUM\n* `AMPULE` - AMPULE\n* `APPLICATOR` - APPLICATOR\n* `APPLICATORFUL` - APPLICATORFUL\n* `BAR` - BAR\n* `BEAD` - BEAD\n* `BLISTER` - BLISTER\n* `BLOCK` - BLOCK\n* `BOLUS` - BOLUS\n* `CAN` - CAN\n* `CANISTER` - CANISTER\n* `CAPLET` - CAPLET\n* `CARTON` - CARTON\n* `CASE` - CASE\n* `CASSETTE` - CASSETTE\n* `CYLINDER` - CYLINDER\n* `DISK` - DISK\n* `DOSE PACK` - DOSE PACK\n* `DUAL PACK` - DUAL PACK\n* `FILM` - FILM\n* `GALLON` - GALLON\n* `IMPLANT` - IMPLANT\n* `INHALATION` - INHALATION\n* `INHALER REFILL` - INHALER REFILL\n* `INSERT` - INSERT\n* `INTRAVENOUS BAG` - INTRAVENOUS BAG\n* `KILOGRAM` - KILOGRAM\n* `METRIC DROP` - METRIC DROP\n* `MILLIMETER` - MILLIMETER\n* `NEBULE` - NEBULE\n* `NEEDLE FREE INJECTION` - NEEDLE FREE INJECTION\n* `OCULAR SYSTEM` - OCULAR SYSTEM\n* `OUNCE` - OUNCE\n* `PACKAGE` - PACKAGE\n* `PAD` - PAD\n* `PAPER` - PAPER\n* `PATCH` - PATCH\n* `PEN NEEDLE` - PEN NEEDLE\n* `POUCH` - POUCH\n* `POUND` - POUND\n* `PRE-FILLED PEN SYRINGE` - PRE-FILLED PEN SYRINGE\n* `PUFF` - PUFF\n* `QUART` - QUART\n* `RING` - RING\n* `SACHET` - SACHET\n* `SCOOPFUL` - SCOOPFUL\n* `SPONGE` - SPONGE\n* `SPRAY` - SPRAY\n* `STICK` - STICK\n* `STRIP` - STRIP\n* `SWAB` - SWAB\n* `TABMINDER` - TABMINDER\n* `TAMPON` - TAMPON\n* `TRAY` - TRAY\n* `TROCHE` - TROCHE\n* `` - \n* `WAFER` - WAFER","enum":["BAG","BOTTLE","BOX","CAPSULE","CARTRIDGE","CONTAINER","DROP","GRAM","INHALER","INTERNATIONAL UNITE","KIT","LITER","LOZENGE","MILLIGRAM","MILLILITER","MILLION UNITS","MUTUALLY DEFINED","FLUID OUNCE","NOT SPECIFIED","PACK","PACKET","PINT","SUPPOSITORY","SYRINGE","TABLESPOON","TABLET","TEASPOON","TRANSDERMAL PATCH","TUBE","UNIT","VIAL","EACH","GUM","AMPULE","APPLICATOR","APPLICATORFUL","BAR","BEAD","BLISTER","BLOCK","BOLUS","CAN","CANISTER","CAPLET","CARTON","CASE","CASSETTE","CYLINDER","DISK","DOSE PACK","DUAL PACK","FILM","GALLON","IMPLANT","INHALATION","INHALER REFILL","INSERT","INTRAVENOUS BAG","KILOGRAM","METRIC DROP","MILLIMETER","NEBULE","NEEDLE FREE INJECTION","OCULAR SYSTEM","OUNCE","PACKAGE","PAD","PAPER","PATCH","PEN NEEDLE","POUCH","POUND","PRE-FILLED PEN SYRINGE","PUFF","QUART","RING","SACHET","SCOOPFUL","SPONGE","SPRAY","STICK","STRIP","SWAB","TABMINDER","TAMPON","TRAY","TROCHE","WAFER"],"type":"string"},"QuestionTypeEnum":{"description":"* `enum` - enum\n* `enum_multiselect` - enum_multiselect\n* `freetext` - freetext\n* `y_or_n` - y_or_n\n* `numeric` - numeric\n* `yyyymmdd` - yyyymmdd\n* `2_numeric_1_decimal` - 2_numeric_1_decimal","enum":["enum","enum_multiselect","freetext","y_or_n","numeric","yyyymmdd","2_numeric_1_decimal"],"type":"string"},"RaceEnum":{"enum":["American Indian or Alaska Native","Asian","Black or African American","Declined to specify","Native Hawaiian or Other Pacific Islander","No race specified","White"],"type":"string"},"RankEnum":{"enum":["primary","secondary","tertiary"],"type":"string"},"RecurringEventGroup":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_blocking":{"readOnly":true,"type":"boolean"},"practice":{"format":"int64","type":"integer"},"reason":{"readOnly":true,"type":["string","null"]},"schedules":{"items":{"$ref":"#/components/schemas/RecurringEventSchedule"},"type":"array"},"time_slot_type":{"$ref":"#/components/schemas/TimeSlotTypeEnum"}},"required":["practice","schedules","time_slot_type"],"type":"object"},"RecurringEventSchedule":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"type":"string"},"dow_friday":{"type":"boolean"},"dow_monday":{"type":"boolean"},"dow_saturday":{"type":"boolean"},"dow_sunday":{"type":"boolean"},"dow_thursday":{"type":"boolean"},"dow_tuesday":{"type":"boolean"},"dow_wednesday":{"type":"boolean"},"duration":{"type":"integer"},"event_time":{"format":"time","type":"string"},"id":{"readOnly":true,"type":"integer"},"physician":{"format":"int64","type":"integer"},"repeats":{"$ref":"#/components/schemas/RepeatsEnum"},"series_start":{"format":"date","type":"string"},"series_stop":{"format":"date","type":["string","null"]}},"required":["duration","event_time","physician","series_start"],"type":"object"},"ReferenceMedication":{"properties":{"active_ndcs":{"items":{"type":"string"},"type":"array"},"brand_name":{"readOnly":true,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"creation_type":{"allOf":[{"$ref":"#/components/schemas/MedicationDrugType"}],"default":"user","readOnly":true},"form":{"readOnly":true,"type":"string"},"generic_name":{"readOnly":true,"type":"string"},"id":{"description":"The id of the medication.","format":"int64","type":"integer"},"is_controlled":{"default":false,"description":"Whether the drug is a controlled substance or not.","type":"boolean"},"market_end_date":{"format":"date-time","type":["string","null"]},"name":{"description":"The name that will display for the medication in the search and when referenced by the prescription or documented med.","type":"string"},"ndcs":{"description":"The NDCs of the medication (must contain only one ndc code when creating).","items":{"type":"string"},"type":"array"},"obsolete_date":{"description":"The date at which this practice medication became obsolete.","format":"date-time","type":["string","null"]},"practice":{"description":"The practice that created the medication. `null` for medications from the standard formulary.","format":"int64","type":"integer"},"route":{"readOnly":true,"type":"string"},"rxnorm_cuis":{"description":"The Rxnorm.cui code of the medication (must contain only one cui code when creating).","items":{"type":"string"},"type":"array"},"strength":{"description":"The strength of the drug, e.g. 40mg.","maxLength":255,"type":["string","null"]},"type":{"allOf":[{"$ref":"#/components/schemas/MedicationType"}],"default":"prescription","description":"Whether the practice medication is an OTC or Prescription drug.\n\n* `otc` - otc\n* `prescription` - prescription\n* `discontinued` - discontinued"}},"type":"object"},"ReferralLetter":{"properties":{"body":{"description":"The body of the letter.","type":"string"},"delivery_date":{"format":"date-time","type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"sign_date":{"format":"date-time","type":["string","null"]}},"type":"object"},"ReferralOrder":{"properties":{"auth_number":{"maxLength":20,"type":["string","null"]},"authorization_for":{"oneOf":[{"$ref":"#/components/schemas/AuthorizationForEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"authorization_for_short":{"type":["string","null"]},"consultant_name":{"maxLength":1024,"type":["string","null"]},"date_for_reEval":{"format":"date","type":["string","null"]},"icd10_codes":{"items":{"$ref":"#/components/schemas/ICD10Code"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"letter":{"deprecated":true,"description":"The letter associated with this referral order. Use referral_letter for the full nested letter object.","format":"int64","readOnly":true,"type":"integer"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"referral_letter":{"allOf":[{"$ref":"#/components/schemas/ReferralLetter"}],"description":"Nested letter object with full details.","readOnly":true},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"short_consultant_name":{"maxLength":1024,"type":["string","null"]},"sign_date":{"description":"The datetime when this referral order was signed.","format":"date-time","readOnly":true,"type":["string","null"]},"signed_by":{"description":"The ID of the user who signed this referral order.","readOnly":true,"type":"integer"},"specialty":{"$ref":"#/components/schemas/MedicalSpecialty"}},"required":["auth_number","consultant_name","date_for_reEval","patient","practice","short_consultant_name","specialty"],"type":"object"},"ReferringProvider":{"properties":{"name":{"type":"string"},"npi":{"maxLength":10,"type":["string","null"]},"state":{"type":"string"}},"required":["name","state"],"type":"object"},"RepeatsEnum":{"enum":["Monthly","Weekly"],"type":"string"},"Report":{"properties":{"chart_date":{"description":"The date used for chart chronology and ordering. May differ from document_date.","format":"date-time","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"custom_title":{"maxLength":255,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"The date when the report was created.","format":"date-time","type":"string"},"files":{"description":"Files and photos to attach. Two modes: (1) External JSON metadata: set content_type='application/json; schema=el8_external_content_report' and provide 'external_content' JSON that includes a 'referenced_url' (and optional metadata). The JSON is stored and used to reference the external file; file bytes are not uploaded. (2) Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references; download via the files retrieval endpoint. For JSON content, the retrieval endpoint returns the stored JSON metadata.","items":{"$ref":"#/components/schemas/S3RetrievingDocumentFile"},"type":["array","null"]},"grids":{"description":"Structured lab results grids. Each grid groups results by accession number and collection/resulted timestamps.","items":{"$ref":"#/components/schemas/LabResultsGrid"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"images":{"description":"Read-only. Images derived from uploaded files. Upload using the 'files' field; retrieve specific images via the images endpoint.","items":{"$ref":"#/components/schemas/ReportImage"},"readOnly":true,"type":["array","null"]},"is_urgent":{"default":false,"type":"boolean"},"order_status":{"description":"Status of a linked order, when applicable.","oneOf":[{"$ref":"#/components/schemas/OrderStatusEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"patient":{"description":"The patient this report belongs to. The patient must belong to the specified practice.","format":"int64","type":"integer"},"physician":{"format":"int64","type":"integer"},"practice":{"description":"The authoring practice for this report. Required on create.","format":"int64","type":"integer"},"printable_view":{"description":"URL to a printable PDF view of the report. You may pass the optional 'print_header' query param to select a header.","format":"uri","type":"string"},"report_type":{"allOf":[{"$ref":"#/components/schemas/ReportTypeEnum"}],"description":"The type of report. For laboratory reports, use 'Lab'."},"reported_date":{"description":"The timestamp when the report was created by an external system, usually the same as \"document_date\".","format":"date-time","type":"string"},"requisition_number":{"maxLength":100,"type":["string","null"]},"routed_document_delegates":{"description":"Read-only. Users and groups that have been delegated to review this report.","items":{"$ref":"#/components/schemas/RoutedDocumentDelegate"},"readOnly":true,"type":"array"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"tags":{"description":"Practice-scoped document tags.","items":{"format":"int64","type":"integer"},"type":"array"},"vendor":{"description":"Optional vendor for this report.","format":"int64","type":["integer","null"]}},"required":["chart_date","document_date","patient","physician","practice","report_type"],"type":"object"},"ReportImage":{"properties":{"document":{"format":"uri","type":"string"},"id":{"readOnly":true,"type":"integer"}},"required":["document"],"type":"object"},"ReportType":{"properties":{"display_value":{"description":"The display value of the report type.","type":"string"},"id":{"description":"The id of the report type.","type":"integer"},"practice":{"description":"The id of the practice.","type":"integer"},"rank":{"description":"Number that indicates the report type rank in the overall list of report types.","type":"integer"},"report_type":{"description":"The type of report.","type":"string"}},"required":["display_value","id","rank","report_type"],"type":"object"},"ReportTypeEnum":{"enum":["Allergist","Audiology","Billing","Business","Cardiac","CarePlan","Consent","Consultation","Correspondence","Cosmetic","DME","Dermatology","Diabetes","Directives","EKG","ENT","Endocrinology","Exams","EyeVision","Forms","GI","History","Home","Hospice","Hospital","Imaging","Incoming","Injection","Insurance","Intake","Lab","Legal","Misc","Neuro","Nursing","OBGYN","OT","OldRecord","Oncology","Ophth","Ortho","Outgoing","PT","PaperRx","Pathology","PatientForm","Pediatric","Pharmacy","Preop","PriorAuth","Procedures","Psych","Pulmonary","Quality","Radiology","SNF","Screening","Sleep","Surgery","Testing","Therapy","Ultrasound","UrgentCare","Urology","Women"],"type":"string"},"RequestingPhysicianActionEnum":{"description":"* `ReqAct` - Requiring Action\n* `Addressed` - Addressed","enum":["ReqAct","Addressed"],"type":"string"},"RoleEnum":{"enum":["Primary Provider","Staff"],"type":"string"},"RoutedDocumentDelegate":{"description":"Nested serializer for RoutedDocumentDelegate.\n\nReturns delegation information for users and groups assigned to review a report.\nEither user or group will be populated, but not both.","properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"group":{"description":"ID of the delegated group. Null if this is a user delegation.","type":["integer","null"]},"id":{"readOnly":true,"type":"integer"},"user":{"description":"ID of the delegated user. Null if this is a group delegation.","type":["integer","null"]}},"type":"object"},"RxHistoryDownload":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"eligibility":{"format":"int64","type":["integer","null"]},"error_code":{"oneOf":[{"$ref":"#/components/schemas/ErrorCodeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"error_description":{"type":["string","null"]},"error_description_code":{"oneOf":[{"$ref":"#/components/schemas/ErrorDescriptionCodeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"from_date":{"format":"date","type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"num_items":{"readOnly":true,"type":"string"},"patient":{"format":"int64","type":"integer"},"pbm_member_id":{"maxLength":100,"type":["string","null"]},"pbm_name":{"readOnly":true,"type":"string"},"pbm_surescripts_participant_id":{"readOnly":true,"type":"string"},"practice":{"format":"int64","type":"integer"},"signed_by":{"format":"int64","readOnly":true,"type":["integer","null"]},"signed_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"success":{"type":"boolean"},"until_date":{"format":"date","type":["string","null"]}},"required":["patient","practice"],"type":"object"},"RxRefillRequest":{"properties":{"id":{"readOnly":true,"type":"integer"},"original_medication_order":{"format":"int64","type":"integer"},"patient":{"format":"int64","type":["integer","null"]},"patient_matched":{"type":"boolean"},"patient_matching_result":{"$ref":"#/components/schemas/PatientMatchingResultEnum"},"practice":{"format":"int64","type":"integer"},"prescriber":{"format":"int64","type":"integer"},"received_date":{"format":"date-time","type":"string"},"requested_pharmacy_ncpdpid":{"type":"integer"},"supervisor":{"format":"int64","type":["integer","null"]}},"required":["original_medication_order","patient_matching_result","practice","prescriber","received_date","requested_pharmacy_ncpdpid"],"type":"object"},"S3RetrievingDocumentFile":{"properties":{"base64_content":{"type":"string"},"content_type":{"type":"string"},"document":{"description":"URL to retrieve the document","format":"uri","type":"string"},"external_content":{},"id":{"readOnly":true,"type":"integer"},"original_filename":{"type":"string"}},"type":"object"},"SendToContact":{"properties":{"first_name":{"maxLength":50,"type":"string"},"id":{"format":"int64","type":"integer"},"last_name":{"maxLength":60,"type":"string"},"middle_name":{"maxLength":50,"title":"MiddleName","type":"string"},"npi":{"maxLength":20,"type":["string","null"]},"org_name":{"maxLength":100,"type":["string","null"]},"specialties":{"items":{},"type":"array"}},"required":["id"],"type":"object"},"ServiceLocation":{"properties":{"address_line1":{"description":"The service location address.","type":"string"},"address_line2":{"description":"The service location suite.","type":"string"},"city":{"default":"","maxLength":50,"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"email":{"format":"email","maxLength":254,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_primary":{"default":false,"type":"boolean"},"name":{"maxLength":200,"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"place_of_service":{"$ref":"#/components/schemas/ServiceLocationPlaceOfServiceEnum"},"place_of_service_code":{"type":"integer"},"practice":{"description":"The id of the practice that the service location belongs to.","format":"int64","type":"integer"},"state":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/ServiceLocationStatusEnum"}],"default":"active","readOnly":true},"timezone":{"oneOf":[{"$ref":"#/components/schemas/TimezoneEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"zip":{"default":"","maxLength":10,"type":"string"}},"required":["address_line1","name","practice","state"],"type":"object"},"ServiceLocationPlaceOfServiceEnum":{"enum":["Ambulance - Air or Water","Ambulance - Land","Ambulatory Surgical Center","Assisted Living Facility","Birthing Center","Community Mental Health Center","Comprehensive Inpatient Rehabilitation Facility","Comprehensive Outpatient Rehabilitation Facility","Custodial Care Facility","Emergency Room - Hospital","End-Stage Renal Disease Treatment Facility","Federally Qualified Health Center","Group Home","Home","Homeless Shelter","Hospice","Independent Clinic","Independent Laboratory","Indian Health ServiceFree-standing Facility","Indian Health ServiceProvider-based Facility","Inpatient Hospital","Inpatient Psychiatric Facility","Intermediate Care Facility/Individuals with Intellectual Disabilities","Mass Immunization Center","Military Treatment Facility","Mobile Unit","Non-residential Substance Abuse Treatment Facility","Nursing Facility","Off Campus Outpatient-Hospital","Office","On Campus-Outpatient Hospital","Other Place of Service","Outreach Site/Street","Pharmacy","Place of Employment-Worksite","Prison/Correctional Facility","Programs of All-Inclusive Care for the Elderly (PACE) Center","Psychiatric Facility-Partial Hospitalization","Psychiatric Residential Treatment Center","Public Health Clinic","Residential Substance Abuse Treatment Facility","Rural Health Clinic","School","Skilled Nursing Facility","Telehealth Provided Other than in Patient’s Home","Telehealth Provided in Patient’s Home","Temporary Lodging","Tribal 638Free-standingFacility","Tribal 638Provider-basedFacility","Urgent Care Facility","Walk-in Retail Health Clinic"],"type":"string"},"ServiceLocationStatusEnum":{"enum":["active","inactive","suspended"],"type":"string"},"SexualOrientationEnum":{"enum":["asexual","bisexual","gay","lesbian","option_not_listed","prefer_not_to_say","queer","straight","unknown"],"type":"string"},"SiteEnum":{"description":"* `Abdomen` - Abdomen\n* `R Anterolateral Thigh` - R Anterolateral Thigh\n* `L Anterolateral Thigh` - L Anterolateral Thigh\n* `R Posterior Upper Arm` - R Posterior Upper Arm\n* `L Posterior Upper Arm` - L Posterior Upper Arm\n* `R Upper Arm` - R Upper Arm\n* `L Upper Arm` - L Upper Arm\n* `R Deltoid` - R Deltoid\n* `L Deltoid` - L Deltoid\n* `R Gluteus Maximus` - R Gluteus Maximus\n* `L Gluteus Maximus` - L Gluteus Maximus\n* `R Gluteus Medius` - R Gluteus Medius\n* `L Gluteus Medius` - L Gluteus Medius\n* `R Thigh` - R Thigh\n* `L Thigh` - L Thigh\n* `Back` - Back\n* `R Forearm` - R Forearm\n* `L Forearm` - L Forearm\n* `R Antecubital Fossa` - R Antecubital Fossa\n* `L Antecubital Fossa` - L Antecubital Fossa\n* `R Hand` - R Hand\n* `L Hand` - L Hand\n* `Other` - Other","enum":["Abdomen","R Anterolateral Thigh","L Anterolateral Thigh","R Posterior Upper Arm","L Posterior Upper Arm","R Upper Arm","L Upper Arm","R Deltoid","L Deltoid","R Gluteus Maximus","L Gluteus Maximus","R Gluteus Medius","L Gluteus Medius","R Thigh","L Thigh","Back","R Forearm","L Forearm","R Antecubital Fossa","L Antecubital Fossa","R Hand","L Hand","Other"],"type":"string"},"SleepCenter":{"properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"maxLength":50,"type":"string"},"company":{"description":"Maps to the Ancillary Company object ID attribute.","format":"int64","type":"integer"},"company_name":{"description":"Maps to the Ancillary Company object name attribute.","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"fax":{"maxLength":20,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"location_name":{"type":"string"},"phone":{"maxLength":20,"type":["string","null"]},"practice":{"format":"int64","type":"integer"},"state":{"maxLength":2,"type":"string"},"zip":{"maxLength":10,"type":"string"}},"required":["address_line1","address_line2","company","company_name","location_name","practice"],"type":"object"},"SleepOrder":{"properties":{"ancillary_company":{"format":"int64","type":"integer"},"ccs":{"description":"Array of Physician IDs to copy for the order.","items":{"format":"int64","type":"integer"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"clinical_reason":{"description":"The clinical reason for the order.","type":"string"},"confidential":{"type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"follow_up_method":{"description":"How to notify the patient of the results.","maxLength":100,"type":["string","null"]},"icd10_codes":{"description":"Array of ICD-10 diagnosis codes associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/ICD10Code"}]},"type":"array"},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The patient the order is associated with. Patient must belong to the specified practice.","format":"int64","type":"integer"},"practice":{"description":"The practice the order is associated with.","format":"int64","type":"integer"},"prescribing_user":{"description":"The user associated with the order. User ID must tie to a physician in the practice.","type":"integer"},"resolution":{"$ref":"#/components/schemas/DocumentResolutionState"},"signed_by":{"format":"int64","type":["integer","null"]},"signed_date":{"format":"date-time","type":["string","null"]},"sleep_center":{"description":"The sleep center the order is associated with.","format":"int64","type":["integer","null"]},"test_date":{"description":"The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.","format":"date","type":["string","null"]},"tests":{"description":"An array of sleep tests associated with the order.","items":{"allOf":[{"$ref":"#/components/schemas/SleepOrderTest"}]},"type":"array"}},"required":["ancillary_company","chart_date","clinical_reason","document_date","patient","practice","prescribing_user","tests"],"type":"object"},"SleepOrderTest":{"properties":{"code":{"maxLength":50,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":255,"type":"string"},"practice":{"format":"int64","type":"integer"}},"required":["name","practice"],"type":"object"},"SnomedCode":{"properties":{"code":{"maxLength":50,"type":"string"},"description":{"maxLength":500,"type":["string","null"]}},"required":["code"],"type":"object"},"SourceEnum":{"enum":["metrofax","plr","refile","softlinx","user"],"type":"string"},"StaffGroup":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_elation_group":{"description":"Whether the staff group is an Elation group.","type":"boolean"},"name":{"description":"The name of the staff group.","maxLength":50,"type":"string"},"practice":{"description":"The id of the practice that the staff group belongs to.","format":"int64","type":"integer"},"users":{"description":"A list of user ids inside the group.","items":{"type":"integer"},"type":"array"}},"required":["name","practice","users"],"type":"object"},"StatMethodEnum":{"description":"* `wet_reading_phone` - STAT Wet Reading - Please Phone Report\n* `wet_reading_fax` - STAT Wet Reading - Please Fax Report\n* `stat_phone` - STAT - Phone\n* `stat_fax` - STAT - Fax\n* `stat_phone_fax` - STAT - Phone and Fax","enum":["wet_reading_phone","wet_reading_fax","stat_phone","stat_fax","stat_phone_fax"],"type":"string"},"StateEnum":{"description":"* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled","enum":["outstanding","fulfilled","cancelled"],"type":"string"},"Status":{"properties":{"deceased_date":{"format":"date","type":["string","null"]},"inactive_reason":{"oneOf":[{"$ref":"#/components/schemas/InactiveReasonEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"last_status_change":{"format":"date-time","readOnly":true,"type":"string"},"notes":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/StatusStatusEnum"}},"type":"object"},"StatusStatusEnum":{"description":"* `active` - Active\n* `inactive` - Inactive\n* `prospect` - Prospect\n* `deceased` - Deceased","enum":["active","inactive","prospect","deceased"],"type":"string"},"Subscription":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":"string"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"properties":{"description":"Properties specific to this subscription.","oneOf":[{},{"type":"null"}]},"resource":{"description":"The resource name.","maxLength":50,"type":"string"},"signing_pub_key":{"readOnly":true,"type":"string"},"target":{"description":"Target URL where we would send the POST request on new events.","format":"uri","type":"string"}},"required":["resource","target"],"type":"object"},"SupportMessage":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"message":{"type":"string"},"message_end":{"format":"date-time","type":["string","null"]},"message_start":{"format":"date-time","type":["string","null"]},"referenced_url":{"format":"uri","maxLength":200,"type":["string","null"]},"referenced_url_description":{"maxLength":100,"type":["string","null"]},"target_practices":{"items":{"format":"int64","type":"integer"},"type":"array"},"target_users":{"items":{"type":"integer"},"type":"array"}},"required":["message","message_end","message_start"],"type":"object"},"TemplateEnum":{"enum":["Complete H&P (1 col)","Complete H&P (2 col A/P)","Complete H&P (2 col)","Pre-Op","SOAP","Simple"],"type":"string"},"Thread":{"properties":{"dc_date":{"format":"date","readOnly":true,"type":["string","null"]},"id":{"format":"int64","type":"integer"},"is_permanent":{"type":"boolean"}},"required":["is_permanent"],"type":"object"},"ThreadMember":{"properties":{"ack_time":{"description":"The time at which the member acknowledged the message thread.","format":"date-time","type":"string"},"group":{"description":"The id of the group referenced by this thread member. Should only ever be one of either a user or group set for the thread member.","format":"int64","type":["integer","null"]},"id":{"readOnly":true,"type":"integer"},"status":{"allOf":[{"$ref":"#/components/schemas/ThreadMemberStatusEnum"}],"description":"Whether this member has acknowledged the message thread."},"thread":{"description":"The id of the thread this thread member is a member of.","format":"int64","type":"integer"},"user":{"description":"The id of the user referenced by this thread member. Should only ever be one of either a user or group set for the thread member.","type":["integer","null"]}},"required":["status"],"type":"object"},"ThreadMemberStatusEnum":{"enum":["Addressed","Requiring Action"],"type":"string"},"ThreadMessage":{"properties":{"body":{"description":"The actual message body.","type":"string"},"id":{"readOnly":true,"type":"integer"},"patient":{"description":"The patient id.","format":"int64","readOnly":true,"type":"integer"},"practice":{"description":"The practice id.","format":"int64","readOnly":true,"type":"integer"},"send_date":{"description":"The date of when the message was sent.","format":"date-time","type":"string"},"sender":{"description":"The id of who sent the message.","type":"integer"},"thread":{"description":"The message thread id.","format":"int64","type":"integer"},"to_document":{"$ref":"#/components/schemas/Document"}},"required":["body","send_date","sender"],"type":"object"},"TimeSlotStatusEnum":{"enum":["not_avail_for_self_schedule"],"type":"string"},"TimeSlotTypeEnum":{"enum":["appointment","appointment_slot","event"],"type":"string"},"TimezoneEnum":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Inuvik","America/Iqaluit","America/Jamaica","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Choibalsan","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Riyadh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","GMT","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Wake","Pacific/Wallis","US/Alaska","US/Arizona","US/Central","US/Eastern","US/Hawaii","US/Mountain","US/Pacific","UTC"],"type":"string"},"TransportationDetails":{"description":"Typed API shape for the ``transportation`` attribute, backed by the generic\n``AppointmentAttribute`` store. Fields mirror ``TransportationAttr``; that Pydantic\nschema is the authoritative validator on write (length/format constraints live there,\nnot here, to avoid drift).","properties":{"is_required":{"type":"boolean"},"notes":{"type":["string","null"]}},"type":"object"},"UpdateReport":{"properties":{"id":{"readOnly":true,"type":"integer"},"is_urgent":{"default":false,"type":"boolean"},"signed_by":{"description":"Signer to apply.","format":"int64","type":["integer","null"]},"signed_date":{"description":"Signature timestamp to apply.","format":"date-time","type":["string","null"]}},"type":"object"},"UploadedPhoto":{"description":"Serializer for UploadedPhoto model.\nUsed for print header images and other cases where we need to serialize an UploadedPhoto directly.","properties":{"content_type":{"readOnly":true,"type":"string"},"file_size":{"readOnly":true,"type":"integer"},"height":{"readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"integer"},"last_updated":{"format":"date-time","readOnly":true,"type":"string"},"original_filename":{"readOnly":true,"type":"string"},"width":{"readOnly":true,"type":"integer"}},"type":"object"},"User":{"properties":{"account_type":{"oneOf":[{"$ref":"#/components/schemas/AccountTypeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"credentialed":{"default":false,"type":"boolean"},"email":{"maxLength":255,"type":"string"},"first_name":{"maxLength":50,"type":"string"},"has_chart_access":{"default":true,"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"is_active":{"type":"boolean"},"is_practice_admin":{"default":false,"type":"boolean"},"is_read_only":{"default":false,"type":"boolean"},"last_name":{"maxLength":60,"type":"string"},"physician_qualifications":{"$ref":"#/components/schemas/PhysicianQualifications"},"practice":{"format":"int64","type":"integer"},"user_type":{"$ref":"#/components/schemas/UserTypeEnum"}},"required":["email","first_name","is_active","last_name","practice","user_type"],"type":"object"},"UserTypeEnum":{"enum":["physician","staff"],"type":"string"},"Vaccine":{"properties":{"cdc_type":{"readOnly":true,"type":["string","null"]},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"creation_type":{"allOf":[{"$ref":"#/components/schemas/VaccineCreationType"}],"readOnly":true},"cvx":{"readOnly":true,"type":["integer","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"description":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"integer"},"is_user_created":{"readOnly":true,"type":"boolean"},"name":{"readOnly":true,"type":"string"},"ndc":{"readOnly":true,"type":["string","null"]},"ndc_values":{"items":{"type":"string"},"readOnly":true,"type":"array"},"practice":{"format":"int64","readOnly":true,"type":["integer","null"]}},"type":"object"},"VaccineCreationType":{"enum":["elation","medispan","user"],"type":"string"},"ValueTypeEnum":{"enum":["Coded Entry","Encapsulated Data","Numeric","String Data","Text"],"type":"string"},"VerificationStatusEnum":{"enum":["confirmed","differential","entered_in_error","provisional","refuted","unconfirmed"],"type":"string"},"VfcEligibilityEnum":{"enum":["317","CA State General Fund Vaccines","CHIP","HI Adult Insured","HI Adult Not Insured","HI Birthing Hospital Hepatitis B","Local-specific eligibility","ME State Eligible - Insured - Under 19","Medicare","Not VFC eligible","OR Locally Owned","OR Special Projects","State program eligibility","VFC eligible - American Indian/Alaskan Native","VFC eligible - Medicaid/Medicaid Managed Care","VFC eligible - Under-insured","VFC eligible - Uninsured"],"type":"string"},"VisitNote":{"properties":{"amendment_request":{"allOf":[{"$ref":"#/components/schemas/AmendmentRequest"}],"readOnly":true},"bullets":{"description":"The bullets of the visit note.","items":{"$ref":"#/components/schemas/BulletWithMeta"},"type":"array"},"chart_date":{"description":"Visit note chart date.","format":"date-time","type":"string"},"checklists":{"additionalProperties":{"items":{"properties":{"name":{"description":"Name of the checklist field","type":"string"},"sequence":{"description":"Order of the field in the checklist","type":"integer"},"value":{"description":"Value of the checklist field","type":"string"}},"required":["name","value","sequence"],"type":"object"},"type":"array"},"description":"Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence","type":"object"},"clinical_summary_link":{"format":"uri","readOnly":true,"type":"string"},"confidential":{"default":false,"description":"Whether this note is confidential to the practice and shouldn't be shared automatically with third parties.","type":"boolean"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"description":"Visit note document date.","format":"date-time","type":"string"},"edits":{"items":{"$ref":"#/components/schemas/VisitNoteEdit"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"last_modified":{"format":"date-time","type":"string"},"patient":{"format":"int64","type":"integer"},"physician":{"format":"int64","type":"integer"},"practice":{"format":"int64","readOnly":true,"type":"integer"},"signatures":{"allOf":[{"$ref":"#/components/schemas/VisitNoteSignatureList"}],"description":"The list of signatures if co-signing is enabled for the practice. (Requires Special Permission)."},"signed_by":{"description":"The user id of the provider who signed the visit note. (Requires special permission).","format":"int64","type":["integer","null"]},"signed_date":{"description":"The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).","format":"date-time","type":["string","null"]},"template":{"$ref":"#/components/schemas/TemplateEnum"},"type":{"default":"Office Visit Note","description":"Visit note type.","type":"string"},"visit_summary_link":{"format":"uri","readOnly":true,"type":"string"}},"required":["bullets","chart_date","document_date","patient","physician","template"],"type":"object"},"VisitNoteDocument":{"properties":{"document":{"allOf":[{"$ref":"#/components/schemas/Document"}],"description":"The id of the document, e.g. the id of the report or order."},"id":{"readOnly":true,"type":"integer"},"summary":{"description":"A textual summary of the document. Will show up in the visit note editor view, while the bullet text will be used in views outside the editor.","type":["string","null"]}},"required":["document"],"type":"object"},"VisitNoteEdit":{"properties":{"create_user":{"type":"integer"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"new_bmi":{"format":"double","type":"number"},"new_note_time":{"format":"date-time","type":"string"},"new_note_type":{"type":"string"},"new_prev_bmi":{"format":"double","type":"number"},"new_prev_time":{"format":"date-time","type":"string"},"new_prev_weight":{"maxLength":10,"type":"string"},"previous_bmi":{"format":"double","type":"number"},"previous_note_time":{"format":"date-time","type":"string"},"previous_note_type":{"type":"string"},"previous_prev_bmi":{"format":"double","type":"number"},"previous_prev_time":{"format":"date-time","type":"string"},"previous_prev_weight":{"maxLength":10,"type":"string"},"visit_note":{"format":"int64","type":"integer"}},"required":["visit_note"],"type":"object"},"VisitNoteFormatEnum":{"enum":["note2","oneCol.oneField","oneCol.preOp","oneCol.preOp2","oneCol.simple","twoCol.complex","twoCol.complex2"],"type":"string"},"VisitNoteSignatureList":{"items":{"properties":{"comments":{"description":"Any comments the signer made about the signature.","type":"string"},"role":{"description":"The function of the signer.","type":"string"},"signed_date":{"description":"Date-time timestamp for when this signature occurred.","format":"date-time","type":"string"},"user":{"description":"ID of the user whose signature this represents.","type":"string"},"user_name":{"description":"The full name and title of the user whose signature this represents.","type":"string"}},"required":["comments","role","signed_date","user","user_name"],"type":"object"},"type":"array"},"VisitNoteTemplate":{"properties":{"content":{"type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"name":{"maxLength":50,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]}},"required":["content","name"],"type":"object"},"VisitNoteType":{"properties":{"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"is_mu_office_visit":{"type":"boolean"},"name":{"maxLength":50,"type":"string"},"practice_created":{"format":"int64","type":["integer","null"]},"rank":{"readOnly":true,"type":"integer"},"snomed_code":{"$ref":"#/components/schemas/SnomedCode"}},"required":["name"],"type":"object"},"VitalBP":{"properties":{"diastolic":{"type":["string","null"]},"note":{"type":["string","null"]},"systolic":{"type":["string","null"]}},"type":"object"},"VitalHC":{"properties":{"note":{"type":["string","null"]},"percentile":{"readOnly":true,"type":["integer","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalHCUnitsEnum"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalHCUnitsEnum":{"enum":["cm"],"type":"string"},"VitalHR":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalHRUnits"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalHRUnits":{"enum":["bpm"],"type":"string"},"VitalHeight":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalHeightUnitsEnum"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalHeightUnitsEnum":{"enum":["inches"],"type":"string"},"VitalOxygen":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalOxygenUnitsEnum"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalOxygenUnitsEnum":{"enum":["%"],"type":"string"},"VitalPain":{"properties":{"note":{"type":["string","null"]},"value":{"type":["string","null"]}},"type":"object"},"VitalRR":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalHRUnits"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalTemperature":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalTemperatureUnitsEnum"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalTemperatureUnitsEnum":{"enum":["celsius","fahrenheit"],"type":"string"},"VitalWeight":{"properties":{"note":{"type":["string","null"]},"units":{"allOf":[{"$ref":"#/components/schemas/VitalWeightUnitsEnum"}],"readOnly":true},"value":{"type":["string","null"]}},"type":"object"},"VitalWeightUnitsEnum":{"enum":["lbs"],"type":"string"},"VitalsCollection":{"properties":{"bmi":{"format":"double","type":["number","null"]},"bmi_percentile":{"description":"The BMI percentile of the patient. Optional. Will be automatically calculated from height and weight otherwise.","readOnly":true,"type":["integer","null"]},"bp":{"description":"The blood pressure of the patient. Will allow multiple items in array.","items":{"$ref":"#/components/schemas/VitalBP"},"type":"array"},"chart_date":{"format":"date-time","type":"string"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"custom_observations":{"additionalProperties":{"properties":{"label":{"type":"string"},"note":{"type":["string","null"]},"units":{"type":["string","null"]},"value":{"type":"string"}},"type":"object"},"type":"object"},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"document_date":{"format":"date-time","type":"string"},"hc":{"description":"The head circumference of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHC"},"type":"array"},"height":{"description":"The height of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHeight"},"type":"array"},"hr":{"description":"The heart rate of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalHR"},"type":"array"},"id":{"readOnly":true,"type":"integer"},"length_for_weight_percentile":{"description":"The length for weight percentile for the patient.","format":"double","readOnly":true,"type":["number","null"]},"non_visit_note":{"description":"The non-visit note that the vital belongs to. Will only allow unsigned non-visit notes.","format":"int64","type":["integer","null"]},"oxygen":{"description":"The oxygen saturation of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalOxygen"},"type":"array"},"pain":{"description":"The pain of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalPain"},"type":"array"},"patient":{"format":"int64","type":"integer"},"practice":{"format":"int64","type":"integer"},"rr":{"description":"The respiratory rate of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalRR"},"type":"array"},"signed_by":{"format":"int64","readOnly":true,"type":"integer"},"signed_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"temperature":{"description":"The temperature of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalTemperature"},"type":"array"},"visit_note":{"description":"The visit note that the vital belongs to. Will only allow unsigned visit notes.","format":"int64","type":["integer","null"]},"weight":{"description":"The weight of the patient. Will only allow array of one.","items":{"$ref":"#/components/schemas/VitalWeight"},"type":"array"}},"required":["patient","practice"],"type":"object"},"XmlFile":{"description":"Alias for S3RetrievingDocumentFileSerializer with proper OpenAPI schema name.","properties":{"base64_content":{"type":"string"},"content_type":{"type":"string"},"document":{"description":"URL to retrieve the document","format":"uri","type":"string"},"external_content":{},"id":{"readOnly":true,"type":"integer"},"original_filename":{"type":"string"}},"type":"object"},"XmlPatientSummary":{"properties":{"allergies_imported":{"type":"boolean"},"author_name":{"maxLength":255,"type":["string","null"]},"authoring_practice":{"format":"int64","type":"integer"},"created_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"data_format":{"allOf":[{"$ref":"#/components/schemas/DataFormatEnum"}],"description":"The format of the clinical document data."},"deleted_date":{"format":"date-time","readOnly":true,"type":["string","null"]},"demographics_imported":{"type":"boolean"},"encounters_imported":{"type":"boolean"},"id":{"readOnly":true,"type":"integer"},"immunizations_imported":{"type":"boolean"},"labs_imported":{"type":"boolean"},"medications_imported":{"type":"boolean"},"patient":{"format":"int64","type":"integer"},"problems_imported":{"type":"boolean"},"procedures_imported":{"type":"boolean"},"vitals_imported":{"type":"boolean"},"xml_file":{"allOf":[{"$ref":"#/components/schemas/XmlFile"}],"description":"The xml file to be used as clinical document."}},"required":["authoring_practice","patient","xml_file"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"act_as_user":"Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes)","apiv2":"Full access to the API","system/{resource_name}.read":"Read access to a specific resource","system/{resource_name}.write":"Write access to a specific resource"},"tokenUrl":"/api/2.0/oauth2/token/"}},"type":"oauth2"}}},"info":{"contact":{"name":"Elation Health","url":"https://www.elationhealth.com/"},"description":"Elation Health API v2.0","title":"Scheduling API","version":"2.0.0"},"openapi":"3.1.0","paths":{"/api/2.0/appointment_types/":{"get":{"operationId":"appointment_types_list","parameters":[{"description":"Number of results to return per page.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Multiple values may be separated by commas.","explode":false,"in":"query","name":"name","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The initial index from which to return the results.","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Which field to use when ordering the results.","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"Multiple values may be separated by commas.","explode":false,"in":"query","name":"practice","schema":{"items":{"format":"int64","type":"integer"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAppointmentTypeList"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"List Appointment Types","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"post":{"operationId":"appointment_types_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Create Appointment Type","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/appointment_types/{id}/":{"delete":{"operationId":"appointment_types_destroy","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"No response body"}},"security":[{"oauth2":[]}],"summary":"Delete Appointment Type","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"get":{"operationId":"appointment_types_retrieve","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Retrieve Appointment Type","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"patch":{"operationId":"appointment_types_partial_update","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedAppointmentType"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Partially Update Appointment Type","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"put":{"operationId":"appointment_types_update","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentType"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Update Appointment Type","tags":["Appointment Types"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/appointments/":{"get":{"operationId":"appointments_list","parameters":[{"in":"query","name":"from_date","schema":{"format":"date-time","type":"string"}},{"description":"Number of results to return per page.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"The initial index from which to return the results.","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Which field to use when ordering the results.","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"Multiple values may be separated by commas.","explode":false,"in":"query","name":"patient","schema":{"items":{"format":"int64","type":"integer"},"type":"array"},"style":"form"},{"in":"query","name":"physician","schema":{"type":"string"}},{"description":"Multiple values may be separated by commas.","explode":false,"in":"query","name":"practice","schema":{"items":{"type":"integer"},"type":"array"},"style":"form"},{"in":"query","name":"time_slot_type","schema":{"enum":["appointment","appointment_slot","event"],"type":"string"}},{"in":"query","name":"to_date","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAppointmentList"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"List Appointments","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"post":{"operationId":"appointments_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Create Appointment","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/appointments/rooms/":{"get":{"description":"List the rooms available per practices","operationId":"appointments_rooms_retrieve","parameters":[{"description":"The practice ID to filter by.","in":"query","name":"practice","schema":{"items":{"format":"int64","type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"example":123,"type":"integer"},"next":{"example":"http://api.example.org/accounts/?offset=400&limit=100","format":"uri","nullable":true,"type":"string"},"previous":{"example":"http://api.example.org/accounts/?offset=200&limit=100","format":"uri","nullable":true,"type":"string"},"results":{"items":{"properties":{"name":{"type":"string"},"practice":{"format":"int64","type":"integer"}},"type":"object"},"type":"array"}},"required":["results"],"type":"object"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"List Appointment Rooms","tags":["Appointment Rooms"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/appointments/{id}/":{"delete":{"operationId":"appointments_destroy","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"No response body"}},"security":[{"oauth2":[]}],"summary":"Delete Appointment","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"get":{"operationId":"appointments_retrieve","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Retrieve Appointment","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"patch":{"operationId":"appointments_partial_update","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedAppointment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Partially Update Appointment","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"put":{"operationId":"appointments_update","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Update Appointment","tags":["Appointments"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/recurring_event_groups/":{"get":{"operationId":"recurring_event_groups_list","parameters":[{"description":"End of range to filter event groups by schedule date. Returns any group with schedules that don't start after this date.","in":"query","name":"end_date","schema":{"type":"string"}},{"description":"Number of results to return per page.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"The initial index from which to return the results.","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Which field to use when ordering the results.","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"The ids of providers associated with these recurring event groups.","in":"query","name":"physician","schema":{"items":{"type":"string"},"type":"array"}},{"description":"The practice for these recurring event groups.","explode":false,"in":"query","name":"practice","schema":{"items":{"format":"int64","type":"integer"},"type":"array"},"style":"form"},{"description":"The name of the recurring event group.","explode":false,"in":"query","name":"reason","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Start of range to filter event groups by schedule date. Returns any group with schedules that don't end before this date.","in":"query","name":"start_date","schema":{"type":"string"}},{"in":"query","name":"time_slot_type","schema":{"enum":["appointment","appointment_slot","event"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRecurringEventGroupList"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"List Recurring Event Groups","tags":["Recurring Event Groups"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"post":{"operationId":"recurring_event_groups_create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringEventGroup"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringEventGroup"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Create Recurring Event Group","tags":["Recurring Event Groups"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}},"/api/2.0/recurring_event_groups/{id}/":{"delete":{"operationId":"recurring_event_groups_destroy","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"No response body"}},"security":[{"oauth2":[]}],"summary":"Delete Recurring Event Group","tags":["Recurring Event Groups"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]},"get":{"operationId":"recurring_event_groups_retrieve","parameters":[{"in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringEventGroup"}}},"description":""}},"security":[{"oauth2":[]}],"summary":"Retrieve Recurring Event Group","tags":["Recurring Event Groups"],"x-el8-docs-category":"Scheduling API","x-el8-docs-versions":["2.1","2.0"]}}},"servers":[{"description":"Sandbox Server","url":"https://sandbox.elationemr.com"},{"description":"Production Server","url":"https://api.app.elationemr.com"}],"x-readme":{"proxy-enabled":true}}