Appointment and clinical-service booking operations within the Pharmacy Unified API - listing available pharmacy services and time slots, creating and editing event bookings, managing event resources and staff calendars, and searching patients and bookings. Supports vaccination, health-check, and scope-of-practice service delivery in-pharmacy.
{"swagger":"2.0","info":{"version":"v1","title":"Pharmacy Unified API v1.0"},"host":"pharmacy-unified.api.medadvisor.com.au","schemes":["https"],"paths":{"/api/v1/account/3rdpartylogin":{"post":{"tags":["3rd-Party Integration"],"summary":"Login with pharmacy username and password(encoded).","description":"To login into MedAdvisor's system, send a <code>POST</code> request to <code>/loginthirdparty</code> and provide <code>userName</code> and <code>password</code> which is encoded by Base64-encoded UTF8 string. MedAdvisor will provide integrators with a <code>clientId</code> and a <code>clientSecret</code>. Consequently, MedAdvisor is going to return a token, which is used for authentication purposes in APIs requiring token-based authentication. ","operationId":"Account_LoginPharmacy","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The identity model for logging in","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.AuthLoginPharmacy","example":{"userName":"abc@example.com","password_encoded":"cGFzc3dvcmQ=","clientId":"clientId","clientSecret":"clientSecret"}},"type":"AuthLoginPharmacy"}],"responses":{"200":{"description":"OK","schema":{"type":"object"},"examples":{"application/json ( Success (below is an example token and not intented to be used)) ":"{\r\n \"errorData\": {},\r\n \"result\": 1,\r\n \"resultMessage\": null,\r\n \"data\": {\r\n \"token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjBGQURBQjc2NDM4MTgyRUEyRTNEMjY4NjZBNjA1RDNCMzM0RDU2MDhSUzI1NiIsInR5cCI6IkpXVCIsIng1dCI6IkQ2MnJka09CZ3VvdVBTYUdhbUJkT3pOTlZnZyJ9.eyJuYmYiOjE3MTE0NDMyNjQsImV4cCI6MTcxMTUyOTY2NCwiaXNzIjoiaHR0cHM6Ly9pZC10ZXN0Lm1lZGFkdmlzb3IuaW8iLCJhdWQiOiJwaGFybWFjeS13ZWIiLCJpYXQiOjE3MTE0NDMyNjQsImF0X2hhc2giOiIzeWlfTUlMS0phY0JabFRKaWZsQXZRIiwic19oYXNoIjoid09YZ09hSDFzUlVwcXZKVkdkMWdwUSIsInNpZCI6IkMxQzA2N0M1RTQzQkRFNzNENzJCQjAxRjg3REI2MTA4Iiwic3ViIjoiNzMzNzRkNzAtNWYxNi00ZDM4LWI3NzQtZGQzNjRiOGExN2VkIiwiYXV0aF90aW1lIjoxNzExNDQzMjYwLCJpZHAiOiJsb2NhbCIsImFjciI6Im1hOmxvYToyZmE6b3RwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoic29uZHE2QHRlc3QuY29tIiwiZ2l2ZW5fbmFtZSI6IlNvbiIsInN1cm5hbWUiOiJEUTYiLCJwaGFybWFjaXN0LnBoLnV1IjoiZDU0ZDViMDQtY2I0OC00YmU4LTk5YjYtNzA1Zjk5NDRiYzUxIiwicGgtYWRtaW4ucGgudXUiOiJkNTRkNWIwNC1jYjQ4LTRiZTgtOTliNi03MDVmOTk0NGJjNTEiLCJyb2xlIjpbIlBoYXJtYWNpc3QiLCJwaC1hZG1pbiJdLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzb25kcTZAdGVzdC5jb20iLCJwaGFybWFjaXN0LnBoLmVnIjoiMTIwMDExIiwicGgtYWRtaW4ucGguZWciOiIxMjAwMTEiLCJhbXIiOlsibWZhIl19.jVmdK0UYobOWGWfXJ6h8Q4ArBk9LPyqrl5--zFS8G8oBk1mpq0t9PZAt1ZgVBmTv2jAUfIp-hPal2pkivMna9MgCFPoR4ifk-CrEBlrfCd1uBQFRXdSsNEpe8cW3yNzwdhXocvHg8RvnFGmCa29G57Eepco6YDGCGUY3RczgvB0nG3DE6hUoAhDxW0kZgMAfY_dRt54fjl3f5cpIKbRazQ85U7rej6m8p5AQIHGkddqrubpNAqh39uKbm8a8oQMdBoGjYo_oAVF0ANhdFNyKVlVIhbcHBA4wYvjDQ2NKqEOL8OfSHMrG7MLcpsZBRo0xqRvasRMoZ5Hk98fugA6i-A\",\r\n \"error\": null,\r\n \"status\": \"Success\",\r\n \"properties\": {}\r\n }\r\n}"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.HSH.Core.Structure.IdResult, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]"},"examples":{"application/json ( InvalidUser.) ":"{\r\n \"errorData\": {},\r\n \"result\": -6,\r\n \"resultMessage\": null,\r\n \"data\": {\r\n \"token\": null,\r\n \"error\": \"InvalidUser\",\r\n \"status\": \"InvalidUser\",\r\n \"properties\": {}\r\n }\r\n}"}},"404":{"description":"Not Found","examples":{"application/json ( Not found or feature is not available) ":"{\r\n \"errorData\": {},\r\n \"result\": 0,\r\n \"resultMessage\": null,\r\n \"data\": {\r\n \"httpStatusCode\": 404,\r\n \"result\": 0,\r\n \"resultMessage\": \"Entity not found.\"\r\n }\r\n}"}}},"deprecated":false}},"/api/v1/account/resetpassword":{"post":{"tags":["Account"],"summary":"Request reset password for pharmacy user.","operationId":"Account_ResetPassword","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.ResetPasswordRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/gettime":{"get":{"tags":["BookingService"],"summary":"Get Pharmacy Time","operationId":"BookingService_GetPharmacyTime","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.DateTimeResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/allservices":{"get":{"tags":["BookingService"],"summary":"Alls the services.","operationId":"BookingService_AllServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventServiceModel"}}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventresource":{"get":{"tags":["BookingService"],"summary":"Retrieve Event Resources","operationId":"BookingService_RetrieveEventResources","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventResourceResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/dynamic":{"get":{"tags":["BookingService"],"summary":"Retrieve Dynamic Services.","operationId":"BookingService_RetrieveDynamicServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.BookingAvailabilityResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/available":{"get":{"tags":["BookingService"],"summary":"Retrieve Available Services","operationId":"BookingService_RetrieveAvailableServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.BookingAvailabilityResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventresource/{resourceId}":{"get":{"tags":["BookingService"],"summary":"Retrieve Event Resources","operationId":"BookingService_RetrieveEventResource","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resourceId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventResourceResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/booking/{bookingId}":{"get":{"tags":["BookingService"],"summary":"Retrieve Booking","operationId":"BookingService_RetrieveBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bookingId","in":"path","description":"BookingId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventBookingResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/calendartoken/{resetStaffUrl}":{"get":{"tags":["BookingService"],"operationId":"BookingService_RetrieveCalendarAccessTokens","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resetStaffUrl","in":"path","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.CalendarAccessTokenResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/dynamic/{capabilityId}":{"get":{"tags":["BookingService"],"summary":"Retrieve Dynamic Services by Capability Id.","operationId":"BookingService_RetrieveDynamicServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"capabilityId","in":"path","description":"CapabilityId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.BookingAvailabilityResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/available/{capabilityId}":{"get":{"tags":["BookingService"],"summary":"Retrieve Available Services by Capability Id","operationId":"BookingService_RetrieveAvailableServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"capabilityId","in":"path","description":"CapabilityId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.BookingAvailabilityResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/calendartokendetails/{calendarToken}/{staffToken}":{"get":{"tags":["BookingService"],"operationId":"BookingService_RetrieveCalendarTokenDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calendarToken","in":"path","required":true,"type":"string"},{"name":"staffToken","in":"path","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.CalenderTokenModel"}}}}},"/api/v1/bookingservice/pharmacy/retrieveavailabletimeslots":{"get":{"tags":["BookingService"],"summary":"Retrieve available times slots","operationId":"BookingService_RetrieveAvailableTimeslots","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resourceId","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"date","in":"query","description":"dd/MM/yyyy","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"object"}}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/availabletimeslotnewbooking":{"get":{"tags":["BookingService"],"summary":"Retrieves the available time slot new booking.","operationId":"BookingService_RetrieveAvailableTimeSlotNewBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"serviceId","in":"query","description":"The service identifier.","required":true,"type":"integer","format":"int32"},{"name":"date","in":"query","description":"The date.","required":true,"type":"string"},{"name":"noOfDays","in":"query","description":"The no of days.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventBookingResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/retrieveeventbookings":{"get":{"tags":["BookingService"],"summary":"Retrieves the event bookings.","operationId":"BookingService_RetrieveEventBookings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"The start date.","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The end date.","required":true,"type":"string","format":"date-time"},{"name":"resourceId","in":"query","description":"The resource identifier.","required":true,"type":"integer","format":"int32"},{"name":"includeResourceAvailability","in":"query","description":"if set to true [include resource availability].","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventBookingResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/patientsearch":{"post":{"tags":["BookingService"],"summary":"Searches the patients.","operationId":"BookingService_SearchPatients","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model.","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.UserSearchModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.UserSearchResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/services/update":{"post":{"tags":["BookingService"],"summary":"Update services","operationId":"BookingService_UpdateEventService","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventServiceModel"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/services/historic":{"post":{"tags":["BookingService"],"summary":"Retrieve Historic Bookings","operationId":"BookingService_RetrieveHistoricBookings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"HistoricBookingModel","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.HistoricBookingModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.Results.BookingStatusResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/createeventbooking":{"post":{"tags":["BookingService"],"summary":"Creates the event booking.","operationId":"BookingService_CreateEventBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"eventBooking","in":"body","description":"The event booking.","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventBookingModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/services/suggested":{"post":{"tags":["BookingService"],"summary":"Retrieve Suggested Services","operationId":"BookingService_RetrieveSuggestedServices","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"list is available and list if history","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.SuggestedSearchModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.BookingAvailabilityResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/eventbooking/update":{"post":{"tags":["BookingService"],"summary":"Updates the event booking.","operationId":"BookingService_UpdateEventBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model.","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventBookingModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/eventresource/update":{"post":{"tags":["BookingService"],"summary":"Updates the event resource.","operationId":"BookingService_UpdateEventResource","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventResourceModel"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/eventpreferences/update":{"post":{"tags":["BookingService"],"summary":"Updates the event preferences.","operationId":"BookingService_UpdateEventPreferences","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"The model.","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventPreferenceModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/generate":{"post":{"tags":["BookingService"],"summary":"Generate Service Booking","operationId":"BookingService_GenerateServiceBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"booking","in":"body","description":"booking data","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.BookingRequestModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/print/{bookingCode}":{"post":{"tags":["BookingService"],"summary":"Prints the specified booking code.","operationId":"BookingService_Print","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bookingCode","in":"path","description":"\"Blank_[PrescreenView]_CapbilityId\", \"Today\", \"TodayCap[CapabilityId]\", \"Date_[yyyy-mm-dd]_[CapabilityId]\", or a booking Code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.PrescreenFormModel"}}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/bookingedit":{"post":{"tags":["BookingService"],"summary":"Event booking edit","operationId":"BookingService_EditBookingWithCheck","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.BookingValidateModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventresource/create/{name}":{"post":{"tags":["BookingService"],"summary":"Creates the event resource.","operationId":"BookingService_CreateEventResource","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The name.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/delete/{serviceId}":{"post":{"tags":["BookingService"],"summary":"Deletes the event service.","operationId":"BookingService_DeleteEventService","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"serviceId","in":"path","description":"The service identifier.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventbooking/{bookingId}/delete":{"post":{"tags":["BookingService"],"summary":"Deletes the event booking.","operationId":"BookingService_DeleteEventBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bookingId","in":"path","description":"The booking identifier.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventresource/update/{resourceId}":{"post":{"tags":["BookingService"],"summary":"Update Event Resource Associate Service","operationId":"BookingService_UpdateEventResourceAssociateService","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"},{"name":"capabilityId","in":"body","description":"capabilityId","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/eventresource/{resourceId}/delete":{"post":{"tags":["BookingService"],"summary":"Deletes the event resource.","operationId":"BookingService_DeleteEventResource","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resourceId","in":"path","description":"The resource identifier.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/bookingsearch":{"post":{"tags":["BookingService"],"summary":"Booking search.","operationId":"BookingService_BookingSearch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchingKeyword","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventBookingWrapper"}}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/availableresource/{capabilityId}":{"post":{"tags":["BookingService"],"summary":"Retrieve Available Services Resource For Capability","operationId":"BookingService_RetrieveAvailableResourceForCapability","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"capabilityId","in":"path","description":"CapabilityId","required":true,"type":"integer","format":"int32"},{"name":"date","in":"query","description":"Date","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.EventBookingResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/pharmacy/services/deletebooking/{bookingId}":{"delete":{"tags":["BookingService"],"summary":"Delete an event (calendar) booking","operationId":"BookingService_DeleteServiceBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bookingId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/bookingservice/deletebookingrequest/{patientId}/{bookingId}":{"delete":{"tags":["BookingService"],"summary":"Deletes the booking request.","operationId":"BookingService_DeleteBookingRequest","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"patientId","in":"path","description":"The patient identifier.","required":true,"type":"integer","format":"int32"},{"name":"bookingId","in":"path","description":"The booking identifier.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/GetPatientGroups":{"get":{"tags":["Communication"],"summary":"Get patient groups","operationId":"Communication_GetPatientGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupType","in":"query","description":"","required":true,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/GetAllPatientGroupMembers":{"get":{"tags":["Communication"],"summary":"Get all patient group members","operationId":"Communication_GetAllPatientGroupMembers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/AddPatientGroup":{"post":{"tags":["Communication"],"summary":"Add patient group","operationId":"Communication_AddPatientGroup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.PatientGroupRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/EditPatientGroup":{"post":{"tags":["Communication"],"summary":"Edit patient group","operationId":"Communication_EditPatientGroup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.PatientGroupRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/UpdatePatientGroupMembers":{"post":{"tags":["Communication"],"summary":"Update patient group members","operationId":"Communication_UpdatePatientGroupMembers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.PatientGroupMemberRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/comunication/DeletePatientGroup/{id}":{"delete":{"tags":["Communication"],"summary":"Delete patient group","operationId":"Communication_DeletePatientGroup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/config/demographicRules":{"get":{"tags":["Config"],"summary":"Retrieve Demographic Rules Details","operationId":"Config_RetrieveDemographicRules","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.DemoRuleSetResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/config/precursorInstructions":{"get":{"tags":["Config"],"summary":"Retrieve Demographic Rules Details","operationId":"Config_RetrievePrecursorInstructionMappings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MedAdvisor.Framework.Interface.InstructionAbstractionResult"}}},"security":[{"Bearer":[]}]}},"/api/v1/drug/escript/{token}":{"get":{"tags":["3rd-Party Integration"],"summary":"Retrieve details of a electronic prescription from PDS, given a EScript token","description":"Patient is going to transfer this token, medication, patient information... from Mobile Patient App to MedAdvisor. \nDuring the MedAdvisor's process, patient can look into the information about medication, quantity, status... in Mobile Patient App, by making an API call GET /escript/{token} to retrieve all the information mentioned above. \nIntegrators put the token of the dispensation into parameters request, MedAdvisor responses dispense information","operationId":"Drug_RetrieveEPrescription3rdParty","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"token","in":"path","description":"The EScript token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"},"examples":{"200":{"errorData":null,"result":0,"resultMessage":"success","data":{"errorStatus":0,"errorMessage":"success","eScripts":[{"drugId":40,"drugActiveName":"AMINOCAPROIC ACID","drugForm":"AMP","drugStrength":"250MG/ML 20ML","drugLabelName":"AMICAR","quantity":0.0,"repeatsRemaining":2,"totalRepeats":4,"token":"AMIN7","qrCodeForToken":"qr code","drugAmtCodes":["TPP","MPP"],"instructions":"drug's instruction","status":0,"source":0,"patientId":123,"isReadyInOrder":true,"patientFullName":"Patient Name","isUnknownDrugEScript":false,"unknownEscriptErrorHandling":false,"escriptName":"Escript name"}]}},"application/json ( Token not found!) ":"{\r\n \"errorData\": {},\r\n \"result\": 1,\r\n \"resultMessage\": \"\",\r\n \"data\": {\r\n \"errorStatus\": 3,\r\n \"errorMessage\": \"Token not found!\",\r\n \"eScripts\": null\r\n }\r\n}"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.HSH.Core.Structure.Patient.PdsEScriptModel, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]"},"examples":{"application/json ( Token is empty!) ":"{\r\n \"errorData\": {},\r\n \"result\": 1,\r\n \"resultMessage\": \"\",\r\n \"data\": {\r\n \"errorStatus\": 3,\r\n \"errorMessage\": \"Token is empty!\",\r\n \"eScripts\": null\r\n }\r\n}"}},"401":{"description":"Unauthorized","examples":{"application/json ( Authorization has been denied for this request.) ":"{\r\n \"message\": \"Authorization has been denied for this request.\"\r\n}"}},"500":{"description":"Internal Server Error","examples":{"application/json ( An error has occurred) ":"{\r\n \"message\": \"An error has occurred\"\r\n}"}}},"deprecated":false,"security":[{"Bearer":[]}]}},"/api/v1/hq/services":{"get":{"tags":["HeadOffice"],"operationId":"HeadOffice_GetServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]},"post":{"tags":["HeadOffice"],"summary":"Creates an HO custom service (RAP-38 Story 2.5). The service is owned by the caller's report\r\ngroup and is NOT pushed to any pharmacy — it lands in the catalogue as \"Not pushed\". Returns\r\nthe created service. Pushing to pharmacies is a separate operation (Story 2.7).","operationId":"HeadOffice_CreateService","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoCreateServiceRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}},"security":[{"Bearer":[]}]}},"/api/v1/hq/pharmacies":{"get":{"tags":["HeadOffice"],"operationId":"HeadOffice_GetPharmacies","consumes":[],"produces":["application/json","text/json","
# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/medadvisor/refs/heads/main/openapi/medadvisor-pharmacy-unified-openapi.json