The BestMed v1 APIs are designed to support resident admission and management. They provide endpoints to create, update, and retrieve resident demographics, location and status.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"48126604","collectionId":"4e9c0393-c37f-4c88-b513-39b6a8e882b6","publishedId":"2sB3HjNgnY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"f8fafb","highlight":"FF6C37"},"publishDate":"2025-09-03T23:50:17.000Z"},"item":[{"name":"Version 1","item":[{"name":"Clinical Resident","item":[{"name":"New Resident","id":"19ab9c3a-69ea-4e88-9273-8dfc98e3bb5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":"{{baseurl}}/api/ClinicalResident","description":"Use this API to make a resident available for admission on-boarding from the BestDose Add New Resident Wizard. Please note, a successful request to this API does not automatically admit a resident.
\nFacilityId (Guid) (Required)Use this API to update an admitted and linked resident in BestMed. Please note, a resident can only be updated once they have been successfully on-boarded in BestDose by the facility.
\nclinicalId (string) (Required)FacilityId (Guid) (Required)
Admits or updates the resident under the specified Facility Id.
UpdateAction (string) Required
Specifies what the payload intends to update. This is an atomic operation therefore only one type of update can be performed within the same request. Accepted values:
Demographics - This covers all properties specified in the schema except Allergies. You can include all the properties or only the ones that you intend to update. Diagnosis can be enabled for certain Facilities as a configurable setting to allow updating via the API.
Location - Updates Section and RoomBedNumber
Status - Updates the resident status in BestMed. Refer to the schema for accpeted values.
\nPhoto - Updates the resident photo
\nThe Clinical Resident API's are primarily for resident admissions and post-admission updates from third-party clinical systems.
\nClinicalId (string) (Required, Max length 50)
Unique Resident Id from the clinical system.
Title (enum) (Optional)
Accepted values:
Mr
\nMrs
\nMs
\nMiss
\nMaster
\nFirstName (string) (Required, Max length 100)
The given name of the resident being admitted
LastName (string) (Required, Max length 100)
The family name of the resident being admitted
PreferredName (string) (Optional, Max length 50)
The preferred name of the resident being admitted
DoB (date) (Required)
Date of birth of the resident in YYYY-MM-DD format
Gender (enum) (Required)
Accepted values:
M (Male)
F (Female)
I (Indeterminate)
N (Not Stated)
SectionName (string) (Required)
A valid section/wing name that must match (case-senstive) an existing section in BestMed. The section must be created in BestMed prior to making the request.
RoomBedNumber (string) (Required, Max length 15)
The room and bed number of the resident. There is no restriction on the format of this property as long as it is within the maximum character length.
Status (enum) (Required)
The admission status of the resident in the clinical system should be mapped to a valid BestMed status. Accepted values:
Active
InHospital
SocialLeave
Discharged (for updates only)
Deceased (for updates only)
SocialLeaveStartDate (date) (Conditional)
Date when the resident went on social leave. This is required only when the Status is SocialLeave.
Required format: YYYY-MM-DD.
Must be on or after current date
\nIf a future date is provided, the Status will remain Active in BestMed until the specified date.
SocialLeaveReturnDate (date) (Conditional)
Date when the resident will return from social leave. This is required only when the Status is SocialLeave.
Required format: YYYY-MM-DD.
Must be after SocialLeaveStartDate
Address1 (string) (Optional, Max length 200)
The street address of the resident
Suburb (string) (Optional, Max length 50)
PostCode (string) (Optional)
State (enum) (Optional)
Valid AU State Abbreviation. Accepted values:
ACT
NSW
NT
QLD
SA
TAS
VIC
WA
ContactNumber (string) (Optional, Max length 10)
Email (string) (Optional, Max length 200)
MedicareNumber (string) (Optional, Max length 15)
Digits only
\nInclude IRN (Individual Reference Number) if available
\nMedicareExpDate (date) (Optional)
DD/MM/YYYYConcessionNumber (string) (Optional, Max length 15)
Concession card number of the resident. Alpha-numeric characters are accepted as long as it is within the maximum character length.
ConcessionValidTo (date) (Optional)
Expiry date of the concession card.
DD/MM/YYYYRepatNumber (string) (Optional, Max length 10)
DVA card number of the resident.
RepatColour (enum) (Optional)
Accepted values:
G (Gold)
O (Orange)
W (White)
SafetyNetNumber(sting) (Optional)
URNMRN (string) (Optoinal, Max length 20)
DiabeticNumber (string) (Optional, Max length 20)
Diagnosis (string) (Optional, Max length 1000)
Allergies (string) (Optional, Max length 500)
PrescriberCode (string) (Optional, Max length 40)
If a code is provided, it must be a valid prescriber code registered in BestMed and linked to the facility the resident is being admitted to.
PrescriberFirstName (string) (Optional, Max length 200)
PrescriberLastName (string) (Optional, Max length 200)
PrescriberPhone (string) (Optional, Max length 40)
SupplyPharmacyId (GUID) (Optional)
If provided, must be a valid Pharmacy Id in BestMed.
SupplyPharmacyName (string) (Optional)
If provided, must match (case-senstive) a pharmacy in BestMed. This property is ignored if SupplyPharmacyId is provided.
Returns the list of residents across all facilties accessible by the integration account.
\nLastUpdated (datetime) (Optional)
If provided, returns the residents admitted or updated since the specified date in UTC and standard JSON Date Format otherwise returns all residents. NOTE: It is highly advisable to retrieve residents based on a timestamp as retrieving all the residents may cause significant delays in the response time.
Includes (string) (Optional)
By default, the API only returns the Core Properties as part of the response. To include Extended Properties, a comma-seperated list needs to be provided. Accepted values (case sensitive):
clinicalresidentid
\npreferredname
\ndva
\nfacilityid
\nsection
\nroomnumber
\nstatus
\npharmacy
\nallergies
\ndiagnosis
\nconsiderations
\nprescriber
\nActions that trigger the LastUpdated date of a resident to change:
\n1. Demographic Information Changes
\nFirst Name, Last Name, Title, Gender, Date of Birth
\nPreferred Name, Diabetic Number, Pack Label
\nAddress fields (Address1, Suburb, PostCode, State)
\nContact/Identification numbers (Medicare, Repat, IHIN, URN/MRN)
\n2. Resident Status Changes
\nStatus transitions (Active → Discharged, etc.)
\nSocial Leave start/return dates
\nHospital admission/discharge status changes
\n3. Resident Allergies Updates
\nAny addition, modification, or deletion of resident allergies
\nUpdates to \"Nil Known\" allergy status
\nUpdates to \"Other Allergies\" text field
\n4. Resident Considerations Updates
\nChanges to clinical considerations
\nPack Schedule Upload settings
\nCrush Medication flags
\nAny other resident-specific care considerations
\n5. Resident Diagnosis Updates
\n6. Facility/Section/Room Changes
\nMoving resident to different facility
\nTransferring resident to different section
\nChanging room/bed assignment
\n7. Resident Photo Updates
\n8. Resident Details via Add/Move Wizard
\nMulti-step resident onboarding/transfer workflows
\nCommunity-to-community resident transfers
\nRetrieve medication schedules of a resident that were created in BESTpack in the last 3 days (facility local time). Replace {{residentId}} in the URL with the BestMed Resident ID.
Retreive the medication profile of a resident from BestPack. Replace {{residentId}} in the URL with the BestMed Resident ID.
Retrieve Psychotropic Assesment information of a residents from BESTpack. Replace {{residentId}} in the URL with the BestMed Resident ID.
EndFragment
\n","urlObject":{"path":["api","","PsychotropicAssessmentInfo"],"host":["{{baseurl}}"],"query":[{"description":{"content":"The resident ID in BESTMED to retrieve psychotropic assessment data for. Must be a valid GUID format.
\n","type":"text/plain"},"key":"Id","value":"{{residentId}}"}],"variable":[]}},"response":[{"id":"a7e8a3d2-b325-4920-8617-9a1372fae681","name":"Psychotropic Assessment Info","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/PsychotropicAssessmentInfo?Id=3ac3d1ce-86fc-49a7-9e5f-88da5f123358","host":["{{baseurl}}"],"path":["api","PsychotropicAssessmentInfo"],"query":[{"key":"Id","value":"3ac3d1ce-86fc-49a7-9e5f-88da5f123358"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"drugId\": \"ddf26b05-287f-4f6c-94da-7a318f005326\",\n \"useActiveIngredient\": false,\n \"amtCtppId\": 652081000168100,\n \"amtTppId\": 652071000168103,\n \"amtMppId\": 27398011000036104,\n \"startDate\": \"2025-01-14T00:00:00\",\n \"endDate\": null,\n \"direction\": \"Take TWO tablets at night\",\n \"drugBrandName\": \"QUETIA 25\",\n \"drugGenericName\": \"QUETIAPINE\",\n \"drugStrength\": \"25mg\",\n \"drugForm\": \"TAB\",\n \"scheduleType\": \"Regular\",\n \"indication\": \"Major depressive disorder\",\n \"chemicalRestraint\": false,\n \"hasConsent\": true,\n \"notConsentNote\": \"\",\n \"consentDate\": \"2025-03-26T00:00:00\",\n \"firstReviewDate\": null,\n \"nextReviewDate\": \"2026-05-25T08:18:29.087\",\n \"behaviourSupportPlanImplemented\": true\n },\n {\n \"drugId\": \"13491fc9-3ecd-4c3f-89a0-8ea38102d4b6\",\n \"useActiveIngredient\": false,\n \"amtCtppId\": 79010011000036104,\n \"amtTppId\": 78819011000036109,\n \"amtMppId\": 28071011000036107,\n \"startDate\": \"2025-01-14T00:00:00\",\n \"endDate\": null,\n \"direction\": \"Take ONE tablet at night\",\n \"drugBrandName\": \"LEXAM\",\n \"drugGenericName\": \"ESCITALOPRAM\",\n \"drugStrength\": \"10mg\",\n \"drugForm\": \"TAB\",\n \"scheduleType\": \"Regular\",\n \"indication\": \"Depression\",\n \"chemicalRestraint\": false,\n \"hasConsent\": true,\n \"notConsentNote\": \"\",\n \"consentDate\": \"2025-03-26T00:00:00\",\n \"firstReviewDate\": null,\n \"nextReviewDate\": \"2026-05-25T08:18:26.68\",\n \"behaviourSupportPlanImplemented\": false\n }\n]"}],"_postman_id":"b25f0157-7c64-43e7-bd72-fef3257ae6b9"},{"name":"Antimicrobial Medication","id":"c2265f6b-f30e-4ace-8bb9-ab473f4e1099","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":"{{baseurl}}/api/Patients/{{residentId}}/AntimicrobialMed","description":"RetrieveAntimicrobial Medication information of a residents from BESTpack. Replace {{residentId}} in the URL with the BestMed Resident ID.
EndFragment
\n","urlObject":{"path":["api","Patients","{{residentId}}","AntimicrobialMed"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"f6b69153-20fc-4477-b027-285d8e3e4232","name":"Antimicrobial Medication","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":"{{baseurl}}/api/Patients/{{residentId}}/AntimicrobialMed"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"drugId\": \"dcccf937-b958-4a0f-bc64-31b8b092c565\",\n \"useActiveIngredient\": false,\n \"amtCtppId\": null,\n \"amtTppId\": null,\n \"amtMppId\": null,\n \"startDate\": \"2025-01-31T00:00:00\",\n \"endDate\": null,\n \"direction\": \"PRN\",\n \"drugBrandName\": \"CHEMISTS OWN CLOZOLE EXTRA CREAM 30G\",\n \"drugGenericName\": \"HYDROCORTISONE + CLOTRIMAZOLE\",\n \"drugStrength\": \"1%/1%\",\n \"drugForm\": \"CRM\",\n \"scheduleType\": \"PRN\",\n \"indication\": \"RASH\",\n \"basedOnPathologyResult\": false,\n \"nextReviewDate\": null\n }\n]"}],"_postman_id":"c2265f6b-f30e-4ace-8bb9-ab473f4e1099"}],"id":"928c7f62-4719-4786-9639-d583e1d4246f","description":"The Resident object represents an admitted patient in the BestMed system. The API's below allow you to interact with a Resident using its unique Id.
\nBHSId (guid)
The Id of the resident in BestMed
FirstName (string)
Given name of the resident
LastName (string)
Family name of the resident
DoB (date)
Date of birth of the resident in YYYY-MM-DD format.
Gender (string)
MedicareNumber (string)
\nClinicalResidentId (string)
The unique identifier of the resident in the clinical management system
FacilityId (guid)
The BestMed facility Id of the resident
PreferredName (string)
Section (string)
The section of the resident in BestMed
RoomNumber (string)
The room and bed number of the resident
Status (string)
Resident status in BestMed
SocialLeaveStartDate (date)
SocialLeaveEndDate (date)
RepatNumber (string)
RepatColour (string)
Pharmacy (object)
Id (guid)
Unique Id of the pharmacy in BestMed
Name (string)
Name of the pharmacy in BestMed
MedicationAllergies (object, nullable)
Medication (string)
Name of the medication
AllergyDescription (string)
Details of the allergy
RecordDate (date)
The date the allergy was recorded in BestMed
Allergies (string)
All allergies recorder under \"Other Allergies\" in a resident's profile.
Diagnosis (string)
The diagnosis text in the resident's profile.
Considerations (object, nullable)
SwallowingDifficulties (bool)
Indicates if the resident has Swallowing Difficulties
CognativeImpairment (bool)
Indicates if the resident is suffering Cognitive Impairment
DexterityDifficulties (bool)
Indicates if the resident has Dexterity difficulties
ResistiveToMedicine (bool)
Indicates if the resident is resistive to medicine
NilByMouth (bool)
Indicates if the resident can’t take any medication by mouth
SelfAdministers (bool)
Indicates if the resident self-administer medications
CrushAllMedications (bool)
Indicates if all medications should be crushed
PhysicalDisability (bool)
Indicates if the resident suffers physical disability
LiteracyOrLanguageIssues (bool)
Indicates if the resident has literacy or language issues
ImmunoCompromised (bool)
Indicates if the resident is Immunocompromised
Other (string)
Free text consideration recorded by the nurses
Prescriber (object)
PrescriberNumber (string)
The unique code of the prescriber in BestMed
FirstName (string)
LastName (string)
Email (string)
Phone (string)
Fax (string)
Returns the list of pharmacies for the facilities associated with the integration user account.
\nFacilityId (Guid) (Required)Id (Guid)
Unique Id of the pharmacy in the BestMed system
Name (string)
Name of the pharmacy in BestMed
IsBestMedPharmacy (boolean)
//TODO
IsMainPharmacy (boolean)
//TODO
TotalResidents (integer)
Total residents serviced by the pharmacy regardless of the status of the resident
TotalActiveResidents (integer)
Total active residents serviced by the pharmacy
Returns the list of prescribers for the facilities associated with the integration user account.
\nCode (string) (Optional)Id (Guid)
FirstName (string)
LastName (string)
MobileNumber (string)
PrescriberCode (string)
LicenseNumber (string)
Type (enum)
Doctor
Dietician
Retrieve the progress notes across all facilties
\n","urlObject":{"path":["api","ProgressNotes"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"cf1622c5-27b5-472d-a858-86ce98ccc4fd","name":"StartDate filter","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"},{"key":"api-version","value":"{{ApiVersion}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/ProgressNotes?StartDate=2021-01-01T00:15:22","host":["{{baseurl}}"],"path":["api","ProgressNotes"],"query":[{"key":"StartDate","value":"2021-01-01T00:15:22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"residentId\": \"d4c1b5ee-d8e9-4db8-a7bf-f3cec8c5120e\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"e0955106-a142-4b39-8507-7f7381227341\",\r\n \"progressNotesDate\": \"2021-01-01T00:15:22.813\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: CLOMIPRAMINE 25mg TAB (CLOMIPRAMINE (GENRX)), DoseRound: 31-12-2020 2156\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n {\r\n \"residentId\": \"345f92e7-2465-49dc-bb86-0cddbf97993c\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"d7179338-ae39-429e-9c85-ba15bd8dccf4\",\r\n \"progressNotesDate\": \"2021-01-01T00:15:22.893\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: TEMAZEPAM 10mg TAB (TEMAZE ), DoseRound: 31-12-2020 2200\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n]"}],"_postman_id":"70612019-814a-4eee-a33a-69bf20d7649f"},{"name":"Search Progress Notes By Resident","id":"eb770c74-44fe-45b9-ac9f-cb8a5f239cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"},{"key":"api-version","value":"{{ApiVersion}}","type":"text"}],"url":"{{baseurl}}/api/ProgressNotes/{{residentId}}","description":"Retrive progress notes for a specific resident
\n","urlObject":{"path":["api","ProgressNotes","{{residentId}}"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"6c1c8ef2-9b76-42c0-b0be-3be4f8458bde","name":"StartDate filter","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"},{"key":"api-version","value":"{{ApiVersion}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/ProgressNotes/85091baa-068a-4a1d-b4c0-9d47f144b361?StartDate=2021-01-01T00:15:22","host":["{{baseurl}}"],"path":["api","ProgressNotes","85091baa-068a-4a1d-b4c0-9d47f144b361"],"query":[{"key":"StartDate","value":"2021-01-01T00:15:22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"972625a2-32c0-4fc4-91f2-f2c0df3b220d\",\r\n \"progressNotesDate\": \"2021-01-01T00:15:22.953\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: TEMAZEPAM 10mg TAB (TEMAZEPAM (APO)), DoseRound: 31-12-2020 2200\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n {\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"a4c91add-de5a-4819-9c16-d72fbce569c0\",\r\n \"progressNotesDate\": \"2021-01-01T09:15:19.063\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: HYDROXYCARBAMIDE 500mg CAP (HYDREA ), INS ASPART/INS ASPART PROT SUS 100 units/mL, 3mL 5 INJ (NOVOMIX 30 PENFILL), MACROGOL 3350+NACL+KCL+HCO3 13.125g, 30 SACH (MOVICOL), METFORMIN HCL 500mg TAB (METFORMIN (APO)), FUROSEMIDE 20mg TAB (FRUSEMIDE (APO)), OXYCODONE 20mg CR-TAB (OXYCONTIN ORIG-FORM), ATORVASTATIN 20mg TAB (ATORVASTATIN (APO)), PARACETAMOL 500mg, 100 TAB (PARACETAMOL (APO)), DoseRound: 01-01-2021 0800\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n {\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"928f2f7d-cd99-418c-b76e-0742d6d38931\",\r\n \"progressNotesDate\": \"2021-01-01T09:45:14.9\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: LEVOTHYROXINE SODIUM 50mcg TAB (EUTROXSIG), METOCLOPRAMIDE HCL 10mg TAB (PRAMIN 25 25), DoseRound: 01-01-2021 0730\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n {\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"666464d4-80b4-4915-b240-9988025b0bd8\",\r\n \"progressNotesDate\": \"2021-01-01T13:15:24.467\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: INS ASPART/INS ASPART PROT SUS 100 units/mL, 3mL 5 INJ (NOVOMIX 30 PENFILL), FUROSEMIDE 20mg TAB (FRUSEMIDE (APO)), PARACETAMOL 500mg, 100 TAB (PARACETAMOL (APO)), DoseRound: 01-01-2021 1200\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n },\r\n {\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"clinicalResidentId\": null,\r\n \"progressNoteId\": \"6321d6dd-1670-4ec4-a1de-2a826150b5c5\",\r\n \"progressNotesDate\": \"2021-01-01T13:45:19.407\",\r\n \"progressNotesText\": \"Missed Administration - Missed Med: METOCLOPRAMIDE HCL 10mg TAB (PRAMIN 25 25), DoseRound: 01-01-2021 1130\",\r\n \"progressNotesType\": \"Missed Administration - Missed Med\",\r\n \"progressNotesRecordBy\": \"System\"\r\n }\r\n]"}],"_postman_id":"eb770c74-44fe-45b9-ac9f-cb8a5f239cfa"}],"id":"b46e74cd-b1cc-4583-8e69-55a4b2cc40e9","description":"Returns a list of progress notes recorded against the residents that are associated with the facilit(ies) of the API account. The results can be filtered using various parameters including narrowing down to a specific resident as detailed below.
\nStartDate (DateTime)
Use StartDate if all facilties are in the same time zone which means the date time provided would be considered as local time. Values can be any RFC3339 complaint format without the timezone offset.
StartDateUtc _(DateTime)
_If your facilities are spread across multiple timezones, it is recommended to use the StartDateUtc parameter instead of StartDate parameter. Values should be RFC3339 complaint UTC format.
EndDate (DateTime) (Optional)
Use EndDate if all facilties are in the same time zone which means the date time provided would be considered as local time. Values can be any RFC3339 complaint format without the timezone offset. Defaults to 1 month from StartDate.
EndDateUtc _(DateTime) (Optional)
_If your facilities are spread across multiple timezones, it is recommended to use the EndDateUtc parameter instead of EndDate parameter. Values should be RFC3339 complaint UTC format. Defaults to 1 month from StartDateUtc.
FacilityId (GUID) (Optional)
A valid BestMed Facility ID. Defaults to all facilities accessible by the API account if no value is provided.
ResidentId (GUID)
Unique identifier of the Resident in BestMed
ProgressNoteId (GUID)
Unique identifier of the progress note in BestMed
ProgressNotesDate (DateTime)
Date and time the progress note was recorded in either facility local time or UTC depending on with start date parameter was used.
ProgressNotesText (String)
Details of the recorded progress note
ProgressNotesType (String)
Unique type code of the progress note in BestMed. Refer to the types section for details.
ProgressNotesRecordedBy (String)
Name and job title of the facility staff who recorded the progress note.
Retrieve Observations across all facilities
\n","urlObject":{"path":["api","Observations",""],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"e08b1860-aec1-4d9a-ad08-fa2f28a4afbf","name":"From Filter","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/Observations?From=2021-01-01T00:00","host":["{{baseurl}}"],"path":["api","Observations"],"query":[{"key":"From","value":"2021-01-01T00:00"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"clinicalResidentId\": null,\r\n \"obsId\": \"505a473e-69a8-4144-a3a6-f1c95019ee84\",\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"obsDate\": \"2021-08-18T20:13:09\",\r\n \"obsType\": \"Weight\",\r\n \"obsValue1\": 3,\r\n \"obsValue2\": null,\r\n \"obsText\": null,\r\n \"obsRecordedBy\": \"Integration, FRANECKI MANAGEMENT, DemoAPI\"\r\n },\r\n {\r\n \"clinicalResidentId\": null,\r\n \"obsId\": \"0be595b1-b793-4e5c-bbfc-f2195cfa5f0e\",\r\n \"residentId\": \"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"obsDate\": \"2021-08-18T20:13:17\",\r\n \"obsType\": \"Temperature\",\r\n \"obsValue1\": 37,\r\n \"obsValue2\": null,\r\n \"obsText\": null,\r\n \"obsRecordedBy\": \"Integration, FRANECKI MANAGEMENT, DemoAPI\"\r\n }\r\n]"},{"id":"72402999-3a2d-464e-a534-547fd86524e9","name":"FromUtc Filter","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/Observations?FromUtc=2025-11-10T03:06","host":["{{baseurl}}"],"path":["api","Observations"],"query":[{"key":"FromUtc","value":"2025-11-10T03:06"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"49962836-23ff-4d1d-9613-6f9e8848ab42\",\r\n \"residentId\":\"63962f14-a4d1-46d7-a6c8-4c6aefc7641a\",\r\n \"obsDate\":\"2025-11-10T03:06:21.207\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":12.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Offline App Manager, STEVE MAI, smo\"\r\n },\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"a352b24e-a887-4509-b2b5-34a94d59014f\",\r\n \"residentId\":\"63962f14-a4d1-46d7-a6c8-4c6aefc7641a\",\r\n \"obsDate\":\"2025-11-10T03:21:14.063\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":32.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Offline App Manager, STEVE MAI, smo\"\r\n },\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"7f4d60f5-782d-4205-b3a1-d7d82a4e2add\",\r\n \"residentId\":\"df0ef471-e058-4ea5-8e9f-30a05f62c772\",\r\n \"obsDate\":\"2025-11-10T06:51:49.253\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":2.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"MANAGER123, KIRRILY GREEN, trieu.manager\"\r\n }\r\n]"},{"id":"4aa8502a-68b4-4515-bf8d-a1cb60b0106f","name":"FacilityId Filter","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/Observations?facilityId=6B2C6590-385C-4338-84DB-48D7229EEC66&fromUtc=2025-11-10T03:06","host":["{{baseurl}}"],"path":["api","Observations"],"query":[{"key":"facilityId","value":"6B2C6590-385C-4338-84DB-48D7229EEC66"},{"key":"fromUtc","value":"2025-11-10T03:06"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"49962836-23ff-4d1d-9613-6f9e8848ab42\",\r\n \"residentId\":\"63962f14-a4d1-46d7-a6c8-4c6aefc7641a\",\r\n \"obsDate\":\"2025-11-10T03:06:21.207\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":12.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Offline App Manager, STEVE MAI, smo\"\r\n },\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"a352b24e-a887-4509-b2b5-34a94d59014f\",\r\n \"residentId\":\"63962f14-a4d1-46d7-a6c8-4c6aefc7641a\",\r\n \"obsDate\":\"2025-11-10T03:21:14.063\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":32.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Offline App Manager, STEVE MAI, smo\"\r\n },\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"7f4d60f5-782d-4205-b3a1-d7d82a4e2add\",\r\n \"residentId\":\"df0ef471-e058-4ea5-8e9f-30a05f62c772\",\r\n \"obsDate\":\"2025-11-10T06:51:49.253\",\r\n \"obsType\":\"BGL\",\r\n \"obsValue1\":2.0,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"MANAGER123, KIRRILY GREEN, trieu.manager\"\r\n }\r\n]"}],"_postman_id":"7d3f972d-1d66-4dd8-92e1-7138ad2628d8"},{"name":"Search Observations By Resident","id":"8e2f2c7d-9932-4c8f-ba33-4a1ca1131595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":"{{baseurl}}/api/Observations/","description":"Retrieve Observations for a specific resident
\n","urlObject":{"path":["api","Observations",""],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"65c1ef06-d98c-4b0f-bc3e-ebb86eaf0d7f","name":"Get By Resident ID","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"},{"key":"Username","value":"{{Username}}","type":"text"},{"key":"Password","value":"{{Password}}","type":"text"}],"url":"{{baseurl}}/api/Observations/85091BAA-068A-4A1D-B4C0-9D47F144B361"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"505a473e-69a8-4144-a3a6-f1c95019ee84\",\r\n \"residentId\":\"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"obsDate\":\"2021-08-18T20:13:09\",\r\n \"obsType\":\"Weight\",\r\n \"obsValue1\":3,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Integration, FRANECKI MANAGEMENT, DemoAPI\"\r\n },\r\n {\r\n \"clinicalResidentId\":null,\r\n \"obsId\":\"0be595b1-b793-4e5c-bbfc-f2195cfa5f0e\",\r\n \"residentId\":\"85091baa-068a-4a1d-b4c0-9d47f144b361\",\r\n \"obsDate\":\"2021-08-18T20:13:17\",\r\n \"obsType\":\"Temperature\",\r\n \"obsValue1\":37,\r\n \"obsValue2\":null,\r\n \"obsText\":null,\r\n \"obsRecordedBy\":\"Integration, FRANECKI MANAGEMENT, DemoAPI\"\r\n }\r\n]"}],"_postman_id":"8e2f2c7d-9932-4c8f-ba33-4a1ca1131595"}],"id":"f273e3ea-96ff-4ce7-9e58-48e8d64295a3","description":"Returns a list of observations recorded against the residents that are associated with the facilit(ies) of the API account. The results can be filtered using various parameters including narrowing down to a specific resident as detailed below.
\nFrom (DateTime)
Use From if all facilties are in the same time zone which means the date time provided would be considered as local time. Values can be any RFC3339 complaint format without the timezone offset.
FromUtc (DateTime)
If your facilities are spread across multiple timezones, it is recommended to use the FromUtc parameter instead of FromDate parameter. Values should be RFC3339 complaint UTC format.
FacilityId (GUID) (Optional)
A valid BestMed Facility ID. Defaults to all facilities accessible by the API account if no value is provided.
All v1 API's require the following parameters passed to the header with every request.
\n","_postman_id":"ec82d360-a17e-4286-a224-a3c9ad73f883"},{"name":"Version 2","item":[{"name":"Authentication","item":[{"name":"MS Get Token","event":[{"listen":"test","script":{"exec":["var accessToken = pm.response.json().access_token;\r","\r","pm.environment.set('access_token', accessToken);"],"type":"text/javascript","packages":{},"id":"088a9526-cbd5-48c4-983d-4c2016c66d79"}}],"id":"75be84d1-98dd-4d6c-9b31-a10fccc28657","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"scope","value":"{{scope}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://login.microsoftonline.com/31a83458-651e-4e24-abf6-e9ff02ca4a6e/oauth2/v2.0/token","urlObject":{"protocol":"https","path":["31a83458-651e-4e24-abf6-e9ff02ca4a6e","oauth2","v2.0","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75be84d1-98dd-4d6c-9b31-a10fccc28657"}],"id":"5c089cfb-9586-4e9e-bbed-22d5e8b38ba0","description":"Authorization: Bearer token
\nToken Source: Microsoft Entra ID token endpoint
\nThe user must have P-Integration role.
\nRetrieves a list of facilities available to the API account.
\nNotes:
\nNo query parameters or request body are required.
\nIf a facility is missing please contact support@bestmed.com.au.
\nRetrieves a list of users from the BESTMED User Management system.
\nIf no query parameters are provided, the endpoint returns all accessible users.
\n","urlObject":{"path":["api","UserManagement","Users"],"host":["{{baseurl}}"],"query":[{"disabled":true,"description":{"content":"BestMed Facility ID
\n","type":"text/plain"},"key":"facilityId","value":""},{"disabled":true,"description":{"content":"BestMed Username
\n","type":"text/plain"},"key":"userName","value":""}],"variable":[]}},"response":[{"id":"9e6981c4-b017-48df-a507-a528612bd1c4","name":"All Users","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}"}],"url":{"raw":"{{baseurl}}/api/UserManagement/Users","host":["{{baseurl}}"],"path":["api","UserManagement","Users"],"query":[{"key":"facilityId","value":"","description":"BestMed Facility ID","disabled":true},{"key":"userName","value":"","description":"BestMed Username","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"IsSuccess\":true,\r\n \"ErrorMessages\":[\r\n \r\n ],\r\n \"StatusCode\":200,\r\n \"Data\":[\r\n {\r\n \"Id\":\"afea96e8-1b51-4a95-8893-0024048ec0e5\",\r\n \"UserName\":\"Mylestolentino\",\r\n \"Salutation\":\"Mr.\",\r\n \"FirstName\":\"Caterina\",\r\n \"LastName\":\"AIN\",\r\n \"Email\":\"donotsend@koaloamail.com\",\r\n \"JobTitle\":\"Care Staff\",\r\n \"ContactNumber\":\"04 5100 7414\",\r\n \"UserRole\":\"aa531ae6-e070-444b-80fa-882913f75d0b\",\r\n \"Status\":\"InActive\",\r\n \"LastLogin\":\"2017-12-06T03:00:20\",\r\n \"Facilities\":[\r\n \"7891d94f-be8e-4940-bca6-16d25ab2a063\"\r\n ],\r\n \"Features\":[\r\n \"ae4d2695-4fc4-4b73-bb76-6b3693803e88\"\r\n ],\r\n \"Reports\":[\r\n \r\n ],\r\n \"Permissions\":{\r\n \"AddNewPrescriber\":false,\r\n \"AssignResidentAccessToPrescriber\":true,\r\n \"AddUser\":false,\r\n \"EditUser\":false,\r\n \"IsReadOnly\":false,\r\n \"AllowPrescriberConfirmation\":false\r\n },\r\n \"IsExternalLogin\":false,\r\n \"ExternalUserId\":null,\r\n \"LockToIP\":true,\r\n \"AHPRANumber\":null,\r\n \"SignOutRule\":null\r\n },\r\n {\r\n \"Id\":\"9e72c793-6428-49f6-98ee-01c6e0ffe430\",\r\n \"UserName\":\"Ka_fapi510\",\r\n \"Salutation\":\"Mr.\",\r\n \"FirstName\":\"FN Admin\",\r\n \"LastName\":\"LN ADMIN\",\r\n \"Email\":\"Ka_fapi510@gmail.com\",\r\n \"JobTitle\":\"RN\",\r\n \"ContactNumber\":\"04 1111 1111\",\r\n \"UserRole\":\"b2026815-0d5f-438e-8963-097d88cf9b94\",\r\n \"Status\":\"Active\",\r\n \"LastLogin\":null,\r\n \"Facilities\":[\r\n \"c6341a81-a53e-48ef-96dd-3b83545ea9fc\",\r\n \"5bed2073-ee32-4c77-afc0-5e5f346efbfa\",\r\n \"e4a1d085-6252-42c4-8c15-989e15439b6a\",\r\n \"b2a8f3d1-d6bf-4bf7-9be1-a69c47e454de\",\r\n \"a64965ab-145f-44ec-8a03-b80e7046ce4d\",\r\n \"2f4680aa-8ad9-48e3-a0a1-f6b0f74f1179\"\r\n ],\r\n \"Features\":[\r\n \r\n ],\r\n \"Reports\":[\r\n \r\n ],\r\n \"Permissions\":{\r\n \"AddNewPrescriber\":true,\r\n \"AssignResidentAccessToPrescriber\":true,\r\n \"AddUser\":false,\r\n \"EditUser\":false,\r\n \"IsReadOnly\":false,\r\n \"AllowPrescriberConfirmation\":false\r\n },\r\n \"IsExternalLogin\":false,\r\n \"ExternalUserId\":null,\r\n \"LockToIP\":true,\r\n \"AHPRANumber\":null,\r\n \"SignOutRule\":1\r\n },\r\n {\r\n \"Id\":\"3a3a09fd-69e7-4995-a908-01e7d48fb7e7\",\r\n \"UserName\":\"RSunga\",\r\n \"Salutation\":\"Miss.\",\r\n \"FirstName\":\"Giang\",\r\n \"LastName\":\"AIN\",\r\n \"Email\":\"donotsend@koaloamail.com\",\r\n \"JobTitle\":\"PCA\",\r\n \"ContactNumber\":\"04 1448 1152\",\r\n \"UserRole\":\"aa531ae6-e070-444b-80fa-882913f75d0b\",\r\n \"Status\":\"InActive\",\r\n \"LastLogin\":\"2020-02-14T19:16:38\",\r\n \"Facilities\":[\r\n \"7891d94f-be8e-4940-bca6-16d25ab2a063\"\r\n ],\r\n \"Features\":[\r\n \"f3777afb-1872-4730-85c6-bae6de21bcaa\",\r\n \"8735d9b9-d368-451f-acde-a7e85993de9a\",\r\n \"8a69f190-2934-40d4-b136-cabd9f808580\",\r\n \"27861584-3848-4da9-935e-cda30ec60a85\",\r\n \"5eb432e6-fff5-4215-ade6-3a3a424d9c8f\",\r\n \"6fb09446-cb2b-434a-8161-ad3fb2be089d\",\r\n \"eeb29df2-882d-4ce3-9740-96397a0a8204\",\r\n \"04f22397-3891-480a-acd9-655b1b17049d\",\r\n \"96919d02-b0ff-4a59-a0db-adff60cc98c5\",\r\n \"d63b7c0a-d32d-4a10-ba96-10436cfd108c\",\r\n \"ae4d2695-4fc4-4b73-bb76-6b3693803e88\"\r\n ],\r\n \"Reports\":[\r\n \"01f3fe89-a7bc-481f-b113-219250720c01\"\r\n ],\r\n \"Permissions\":{\r\n \"AddNewPrescriber\":false,\r\n \"AssignResidentAccessToPrescriber\":true,\r\n \"AddUser\":false,\r\n \"EditUser\":false,\r\n \"IsReadOnly\":false,\r\n \"AllowPrescriberConfirmation\":false\r\n },\r\n \"IsExternalLogin\":false,\r\n \"ExternalUserId\":null,\r\n \"LockToIP\":true,\r\n \"AHPRANumber\":null,\r\n \"SignOutRule\":null\r\n }\r\n ]\r\n}"},{"id":"b72d4502-9e4f-4a0a-b230-60caf0d05234","name":"Search By Facility","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}"}],"url":{"raw":"{{baseurl}}/api/UserManagement/Users?facilityId=7891d94f-be8e-4940-bca6-16d25ab2a063","host":["{{baseurl}}"],"path":["api","UserManagement","Users"],"query":[{"key":"facilityId","value":"7891d94f-be8e-4940-bca6-16d25ab2a063","description":"BestMed Facility ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"IsSuccess\": true,\r\n \"ErrorMessages\": [],\r\n \"StatusCode\": 200,\r\n \"Data\": [\r\n {\r\n \"Id\": \"7d909d49-26c6-4297-b72c-2511a503ed95\",\r\n \"UserName\": \"Ka_fapi54\",\r\n \"Salutation\": \"Mr.\",\r\n \"FirstName\": \"CreatedByAPIFN\",\r\n \"LastName\": \"F-ADMIN\",\r\n \"Email\": \"Ka_fapi54@gmail.com\",\r\n \"JobTitle\": \"Admin\",\r\n \"ContactNumber\": \"04 1111 1111\",\r\n \"UserRole\": \"b2026815-0d5f-438e-8963-097d88cf9b94\",\r\n \"Status\": \"Active\",\r\n \"LastLogin\": \"2026-05-14T08:10:28.627\",\r\n \"Facilities\": [\r\n \"7891d94f-be8e-4940-bca6-16d25ab2a063\",\r\n \"c6341a81-a53e-48ef-96dd-3b83545ea9fc\",\r\n \"5bed2073-ee32-4c77-afc0-5e5f346efbfa\",\r\n \"e4a1d085-6252-42c4-8c15-989e15439b6a\",\r\n \"b2a8f3d1-d6bf-4bf7-9be1-a69c47e454de\",\r\n \"a64965ab-145f-44ec-8a03-b80e7046ce4d\",\r\n \"2f4680aa-8ad9-48e3-a0a1-f6b0f74f1179\"\r\n ],\r\n \"Features\": [],\r\n \"Reports\": [],\r\n \"Permissions\": {\r\n \"AddNewPrescriber\": true,\r\n \"AssignResidentAccessToPrescriber\": true,\r\n \"AddUser\": false,\r\n \"EditUser\": false,\r\n \"IsReadOnly\": false,\r\n \"AllowPrescriberConfirmation\": false\r\n },\r\n \"IsExternalLogin\": false,\r\n \"ExternalUserId\": null,\r\n \"LockToIP\": true,\r\n \"AHPRANumber\": null,\r\n \"SignOutRule\": 1\r\n },\r\n {\r\n \"Id\": \"821963dd-78ee-484a-a5e8-fe2dba3011c7\",\r\n \"UserName\": \"kplatt\",\r\n \"Salutation\": null,\r\n \"FirstName\": \"Mara\",\r\n \"LastName\": \"ADMINISTRATION\",\r\n \"Email\": \"donotsend@koaloamail.com\",\r\n \"JobTitle\": \"Care Funding Business Partner\",\r\n \"ContactNumber\": \"02 9431 1020\",\r\n \"UserRole\": \"b2026815-0d5f-438e-8963-097d88cf9b94\",\r\n \"Status\": \"InActive\",\r\n \"LastLogin\": \"2022-08-17T06:09:01.043\",\r\n \"Facilities\": [\r\n \"02e44075-fc9d-45fc-a4a6-063623cb9e88\",\r\n \"41d0b216-9961-4532-b25b-15777c91f1ef\",\r\n \"7891d94f-be8e-4940-bca6-16d25ab2a063\",\r\n \"fae61aa0-c95e-492b-95a3-18da72830d54\"\r\n ],\r\n \"Features\": [\r\n \"d63b7c0a-d32d-4a10-ba96-10436cfd108c\",\r\n \"04f22397-3891-480a-acd9-655b1b17049d\",\r\n \"8a69f190-2934-40d4-b136-cabd9f808580\",\r\n \"7746ada4-1447-48a3-8cd3-1b38665af1c0\",\r\n \"f3777afb-1872-4730-85c6-bae6de21bcaa\",\r\n \"5eb432e6-fff5-4215-ade6-3a3a424d9c8f\"\r\n ],\r\n \"Reports\": [\r\n \"01f3fe89-a7bc-481f-b113-219250720c01\",\r\n \"ddf845c5-3465-4a23-8436-a77c65e1372d\",\r\n \"7bf7d706-a443-48c2-a002-d16f2200bd0a\",\r\n \"3802d91d-7645-4e26-8281-95b05d73c1b2\",\r\n \"b15f4311-d4e2-4bed-955e-53154d381aad\",\r\n \"59e3895b-1304-4a65-bf3a-d161972652f3\",\r\n \"04ef2bf9-6b54-41bd-8bde-70b5cf1fc03a\",\r\n \"bb0cde96-c7be-4b69-9f64-265be29c843d\",\r\n \"129c864c-ccf8-4889-9c21-43a757ce5b28\",\r\n \"309ce6e0-2734-41cc-9ed5-c3dc38f25d5e\",\r\n \"ab827031-ec96-4224-a48e-446737b237e4\",\r\n \"37642461-086d-4e27-9c42-20d258e2c40b\",\r\n \"def034a5-c831-4e19-b777-9b1c08e49ac6\",\r\n \"08dbf936-866e-4b0a-b5e2-cdb68de56c3a\",\r\n \"a2220972-d911-4157-8d90-9f959cec910f\",\r\n \"1bff4f52-e88f-11ec-8fea-0242ac120002\"\r\n ],\r\n \"Permissions\": {\r\n \"AddNewPrescriber\": true,\r\n \"AssignResidentAccessToPrescriber\": true,\r\n \"AddUser\": true,\r\n \"EditUser\": true,\r\n \"IsReadOnly\": false,\r\n \"AllowPrescriberConfirmation\": false\r\n },\r\n \"IsExternalLogin\": false,\r\n \"ExternalUserId\": null,\r\n \"LockToIP\": true,\r\n \"AHPRANumber\": null,\r\n \"SignOutRule\": null\r\n }\r\n ]\r\n}"},{"id":"6e40cdd2-cd39-405d-ac65-4421329d928c","name":"Search By Username","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}"}],"url":{"raw":"{{baseurl}}/api/UserManagement/Users?userName=Nxthuy82@tma.com.vn","host":["{{baseurl}}"],"path":["api","UserManagement","Users"],"query":[{"key":"userName","value":"Nxthuy82@tma.com.vn","description":"BestMed Username"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"IsSuccess\": true,\n \"ErrorMessages\": [],\n \"StatusCode\": 200,\n \"Data\": [\n {\n \"Id\": \"07f5f4d0-688d-473b-b630-ff9d87c13032\",\n \"UserName\": \"Nxthuy82@tma.com.vn\",\n \"Salutation\": \"\",\n \"FirstName\": \"Agency\",\n \"LastName\": \"RN\",\n \"Email\": \"ThuyKAup@gmail.com\",\n \"JobTitle\": \"ProdSuptesting\",\n \"ContactNumber\": \"0411551115\",\n \"UserRole\": \"6b76364a-af6d-4e44-8e90-7c690e3eeacf\",\n \"Status\": \"InActive\",\n \"LastLogin\": null,\n \"Facilities\": [\n \"c6341a81-a53e-48ef-96dd-3b83545ea9fc\"\n ],\n \"Features\": [\n \"a7599b54-7376-4458-8495-96b539a69b9b\",\n \"6fb09446-cb2b-434a-8161-ad3fb2be089d\",\n \"452f5e57-2868-447e-b87a-2aae974efc30\",\n \"8a69f190-2934-40d4-b136-cabd9f808580\",\n \"27861584-3848-4da9-935e-cda30ec60a85\",\n \"31fb5f9b-1a97-4961-9743-ef5fe08bd9ff\",\n \"8735d9b9-d368-451f-acde-a7e85993de9a\",\n \"5eb432e6-fff5-4215-ade6-3a3a424d9c8f\",\n \"04f22397-3891-480a-acd9-655b1b17049d\",\n \"f3777afb-1872-4730-85c6-bae6de21bcaa\",\n \"d63b7c0a-d32d-4a10-ba96-10436cfd108c\",\n \"eeb29df2-882d-4ce3-9740-96397a0a8204\",\n \"7746ada4-1447-48a3-8cd3-1b38665af1c0\",\n \"c1e4aae0-53ed-4347-a11b-4265eca78859\",\n \"96919d02-b0ff-4a59-a0db-adff60cc98c5\",\n \"53e46986-f033-4c92-b759-908fee919933\"\n ],\n \"Reports\": [\n \"de21bdf9-cadb-4b3d-b25a-cea1142eac31\",\n \"6bc1ab7e-850d-492a-b63f-93505b225e61\",\n \"b799486b-69f3-4da1-aaff-720faff345bf\"\n ],\n \"Permissions\": {\n \"AddNewPrescriber\": true,\n \"AssignResidentAccessToPrescriber\": true,\n \"AddUser\": true,\n \"EditUser\": true,\n \"IsReadOnly\": false,\n \"AllowPrescriberConfirmation\": true\n },\n \"IsExternalLogin\": true,\n \"ExternalUserId\": \"Nxthuy82@tma.com.vn\",\n \"LockToIP\": true,\n \"AHPRANumber\": null,\n \"SignOutRule\": 0\n }\n ]\n}"}],"_postman_id":"93d82d37-849c-4b44-aa52-287260566f7d"},{"name":"Create User","id":"a7c11f72-dc08-4d68-a56c-f2bcfdfae415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"}],"url":"{{baseurl}}/api/UserManagement/Users","description":"Creates a new facility user in the BestDose system.
\nThis request supports two usage patterns, each reflected in the examples below:
\nCreate User — Standard user creation. Provide the required user details in the request body to create a new user with default settings.
\nCreate User - TemplateId — User creation using a template. Supply a RoleTemplateId in the request body to pre-populate user permissions, features and reports based on a predefined template, streamlining bulk or standardised user provisioning.
Send a JSON body containing the user details. Refer to the saved examples for the expected request body structure for each usage pattern.
\nThis section covers all endpoints related to managing facility users within the BestDose platform. It provides operations to list, retrieve, create, and update users, as well as retrieve the list of available facilities they can be associated with.
\nRequests are grouped into two patterns:
\nStandard user operations — work with users by their core identity fields.
\nTemplate-based operations — create, retrieve, and update users using a RoleTemplateId, enabling pre-configured user profiles to be applied during provisioning.
NationalQualityIndicatorsModelPolypharmacy Metrics:
\n\"Number of care recipients assessed for polypharmacy excluding recipients admitted in hospital on the collection date\"
\n\"Number of care recipients excluded because they were admitted in hospital on the collection date\"
\n\"Number of care recipients prescribed 9 or more medications based on a review of their medication charts and/or administration records as they are on the collection date\"
\nAntipsychotics Metrics:
\n\"Number of care recipients assessed for antipsychotic medications excluding recipients admitted in hospital for the entire seven-day assessment period\"
\n\"Number of care recipients excluded because they were admitted in hospital for the entire seven-day assessment period\"
\n\"Number of care recipients who received an antipsychotic medication\"
\n\"Number of care recipients who received an antipsychotic medication for a medically diagnosed condition of psychosis\"
\nEndFragment
\n","urlObject":{"path":["api","Report","NQIP"],"host":["{{baseurl}}"],"query":[{"key":"collectionDate","value":"2023-09-01"}],"variable":[]}},"response":[{"id":"8703e4ed-4a2a-4c7e-a444-7c41484b49b2","name":"Get NQIP","originalRequest":{"method":"GET","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"}],"url":{"raw":"{{baseurl}}/api/Report/NQIP?collectionDate=2026-05-01","host":["{{baseurl}}"],"path":["api","Report","NQIP"],"query":[{"key":"collectionDate","value":"2026-05-01"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"IsSuccess\": true,\r\n \"ErrorMessages\": [],\r\n \"StatusCode\": 200,\r\n \"Data\": [\r\n {\r\n \"CollectionDate\": \"2026-05-01\",\r\n \"MedicationManagement\": [\r\n {\r\n \"FacilityName\": \"Test Facility Two\",\r\n \"Polypharmacy\": [\r\n {\r\n \"Query\": \"Number of care recipients assessed for polypharmacy excluding recipients admitted in hospital on the collection date\",\r\n \"Result\": 6\r\n },\r\n {\r\n \"Query\": \"Number of care recipients excluded because they were admitted in hospital on the collection date\",\r\n \"Result\": 0\r\n },\r\n {\r\n \"Query\": \"Number of care recipients prescribed 9 or more medications based on a review of their medication charts and/or administration records as they are on the collection date\",\r\n \"Result\": 0\r\n }\r\n ],\r\n \"Antipsychotics\": [\r\n {\r\n \"Query\": \"Number of care recipients assessed for antipsychotic medications excluding recipients admitted in hospital for the entire seven-day assessment period\",\r\n \"Result\": 6\r\n },\r\n {\r\n \"Query\": \"Number of care recipients excluded because they were admitted in hospital for the entire seven-day assessment period\",\r\n \"Result\": 0\r\n },\r\n {\r\n \"Query\": \"Number of care recipients who received an antipsychotic medication\",\r\n \"Result\": 2\r\n },\r\n {\r\n \"Query\": \"Number of care recipients who received an antipsychotic medication for a medically diagnosed condition of psychosis\",\r\n \"Result\": 0\r\n }\r\n ]\r\n },\r\n {\r\n \"FacilityName\": \"Test Facility One\",\r\n \"Polypharmacy\": [\r\n {\r\n \"Query\": \"Number of care recipients assessed for polypharmacy excluding recipients admitted in hospital on the collection date\",\r\n \"Result\": 5\r\n },\r\n {\r\n \"Query\": \"Number of care recipients excluded because they were admitted in hospital on the collection date\",\r\n \"Result\": 0\r\n },\r\n {\r\n \"Query\": \"Number of care recipients prescribed 9 or more medications based on a review of their medication charts and/or administration records as they are on the collection date\",\r\n \"Result\": 0\r\n }\r\n ],\r\n \"Antipsychotics\": [\r\n {\r\n \"Query\": \"Number of care recipients assessed for antipsychotic medications excluding recipients admitted in hospital for the entire seven-day assessment period\",\r\n \"Result\": 5\r\n },\r\n {\r\n \"Query\": \"Number of care recipients excluded because they were admitted in hospital for the entire seven-day assessment period\",\r\n \"Result\": 0\r\n },\r\n {\r\n \"Query\": \"Number of care recipients who received an antipsychotic medication\",\r\n \"Result\": 3\r\n },\r\n {\r\n \"Query\": \"Number of care recipients who received an antipsychotic medication for a medically diagnosed condition of psychosis\",\r\n \"Result\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"210fc7d9-4016-498d-98b7-17c2adf2254f"}],"id":"d32217f4-67f4-4ece-b5bf-c11d91a88e11","_postman_id":"d32217f4-67f4-4ece-b5bf-c11d91a88e11","description":""},{"name":"PackSchedule","item":[{"name":"Get Roll Data","id":"bf3d12f9-4593-4cad-abec-5e0c0a20f580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"ConnectorId","value":"{{connector_id}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{Ocp-Apim-Subscription-Key}}","type":"text"}],"url":"{{baseurl}}/api/PackSchedule?barcode=J10001195601","description":"Retrieves pack schedule data.
\nSupports both legacy barcode-based filtering and new resident-based filtering through an optional residentId query parameter. When residentId is provided, the endpoint returns the most recent pack schedules for that resident, subject to an optional limit.
Enabled the Resident pack schedule to be uploaded.
\nIf the provided residentId’s Pharmacy has PackScheduleEnabled = 1 and the user integration account has access to this ResidentId.
\n