AppointmentData
Information about the appointment.
Properties
Parameter | Type | Description |
---|---|---|
Key | string | Key of the existing appointment. |
Type | AppointmentTypeData | Type of appointment. |
Start | DateTime | Start time. |
Finish | DateTime | Finish time. |
Site | SiteData | Where the appointment is placed. |
Location | LocationData | Specific location within the site. |
Patient | PersonDemographicData | The patient data. |
Clinician | ClinicianData | Clinician of this appointment. |
State | string | The state code of the appointment. Possible values:
|
StateDisplayName | string | The friendly name of the appointment state. |
StateColor | string | The preferred colour of the appointment state. Red for Cancelled and DNA. Otherwise green. |
Modules | AppointmentModuleData[] | Modules related to the appointment. |
Services | ServiceData[] | Services related to the appointment |
Slots | AppointmentSlot[] | List of appointment’s slots. Used for booking. |
PrimaryAttendeeSlot | AppointmentSlot | Primary attendee slot. Used for booking. |
Invoice | InvoiceData | Invoice related to this appointment. The client can provided information about payment status of the invoice and if the invoice is not paid the client can offer online payment. |
Telemedicine | bool | Indicates whether the received appointment is telemedicine or not. On booking appointment the server ignores this parameter and books the appointment as telemedicine based on the TelemedicineOption in AppointmentTypeData |
TelemedicineConnection | string | URL for telemedicine connection to be launched in browser window. Whilst booking an appointment, this is left empty |
AuthorisationCode | string | The authorisation code provided when the insurer is the payer. |
JSON Example
{
"Key": "apt58462",
"Type": {
"Key": "CN",
"Name": "Consultation"
},
"Start": "2013-08-07T09:30:00",
"Finish": "2013-08-07T10:30:00",
"Telemedicine": true,
"TelemedicineConnection": "http://Meddbase.sandboxga.com/flex.html?roomdirect.html&key=Wchof474qrCO2QLrNK1SEMdrRY",
"AuthorisationCode": "ABC123",
"Site": {
"Key": 1123,
"Name": "2CP (Eye Room)",
"Address": {
"Address1": "2 Clifton Park Ave",
"Address2": "",
"Address3": "",
"City": "London",
"County": "",
"PostCode": "SW20 8BD",
"Country": "United Kingdom"
}
},
"Location": {
"Key": 214,
"Name": "Room 1",
"Address": {
"Address1": "2 Clifton Park Ave",
"Address2": "",
"Address3": "",
"City": "London",
"County": "",
"PostCode": "SW20 8BD",
"Country": "United Kingdom"
}
},
"Clinician": {
"Key": 84,
"Name": "Dr. House"
},
"Slots": [
{
"Type": "CN",
"Start": "2013-08-07T09:30:00",
"Finish": "2013-08-07T10:30:00",
"SiteKey": 1123,
"LocationKey": 214,
"ResourceKey": 468
}
],
"PrimaryAttendeeSlot": {
"Type": "CN",
"Start": "2013-08-07T09:30:00",
"Finish": "2013-08-07T10:30:00",
"SiteKey": 1123,
"LocationKey": 214,
"ResourceKey": 468
},
"Invoice": {
"Key": "inv4645",
"Date": "2013-02-06",
"Number": "1865",
"CurrencyCode": "GBP",
"CurrencySymbol": "£",
"TotalNet": 200,
"Tax": 40,
"TotalGross": 240,
"Paid": 150,
"Creditor": {
"Name": "AXA PPP Healthcare",
"IsCompany": true,
"Address": {
"Address1": "44 Pall Mall",
"City": "London",
"PostCode": "SW1Y",
"Country": "United Kingdom"
},
"Account": {
"CODE": "AXA",
"Name": "AXA PPP Healthcare",
"Address": {
"Address1": "44 Pall Mall",
"City": "London",
"PostCode": "SW1Y",
"Country": "United Kingdom"
}
}
},
"Debtor": {
"Name": "Mr. John Lemon",
"IsCompany": false,
"Address": {
"Address1": "Studio 99",
"Address2": "Backlok Street",
"Address3": "Camden",
"City": "London",
"County": "",
"PostCode": "N1 7NK",
"Country": "United Kingdom"
},
"Account": {
"Title": "Mr",
"Name": "John",
"Surname": "Lemon",
"SexType": 1,
"Initials": "JL",
"DateOfBirth": "1958-08-02T00:00:00",
"Mobile": "+444 895 523 411",
"Telephone": "+444 525 111 555",
"EmailAddress": "<john.lemon@test.com>",
"Address": {
"Address1": "Studio 99",
"Address2": "Backlok Street",
"Address3": "Camden",
"City": "London",
"County": "",
"PostCode": "N1 7NK",
"Country": "United Kingdom"
}
}
},
"PayableOnline": true
}
}