POST api/Calendar/PatientAppointmentPost
Patient Book Appointment
Request Information
URI Parameters
None.
Body Parameters
AppointmentModelName | Description | Type | Additional information |
---|---|---|---|
EncounterTypeId | globally unique identifier |
None. |
|
EncounterTypeModeDurationId | globally unique identifier |
None. |
|
ProviderId | globally unique identifier |
None. |
|
UserId | globally unique identifier |
Required |
|
PatientId | globally unique identifier |
None. |
|
SpecialityId | globally unique identifier |
None. |
|
AppointmentOn | date |
Required |
|
SecondaryAppointmentOn | date |
None. |
|
Reason | string |
Required String length: inclusive between 0 and 250 |
|
Note | string |
String length: inclusive between 0 and 1000 |
|
ParentId | globally unique identifier |
None. |
|
ReferredParentId | globally unique identifier |
None. |
|
PaidAmount | decimal number |
None. |
|
AccountId | globally unique identifier |
Required |
|
ServiceId | globally unique identifier |
None. |
|
MethodId | integer |
None. |
|
IsCustomFormFlow | string |
None. |
|
DocIds | string |
None. |
|
Reasons | Collection of Reasons |
None. |
Request Formats
application/json, text/json
{ "EncounterTypeId": "17508cff-1ad3-43cf-8662-5cad734ad001", "EncounterTypeModeDurationId": "6c583dc8-a373-4139-9b4a-62cfe154e55b", "ProviderId": "1f5c9b88-961f-408d-b86b-4f860c0bf574", "UserId": "f97d0904-1be5-410a-b41c-1c39add53bcf", "PatientId": "f615f1fb-71e2-4d5f-8991-7e494fc0c9a8", "SpecialityId": "780916fc-b77a-4656-b478-20594f3e0b54", "AppointmentOn": "2024-07-05T15:40:31.629616-05:00", "SecondaryAppointmentOn": "2024-07-05T15:40:31.629616-05:00", "Reason": "sample string 3", "Note": "sample string 4", "ParentId": "149f910b-913f-447d-a8ff-2975f14d1d02", "ReferredParentId": "725f00e3-f536-4105-b182-57a14f324d10", "PaidAmount": 5.0, "AccountId": "7652a09e-d66b-4238-8df3-965a47db44a5", "ServiceId": "6559e2c1-c785-43f7-b78c-232c112dcddf", "MethodId": 1, "IsCustomFormFlow": "sample string 7", "DocIds": "sample string 8", "Reasons": [ { "ReasonId": "1b99ee1d-a9ab-432a-9713-c492ff8d47db" }, { "ReasonId": "1b99ee1d-a9ab-432a-9713-c492ff8d47db" } ] }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Schedule
ScheduleName | Description | Type | Additional information |
---|---|---|---|
ID | globally unique identifier |
None. |
|
FacilityId | globally unique identifier |
None. |
|
ResourceID | globally unique identifier |
None. |
|
AppointmentTypeId | globally unique identifier |
None. |
|
PreferredPharmacyId | globally unique identifier |
None. |
|
EncounterTypeModeDurationId | globally unique identifier |
None. |
|
ServiceId | globally unique identifier |
None. |
|
FromUserType | character |
None. |
|
FromUserID | globally unique identifier |
None. |
|
UserId | globally unique identifier |
None. |
|
Title | string |
None. |
|
Reason | string |
None. |
|
CancelReason | string |
None. |
|
Type | string |
None. |
|
AppointmentOn | date |
None. |
|
SecondaryAppointmentOn | date |
None. |
|
FromDate | date |
None. |
|
Duration | integer |
None. |
|
Note | string |
None. |
|
ToDate | date |
None. |
|
StatusId | integer |
None. |
|
AppointmentCount | integer |
None. |
|
EncounterTypeModeId | integer |
None. |
|
RoomNo | string |
None. |
|
Option | string |
None. |
|
CallType | string |
None. |
|
CallRefId | string |
None. |
|
GuardianName | string |
None. |
|
Location | string |
None. |
|
SpecialityId | globally unique identifier |
None. |
|
ParentScheduleId | globally unique identifier |
None. |
|
DoctorId | globally unique identifier |
None. |
|
PaidDate | date |
None. |
|
AppointmentOnUTC | date |
None. |
|
SecondaryAppointmentOnUTC | date |
None. |
|
PaidAmount | decimal number |
None. |
|
AccountId | globally unique identifier |
None. |
|
GuardianId | globally unique identifier |
None. |
|
PatientReferralId | globally unique identifier |
None. |
|
ParentId | globally unique identifier |
None. |
|
PatientId | globally unique identifier |
None. |
|
IsGuardian | integer |
None. |
|
AppointmentModeId | integer |
None. |
|
ReferenceId | string |
None. |
|
VisitMode | string |
None. |
|
VisitCode | string |
None. |
|
Doctor | string |
None. |
|
MethodId | integer |
None. |
|
PayConceptId | integer |
None. |
|
PayMethodId | integer |
None. |
|
DocIds | Collection of string |
None. |
|
ReasonId | string |
None. |
|
DocId | string |
None. |
|
DoctorTimeZone | string |
None. |
|
PatientTimeZone | string |
None. |
|
PatientHummyurl | string |
None. |
|
DoctorOffset | integer |
None. |
|
PatientOffset | integer |
None. |
|
EncounterId | globally unique identifier |
None. |
|
DoctorZoneDate | string |
None. |
|
PrimaryPatient | string |
None. |
|
SessionId | string |
None. |
|
OldAppointmentOn | date |
None. |
|
OldAppointmentOnUTC | date |
None. |
|
OldSecondaryAppointmentOnUTC | date |
None. |
|
PortalType | string |
None. |
|
UserOffset | integer |
None. |
|
EncounterNo | string |
None. |
|
StatusName | string |
None. |
|
InsuranceName | string |
None. |
|
InsuranceId | globally unique identifier |
None. |
|
Patient | Patient |
None. |
|
EncounterType | EncounterType |
None. |
|
Resource | Resource |
None. |
|
Status | Status |
None. |
|
Facility | Facility |
None. |
|
Encounter | Encounter |
None. |
|
Member | Member |
None. |
|
Notification | Notification |
None. |
|
Speciality | Speciality |
None. |
|
ScheduleDetails | Collection of ScheduleDetail |
None. |
|
Members | Collection of Member |
None. |
|
customFormModel | Collection of CustomFormModel |
None. |
|
ModifiedBy | globally unique identifier |
None. |
|
ModifiedOn | date |
None. |
|
Modified | Member |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.