drchrono · Schema
Office
EHRElectronic Health RecordsHealthcareMedical RecordsPractice ManagementHIPAAAppointmentsBillingPrescriptionsLab IntegrationFHIR
Properties
| Name | Type | Description |
|---|---|---|
| phone_number | string | |
| city | string | |
| archived | boolean | Indicates that the object has been soft-deleted and should not be used |
| office_work_schedule | object | Office work schedule (beta) |
| name | string | |
| doctor | string | ID of the doctor who owns the office |
| country | string | Two-letter country code |
| start_time | string | Truncated to the hour. Default is `00:00:00` |
| fax_number | string | |
| online_timeslots | array | Array of timslots |
| state | string | Two-letter abbreviation |
| end_time | string | Truncated to the hour. Default is `24:00` |
| exam_rooms | string | |
| address | string | |
| tax_id_number_professional | string | Billing Tax ID # |
| zip_code | string | |
| id | integer | |
| online_scheduling | boolean | Default is `false` |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://api-evangelist.github.io/drchrono/json-schema/office.json",
"title": "Office",
"required": [],
"type": "object",
"properties": {
"phone_number": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Phone number"
},
"city": {
"readOnly": true,
"type": "string",
"description": "",
"title": "City"
},
"archived": {
"type": "boolean",
"description": "Indicates that the object has been soft-deleted and should not be used",
"title": "Archived"
},
"office_work_schedule": {
"$ref": "#/components/schemas/WorkSchedule",
"description": "Office work schedule (beta)",
"title": "Office Work schedule"
},
"name": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Name"
},
"doctor": {
"readOnly": true,
"type": "string",
"description": "ID of the doctor who owns the office",
"title": "Doctor"
},
"country": {
"readOnly": true,
"enum": [
"",
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CW",
"CY",
"CZ",
"CYM",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"type": "string",
"description": "Two-letter country code",
"title": "Country"
},
"start_time": {
"type": "string",
"description": "Truncated to the hour. Default is `00:00:00`",
"title": "Start time"
},
"fax_number": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Fax number"
},
"online_timeslots": {
"items": {
"title": "OfficeOnlineHours",
"type": "object",
"description": "",
"properties": {
"minute": {
"type": "integer",
"description": "One of `0`, `15`, `30` or `45`",
"title": "Minute"
},
"day": {
"type": "integer",
"description": "`0`(Monday), ..., `6`(Sunday)",
"title": "Day"
},
"hour": {
"type": "integer",
"description": "From `0` to `23`",
"title": "Hour"
}
}
},
"type": "array",
"description": "Array of timslots",
"title": "Online timeslots"
},
"state": {
"readOnly": true,
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
],
"type": "string",
"description": "Two-letter abbreviation",
"title": "State"
},
"end_time": {
"type": "string",
"description": "Truncated to the hour. Default is `24:00`",
"title": "End time"
},
"exam_rooms": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Exam rooms"
},
"address": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Address"
},
"tax_id_number_professional": {
"readOnly": true,
"type": "string",
"description": "Billing Tax ID #",
"title": "Tax id number professional"
},
"zip_code": {
"readOnly": true,
"type": "string",
"description": "",
"title": "Zip code"
},
"id": {
"readOnly": true,
"type": "integer",
"description": "",
"title": "ID"
},
"online_scheduling": {
"type": "boolean",
"description": "Default is `false`",
"title": "Online scheduling"
}
},
"x-verbose-required": [
"online_timeslots"
]
}