Pharmacy Unified API - Communication
Patient-communication and group-messaging operations within the Pharmacy Unified API - creating and editing patient groups, managing group membership, and supporting targeted patient outreach from the pharmacy.
Pharmacy Unified API - Communication is one of 8 APIs that MedAdvisor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Pharmacy, Patient Engagement, and Messaging. The published artifact set on APIs.io includes an API reference and an OpenAPI specification.
This API exposes 112 operations across 107 paths, organized into 10 resource areas, and defines 120 schemas. It is described by OpenAPI 2.0, at version v1.
Requests are made against the base URL https://pharmacy-unified.api.medadvisor.com.au.
112 operations
107 paths
120 schemas
5 DELETE45 GET58 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Pharmacy Unified API - Communication declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
Bearer— JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Paths & Operations 112
Across 107 paths, the API surfaces 112 operations — 5 DELETE, 45 GET, 58 POST, 4 PUT. They span 10 resource areas: 3rd-Party Integration, Account, BookingService, Communication, Config, HeadOffice, Inbox, Logging, Pharmacy, RefillOrder. Each is listed below with its method, path, parameters, and response codes.
3rd-Party Integration 4
POST
/api/v1/account/3rdpartylogin
Login with pharmacy username and password(encoded).
GET
/api/v1/drug/escript/{token}
Retrieve details of a electronic prescription from PDS, given a EScript token
GET
/api/v1/pharmacy/{id}
Retrieve pharmacy detail information including services information , delivery settings, etc.
POST
/api/v1/pharmacy/notify
Push a message in Inbox of PlusOne. The detail of message displays description and the clickable URL of the order.
Account 1
POST
/api/v1/account/resetpassword
Request reset password for pharmacy user.
BookingService 34
GET
/api/v1/bookingservice/pharmacy/gettime
Get Pharmacy Time
GET
/api/v1/bookingservice/pharmacy/allservices
Alls the services.
GET
/api/v1/bookingservice/pharmacy/eventresource
Retrieve Event Resources
GET
/api/v1/bookingservice/pharmacy/services/dynamic
Retrieve Dynamic Services.
GET
/api/v1/bookingservice/pharmacy/services/available
Retrieve Available Services
GET
/api/v1/bookingservice/pharmacy/eventresource/{resourceId}
Retrieve Event Resources
GET
/api/v1/bookingservice/pharmacy/services/booking/{bookingId}
Retrieve Booking
GET
/api/v1/bookingservice/pharmacy/calendartoken/{resetStaffUrl}
GET
/api/v1/bookingservice/pharmacy/services/dynamic/{capabilityId}
Retrieve Dynamic Services by Capability Id.
GET
/api/v1/bookingservice/pharmacy/services/available/{capabilityId}
Retrieve Available Services by Capability Id
GET
/api/v1/bookingservice/pharmacy/calendartokendetails/{calendarToken}/{staffToken}
GET
/api/v1/bookingservice/pharmacy/retrieveavailabletimeslots
Retrieve available times slots
GET
/api/v1/bookingservice/pharmacy/availabletimeslotnewbooking
Retrieves the available time slot new booking.
GET
/api/v1/bookingservice/pharmacy/retrieveeventbookings
Retrieves the event bookings.
POST
/api/v1/bookingservice/patientsearch
Searches the patients.
POST
/api/v1/bookingservice/services/update
Update services
POST
/api/v1/bookingservice/services/historic
Retrieve Historic Bookings
POST
/api/v1/bookingservice/createeventbooking
Creates the event booking.
POST
/api/v1/bookingservice/services/suggested
Retrieve Suggested Services
POST
/api/v1/bookingservice/eventbooking/update
Updates the event booking.
POST
/api/v1/bookingservice/eventresource/update
Updates the event resource.
POST
/api/v1/bookingservice/eventpreferences/update
Updates the event preferences.
POST
/api/v1/bookingservice/pharmacy/services/generate
Generate Service Booking
POST
/api/v1/bookingservice/pharmacy/print/{bookingCode}
Prints the specified booking code.
POST
/api/v1/bookingservice/pharmacy/services/bookingedit
Event booking edit
POST
/api/v1/bookingservice/pharmacy/eventresource/create/{name}
Creates the event resource.
POST
/api/v1/bookingservice/pharmacy/services/delete/{serviceId}
Deletes the event service.
POST
/api/v1/bookingservice/pharmacy/eventbooking/{bookingId}/delete
Deletes the event booking.
POST
/api/v1/bookingservice/pharmacy/eventresource/update/{resourceId}
Update Event Resource Associate Service
POST
/api/v1/bookingservice/pharmacy/eventresource/{resourceId}/delete
Deletes the event resource.
POST
/api/v1/bookingservice/pharmacy/bookingsearch
Booking search.
POST
/api/v1/bookingservice/pharmacy/services/availableresource/{capabilityId}
Retrieve Available Services Resource For Capability
DELETE
/api/v1/bookingservice/pharmacy/services/deletebooking/{bookingId}
Delete an event (calendar) booking
DELETE
/api/v1/bookingservice/deletebookingrequest/{patientId}/{bookingId}
Deletes the booking request.
Communication 6
GET
/api/v1/comunication/GetPatientGroups
Get patient groups
GET
/api/v1/comunication/GetAllPatientGroupMembers
Get all patient group members
POST
/api/v1/comunication/AddPatientGroup
Add patient group
POST
/api/v1/comunication/EditPatientGroup
Edit patient group
POST
/api/v1/comunication/UpdatePatientGroupMembers
Update patient group members
DELETE
/api/v1/comunication/DeletePatientGroup/{id}
Delete patient group
Config 2
GET
/api/v1/config/demographicRules
Retrieve Demographic Rules Details
GET
/api/v1/config/precursorInstructions
Retrieve Demographic Rules Details
HeadOffice 8
GET
/api/v1/hq/services
POST
/api/v1/hq/services
Creates an HO custom service (RAP-38 Story 2.5). The service is owned by the caller's report group and is NOT pushed to any pharmacy — it lands in the catalogue as "Not pushed". Returns the created s…
GET
/api/v1/hq/pharmacies
GET
/api/v1/hq/services/{id}
PUT
/api/v1/hq/services/{id}
Edits an HO-owned service (RAP-38 Story 2.5). The change updates the shared service definition, so it applies to every pharmacy already linked to it — this does not push to new pharmacies. Returns th…
GET
/api/v1/hq/pharmacies/{id}
PUT
/api/v1/hq/services/{id}/push/{pharmacyId}/deadline
Extends or shortens the auto-activation deadline on a pending push (RAP-38 Story 3a.5, AC1a). Shortening into the past is allowed — the nightly job picks it up on its next run.
POST
/api/v1/hq/services/{id}/push
Pushes an HO service to pharmacies in the group (RAP-38 Story 2.7) by scope — all, by state, or selected pharmacies. Force-links each target with visibility off (pushed, not yet live). Returns the pu…
Inbox 8
GET
/api/v1/inbox/main
Get inbox messages
POST
/api/v1/inbox/sent
Get inbox sent messages
POST
/api/v1/inbox/addscript
Create deferred scripts from order
POST
/api/v1/inbox/completed
Get inbox completed messages
POST
/api/v1/inbox/scheduled
Get inbox scheduled messages
POST
/api/v1/inbox/sendscheduled
Send scheduled messages
POST
/api/v1/inbox/readytocollect
Mark multiple messages as Ready to collect
POST
/api/v1/inbox/dismissmultiple
Dismiss message
Logging 1
POST
/api/v1/logging
Forward log from Pharmacy-Web client (angular application) to CloudWatch. Callers should use a bearer token if they have one, despite AllowAnonymous, to allow the caller identity to be included in th…
Pharmacy 33
GET
/api/v1/pharmacy
GET
/api/v1/pharmacy/settings
Retrieve Pharmacy Details
PUT
/api/v1/pharmacy/settings
Update Pharmacy Details
GET
/api/v1/pharmacy/GetAuthInfo
GET
/api/v1/pharmacy/ho-pending-activations
Pending HO-pushed services for this pharmacy — pushed, not yet live, with an auto-activation countdown (RAP-38 Story 3a.5). Empty list when nothing is pending.
GET
/api/v1/pharmacy/PharmacyHasPendingHshSms
Get all pharmacy which has Pending SMS Broadcast messages
GET
/api/v1/pharmacy/GetPharmacyModuleSettings
Get pharmacy module settings
GET
/api/v1/pharmacy/GetPharmacyActivatingBanner
Get pharmacy activating banner
GET
/api/v1/pharmacy/ElectronicPrescribingSettings
Retrieve Pharmacy Electronic Prescribing Settings
GET
/api/v1/pharmacy/RetrievePharmaciesWithPendingSMSReminders
Retrieves pharmacies with pending SMS Reminders.
GET
/api/v1/pharmacy/PendingHshSmsMessage
Get all pharmacy which has Pending SMS Broadcast messages
GET
/api/v1/pharmacy/RetrieveSMSReminderPending
Retrieves SMS Reminder Pending patients.
GET
/api/v1/pharmacy/RetrievePlusOneQueuedActions
Retrieves actions to be carried out by the PlusOne client.
GET
/api/v1/pharmacy/GetPharmacyReleaseNotes
Get pharmacy release notes
GET
/api/v1/pharmacy/GetPharmacyReleaseNotesByType
Get pharmacy release notes by types
GET
/api/v1/pharmacy/logo
Get Photo PreSigned Url
POST
/api/v1/pharmacy/logo
Upload Pharmacy Logo
GET
/api/v1/pharmacy/GetModuleSettingsByIdentifier
GET
/api/v1/pharmacy/GetPharmacySettingByIdentifier
Get pharmacy setting by identifier
POST
/api/v1/pharmacy/features
Retrieve Pharmacy features
POST
/api/v1/pharmacy/SearchPatients
Search patient free text
POST
/api/v1/pharmacy/getpharmacyinfos
POST
/api/v1/pharmacy/RegisterAccountV4
Registers account (instant activate).
POST
/api/v1/pharmacy/UpdateActionStatus
Update Action Status
POST
/api/v1/pharmacy/UpdateCachePatient
POST
/api/v1/pharmacy/VerifyPharmacyInfo
POST
/api/v1/pharmacy/SearchPatientAdvance
Search patient advance
POST
/api/v1/pharmacy/SendBroadcastMessage
Requests that a message be broadcasted to a set of recipients by App Message, SMS, etc.
POST
/api/v1/pharmacy/AcceptTermsConditions
Accept terms conditions
POST
/api/v1/pharmacy/GenerateActivationCodeV3
Generate Activation Code V3.
POST
/api/v1/pharmacy/UpdateSMSReminderComplete
Updates SMS Reminder Completed patients.
POST
/api/v1/pharmacy/GeneratePharmacyChangeRequest
POST
/api/v1/pharmacy/SendEScriptTokenToMedViewFlow
Send EScript Token To MedView Flow
RefillOrder 15
GET
/api/v1/RefillOrder/PendingOrder/{orderId}
Get full pending order with line items and resolved statuses (Epic 2 — Story 2.1). Returns HTTP 404 when the order does not exist or does not belong to this pharmacy.
DELETE
/api/v1/RefillOrder/PendingOrder/{orderId}
Delete a pending order (Epic 2 — Story 2.5a, FR29). Returns 404 when the order does not exist or does not belong to this pharmacy.
GET
/api/v1/RefillOrder/CompletedOrder/{orderId}
Get a completed order with read-only details and PIA payment status (Epic 6 — Story 6.1). Returns HTTP 404 when the order does not exist or does not belong to this pharmacy.
GET
/api/v1/RefillOrder/EScriptToken/{orderId}/{tokenId}
Get full eScript token detail for a line item (Epic 3 — Story 3.2, FR15). Returns 404 when the order does not belong to this pharmacy or the token is not found.
PUT
/api/v1/RefillOrder/Delivery/{orderId}
Update delivery address fields, shipping method, or delivery status (Story 4.1 — FR18–FR20). Returns 404 when the order does not exist, does not belong to this pharmacy, or is not a delivery order.
POST
/api/v1/RefillOrder/AddNote
Add or update a pharmacy note on an order (Epic 5 — Story 5.1, FR24). Returns 404 when the order does not belong to this pharmacy.
POST
/api/v1/RefillOrder/Complete
Finalise (complete) a pending order (Story 2.5b — FR27). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 when the order has no line items to tally.
POST
/api/v1/RefillOrder/ProcessPIA
Process a Pay-in-Advance charge (Epic 4 — Story 4.3).
POST
/api/v1/RefillOrder/SendEScript
Send an eScript token to the dispensing system (Epic 3 — Story 3.3, FR16). Always returns HTTP 200; the response body Code field indicates SUCCESS, FALLBACKTOPLUSONE (Angular must call PlusOne JS bri…
POST
/api/v1/RefillOrder/LineItem/{orderId}
Add a custom line item to a pending order (Story 3.5 — FR13). Returns the full updated order so the caller can refresh its list in one round-trip. Returns 400 when the name is missing; 404 when the o…
POST
/api/v1/RefillOrder/UpdateLineItemStatus
Update the status of a line item (Epic 3 — Story 3.1, FR6–FR9). Returns 404 when the order or component does not belong to this pharmacy. Returns 400 when action = OnOrder but followUpDate is absent.
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/Refund
Refund the PIA charge for a completed order (Epic 6 — Story 6.4, CRO-5). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 with an error message when the refu…
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/Reminder
Send a reminder message to a patient for a completed order (Epic 6 — Story 6.2, CRO-2). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 when the message bod…
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/ReturnToStock
Return all items for a completed order to stock (Epic 6 — Story 6.3, CRO-3). Returns 404 when the order does not exist or does not belong to this pharmacy.
DELETE
/api/v1/RefillOrder/LineItem/{orderId}/{lineItemId}
Delete a custom line item from a pending order (Story 3.5 — FR14). Returns 404 when the order, item, or pharmacy context is not found, or the item is not a custom item (only custom items may be delet…
Schemas 120
The contract defines 120 schemas that model the data the API accepts and returns. The most detailed are MedAdvisor.Framework.Interface.Store (108 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventBookingModel (78 properties), MedAdvisor.Framework.Interface.EventBookingWrapper (72 properties), MedAdvisor.Framework.Interface.UserSearch (61 properties). Each schema is shown below with its type and property counts.
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AuthLoginPharmacy
object
Login model for pharmacy access.
4 properties
MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.HSH.Core.Structure.IdResult, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]
object
4 properties
MedAdvisor.HSH.Core.Structure.NoResult
object
MedAdvisor.HSH.Core.Structure.IdResult
object
1 property
MedAdvisor.PharmacyUnifiedAPI.v1.Models.ResetPasswordRequest
object
1 property
MedAdvisor.Framework.Interface.DateTimeResult
object
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventServiceModel
object
8 properties
MedAdvisor.Framework.Interface.EventResourceResult
object
11 properties
MedAdvisor.Framework.Interface.EventResourceWrapper
object
11 properties
MedAdvisor.Framework.Interface.Store
object
108 properties
MedAdvisor.Framework.Interface.EventRecurrence
object
15 properties
MedAdvisor.Framework.Interface.EventBookingWrapper
object
72 properties
MedAdvisor.Framework.Interface.BookingAvailability
object
32 properties
MedAdvisor.Framework.Finance.PharmacyTier
object
5 properties
MedAdvisor.Framework.Interface.OperatingHour
object
5 properties
MedAdvisor.Framework.Interface.Location
object
19 properties
MedAdvisor.Framework.Interface.HealthNotesPharmacyDetail
object
13 properties
MedAdvisor.Framework.Interface.Owner
object
16 properties
MedAdvisor.Framework.Interface.ModuleActivation
object
59 properties
MedAdvisor.Framework.Interface.ElectronicPrescribingSettings
object
2 properties
MedAdvisor.Framework.Interface.PharmacyExternalSystem
object
8 properties
MedAdvisor.Framework.Interface.PharmacyLoyaltyProvider
object
3 properties
MedAdvisor.Framework.Interface.Subscription
object
9 properties
MedAdvisor.Framework.Interface.GPPractice
object
31 properties
MedAdvisor.Framework.Interface.GPPractitioner
object
26 properties
MedAdvisor.Framework.Interface.BookingAvailabilityResult
object
8 properties
MedAdvisor.Framework.Interface.BookingTokenKey
object
5 properties
MedAdvisor.Framework.Interface.EventBookingResult
object
9 properties
MedAdvisor.Framework.Interface.EventAvailability
object
4 properties
MedAdvisor.Framework.Interface.CalendarAccessTokenResult
object
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.CalenderTokenModel
object
17 properties
MedAdvisor.Framework.Interface.WhiteLabelSettings
object
25 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.UserSearchModel
object
22 properties
MedAdvisor.Framework.Interface.UserSearchResult
object
4 properties
MedAdvisor.Framework.Interface.UserSearch
object
61 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HistoricBookingModel
object
4 properties
MedAdvisor.Framework.Interface.Results.BookingStatusResult
object
4 properties
MedAdvisor.Framework.Interface.BookingStatus
object
12 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventBookingModel
object
78 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SuggestedSearchModel
object
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventResourceModel
object
12 properties
MedAdvisor.BLL.Recurrence.RecurrencePattern
object
17 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EventPreferenceModel
object
6 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.BookingRequestModel
object
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PrescreenFormModel
object
22 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.BookingValidateModel
object
15 properties
MedAdvisor.Framework.Interface.PatientGroupRequest
object
3 properties
MedAdvisor.Framework.Interface.PatientGroupMemberRequest
object
3 properties
MedAdvisor.Framework.Interface.DemoRuleSetResult
object
3 properties
MedAdvisor.Framework.Interface.DemoRuleSet
object
11 properties
MedAdvisor.Framework.Interface.InstructionAbstractionResult
object
3 properties
MedAdvisor.Framework.Interface.InstructionAbstraction
object
11 properties
MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.HSH.Core.Structure.Patient.PdsEScriptModel, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]
object
4 properties
MedAdvisor.HSH.Core.Structure.Patient.PdsEScriptModel
object
3 properties
MedAdvisor.HSH.Core.Structure.Patient.eScriptModel
object
eScript Model
23 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoCreateServiceRequest
object
Payload to create a head-office custom service (RAP-38 Story 2.5). The created capability is owned by the caller's report group (OwnerReportGroupID) and has NO…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdateServiceRequest
object
Payload to edit an existing HO-owned service (RAP-38 Story 2.5). Same fields as create. The edit updates the single shared PharmacyCapability, so it applies to…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdatePushDeadlineRequest
object
Extends or shortens the auto-activation deadline on an already-pushed, still-pending service (RAP-38 Story 3a.5, AC1a). Date-only. A past date is allowed — the…
1 property
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoPushServiceRequest
object
Push an HO service to pharmacies in the group (RAP-38 Story 2.7). Targets are always resolved within the caller's group. Scope is "all", "states", or "pharmaci…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxMessageModel
object
Inbox tab model
31 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxFilterModel
object
Model for filtering inbox's data
6 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxSentMessageModel
object
Inbox sent tab
34 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddScriptRequestModel
object
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxCompletedMessageModel
object
Inbox completed tab
33 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxQueuedMessageModel
object
Inbox queue tab
34 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxMessagesRequestModel
object
1 property
MedAdvisor.PharmacyUnifiedAPI.v1.Models.MessageRequest
object
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.InboxResultModel
object
3 properties
MedAdvisor.HSH.Core.Structure.Logging.LogEntryModel
object
5 properties
MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.HSH.Core.Structure.NoResult, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]
object
4 properties
MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacyCombineServiceDeliveryModel, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]
object
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacyCombineServiceDeliveryModel
object
17 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddressCombinePublicModel
object
12 properties
MedAdvisor.HSH.Core.Structure.Skin.SkinModel
object
5 properties
MedAdvisor.HSH.Core.Structure.PharmacyGroup.PharmacyGroupModel
object
A grouping of pharmacies and patient for different purposes including by data source, or banner group. A pharmacy and/or patient maybe in multiple different gr…
21 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacyCombineCapabilityModel
object
3 properties
MedAdvisor.HSH.Core.Structure.Pharmacy.DeliverySettingModel
object
10 properties
MedAdvisor.Framework.Interface.PharmacySettingsResult
object
7 properties
MedAdvisor.Framework.Interface.PharmacyServiceCapability
object
8 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacySettingsModel
object
2 properties
MedAdvisor.Framework.Interface.OperationResult
object
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.FileUploadModel
object
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.NotifyPharmacyModel
object
Need to provie an orderId, an order description and recall URL is valid.
3 properties
MedAdvisor.HSH.Core.Structure.OperationResult`1[[MedAdvisor.PharmacyUnifiedAPI.v1.Models.NotifyPharmacyModel, MedAdvisor.PharmacyUnifiedAPI, Version=5.85.0.0, Culture=neutral, PublicKeyToken=null]]
object
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacyGuidModel
object
2 properties
MedAdvisor.Framework.Interface.PatientSearchFreeTextRequest
object
9 properties
MedAdvisor.Framework.Interface.PatientSearchField
object
6 properties
MedAdvisor.Framework.Interface.PatientSearchResult
object
4 properties
MedAdvisor.Framework.Interface.PatientSearch
object
28 properties
MedAdvisor.Framework.Interface.InstantActivateRequest
object
15 properties
MedAdvisor.Framework.Interface.RequestContext
object
8 properties
MedAdvisor.Framework.Interface.IncentivisedSignUpPatientDisclosure
object
2 properties
MedAdvisor.Framework.Interface.InstantActivateResult
object
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.ActionUpdateModel
object
5 properties
MedAdvisor.Framework.Interface.UpdateCachePatientRequest
object
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PharmacyIdentifierModel
object
2 properties
MedAdvisor.Framework.Interface.PatientSearchAdvanceRequestDto
object
13 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendBroadcastMessageRequestModel
object
3 properties
MedAdvisor.Framework.Interface.BroadcastMessageJob
object
10 properties
MedAdvisor.Framework.Interface.BroadcastMessageRecipient
object
14 properties
MedAdvisor.Framework.Interface.AcceptTermsConditionsRequest
object
2 properties
MedAdvisor.Framework.Interface.AccountActivationRequest
object
14 properties
MedAdvisor.Framework.Interface.ActivationKeyResult
object
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateSMSReminderCompleteModel
object
2 properties
MedAdvisor.Framework.Interface.UserRolloverResponse
object
3 properties
MedAdvisor.Framework.Interface.GeneratePharmacyChangeRequest
object
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderModel
object
Order payload returned by GET /api/v1/RefillOrder/PendingOrder/{orderId} and GET /api/v1/RefillOrder/CompletedOrder/{orderId}. Used by the Angular Pending Orde…
34 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.DeliveryAgentOptionModel
object
A shipping agent option shown in the delivery section dropdown (Story 4.1 — FR19).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderLineItemModel
object
A single line item within a pending order, with its status pre-resolved server-side. Used by the Angular Pending Order dialog (RAP-6 — Epic 2, Story 2.1).
26 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EScriptTokenSummaryModel
object
Summary of a single eScript token embedded in the pending order line item response (FR4). Provides enough information to display the token list without a separ…
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EScriptTokenDetailModel
object
Full eScript token detail returned by GET /RefillOrder/EScriptToken/{orderId}/{tokenId} (FR15). Maps from EScriptDto in MedAdvisor.Framework.Interface.
17 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateDeliveryRequest
object
Request body for PUT /RefillOrder/Delivery/{orderId} (Story 4.1 — FR18, FR19, FR20). All fields are optional — only non-null values are applied.
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddNoteRequest
object
Request body for POST /RefillOrder/AddNote (Epic 5 — Story 5.1, FR24).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.CompleteOrderRequest
object
Request body for POST /RefillOrder/Complete (RAP-6 — Story 2.5b FR27, Story 4.3 FR22).
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.LineItemPriceEntry
object
Per-component price entered by the pharmacist at PIA order completion.
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendEScriptRequest
object
Request body for POST /RefillOrder/SendEScript (RAP-6 — Story 3.3, FR16).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendEScriptResponse
object
Response from POST /RefillOrder/SendEScript (RAP-6 — Story 3.3, FR16). Always returned as HTTP 200 so Angular can distinguish the three outcomes without interc…
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddLineItemRequest
object
Request body for POST /RefillOrder/LineItem/{orderId} (RAP-6 — Story 3.5, FR13).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateLineItemStatusRequest
object
Request body for POST /RefillOrder/UpdateLineItemStatus (RAP-6 — Story 3.1). Carries the orderId + componentId so the service can verify component ownership be…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendReminderRequest
object
Request body for POST /api/v1/RefillOrder/CompletedOrder/{orderId}/Reminder (Epic 6 — Story 6.2).
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MedAdvisor 7
Other APIs MedAdvisor publishes across the network.
Pharmacy Unified API - 3rd-Party Integration
Pharmacy Unified API - Booking Service
Pharmacy Unified API - Refill Order
Pharmacy Unified API - Inbox
Pharmacy Unified API - Head Office
Pharmacy Unified API - Pharmacy
MedAdvisor Pharmacy Unified API v2.0
#Pharmacy#Patient Engagement#Messaging
Where this information came from
This is an independent, third-party profile of Pharmacy Unified API - Communication, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.