PatientEvent
Provides REST APIs for Patient Event BC
Node
Provides REST APIs for Infrastructure BC
ClinicalPatient
Provides REST API for managing Clinical Patient Info
HealthIntegration
Provides REST API to communicate with HealthID system
| API | Description |
|---|---|
| GET api/v1/{practiceId}/healthid/patient/{patientId} |
Get url pointed to healthID system for provided patient |
| POST api/v1/{practiceId}/healthid/patient/{patientId} |
Get url pointed to healthID system for provided patient payload |
PowerBI
Provides REST API to provide the ability to list and display PowerBI Embedded reports
| API | Description |
|---|---|
| GET api/v1/{practiceId}/powerbi/reports/{reportId} |
Try get report by id from available parctice reports. |
| GET api/v1/xref/{practiceXRef}/powerbi/reports/{reportId} |
Try get report by id from available parctice reports. |
| GET api/v1/{practiceId}/powerbi/reports |
Generate a list of reports available. This is useful for matching up between report names and Ids |
| GET api/v1/xref/{practiceXRef}/powerbi/reports |
Generate a list of reports available. This is useful for matching up between report names and Ids |
| GET api/v1/group/{groupId}/powerbi/reports |
Get a list of reports within specific PowerBI Workspace |
| GET api/v1/group/{groupId}/powerbi/reports/{reportId}?practiceNo={practiceNo} |
Get report by id within specific workspace and generated accessToken for provided practiceNo |
MyMps
Provides REST APIs to access external systems for info
Patient
Provides REST APIs for Patient BC
ClinicalNew
Provides REST API for Clinical BC (v2)
| API | Description |
|---|---|
| GET api/v2/{practiceId}/clinical/encounters/byVisitId/{patientVisitId} |
Returns the encounter by visit Id |
| GET api/v2/{practiceId}/clinical/encounters/byVisitId/{patientVisitId}/active |
Returns active encounter by visit Id |
| DELETE api/v2/{providerId}/clinical/patient/{patientId}/note/{patientFileNoteId} |
Remove patient file notes previously captured (will be removed from timeline) |
| POST api/v2/{providerId}/clinical/patient/{patientId}/note |
Capture patient file notes to be shown on patient timeline |
| POST api/v2/{providerId}/clinical/patient/{patientId}/timeline/add |
Add to patient dashboard directly any history event (mostly to handle edge cases when we need to merge duplicates, remove mistakenly added data) |
| POST api/v2/{providerId}/clinical/patient/{patientId}/timeline/delete |
Remove patient dashboard directly any history event (mostly to handle edge cases when we need to merge duplicates, remove mistakenly added data) |
| PUT api/v2/{practiceId}/clinical/patient/{patientId}/prescription/{prescriptionId}/render |
Render adhoc prescription (stateless/pure function, dependency: on myPatientFiles) |
| POST api/v2/{practiceId}/clinical/patient/{patientId}/prescription/{prescriptionId}/render |
Render adhoc prescription (stateless/pure function, dependency: on myPatientFiles) |
| POST api/v2/{providerId}/clinical/patient/{patientId}/prescription |
Add prescription to be shown on patient timeline |
| GET api/v2/{practiceId}/clinical/patient/{patientId}/prescription/{prescriptionId} |
Get prescription html body |
| POST api/v2/{providerId}/clinical/patient/{patientId}/{prescriptionId} |
Remove prescription previously added (will be removed from timeline) |
| GET api/v2/{practiceId}/clinical/encounters/{encounterId} |
Returns the encounter by Id |
| POST api/v2/{practiceId}/clinical/encounters/{encounterId} |
Save encounter |
| GET api/v2/{practiceId}/clinical/patients/updated?since={since} |
Get information about patients which were updated since specific datetime in the past |
| GET api/v2/{practiceId}/clinical/allergens |
Get list of available allergens possible to select on UI for a patient |
| GET api/v2/{practiceId}/clinical/patients/{patientId}/updated |
Get datetime when patient was updated last time |
| GET api/v2/{practiceId}/clinical/patients/{patientId}/all |
Get all patient clinical info in one call (dashboard, allergies, conditions, documents, avatar, lifestyle, family members, surgical history, last updated) |
| POST api/v2/{practiceId}/clinical/patientcommunications/archive |
Archive all patient communications within practice (sick notes, prescriptions, referrals, custom letters, etc) |
| POST api/v2/{practiceId}/billing/providers/preferences |
Update only one specific billing provider option |
| GET api/v2/{practiceId}/clinical/patient/genericinformation/{patientId} |
Get generic patient information |
| GET api/v2/{practiceId}/clinical/smarttemplates?token={token} |
Search smart templates by token |
| GET api/v2/{practiceId}/clinical/smarttemplates/staticcategories |
Get Smart Templates "Static Categories" List |
| GET api/v2/{practiceId}/clinical/smarttemplates/staticcategorymedicines?tokens={tokens} |
Get Smart Templates "Static Categories" medicines for provided tokens |
| GET api/v2/{practiceId}/clinical/smarttemplates/staticcategoryconsumables?tokens={tokens} |
Get Smart Templates "Static Categories" consumables for provided tokens |
| GET api/v2/{practiceId}/clinical/druginfobyatc5?token={token} |
Get medicine information by ingredient ATC5 code |
| GET api/v2/{practiceId}/clinical/dosages/{atc5}/{productForm}/{strength} |
Get dosage information for medicine |
| GET api/v2/{practiceId}/clinical/dosages/{mgic} |
Get dosage information for medicine by Medprax Generic Identification Code (MGIC) |
| POST api/v2/{practiceId}/clinical/icdpredictions |
Get The ICD Predictions |
| GET api/v2/{practiceId}/clinical/smarttemplateswithmedicines?token={token} |
Search Smart Templates and receive combined response with medicine information |
| GET api/v2/{practiceId}/clinical/medicines?code={code} |
Search medicine codes |
| GET api/v2/{practiceId}/clinical/consumables?code={code} |
Search consumable codes |
| GET api/v2/{practiceId}/clinical/patient/{patientId}/encounters/rxhistory?type={type} |
Get all historical encounters with prescription or medicines for provided patient |
| POST api/v2/{practiceId}/clinical/patientchronicconditions/tracking |
Get specific conditions by provided ICD codes |
| POST api/v2/{practiceId}/clinical/patientchronicconditions/tracking/filter |
Filter conditions by Icd10 codes, age (from/to), gender |
| POST api/v2/{practiceId}/clinical/patientchronicconditions/tracking/{patientId} |
Remove conditions from tracking dashboard based on provided ICD codes |
| POST api/v2/{practiceId}/clinical/patientcommunication/{patientId}/send |
Allow to send communication to patient via SMS or email |
| POST api/v2/{practiceId}/clinical/encounters/{encounterId}/dischem/send |
Endpoint to send script (new order + add med lines to it) to Dischem system Please Note: implementation done to overcome limitations of using dischem only via static IP (new solution via cloud function is hectic to apply + extra cost). This impl build with mind of all business logic keep on caller side, so here it's just very simple http call a trigger to send script to Dischem |
| POST api/v2/{practiceId}/clinical/encounters/{encounterId}/dischem/update |
Endpoint to send update order in Dischem system, specifically to cancel it Please Note: implementation done to overcome limitations of using dischem only via static IP (new solution via cloud function is hectic to apply + extra cost). This impl build with mind of all business logic keep on caller side, so here it's just very simple http call a trigger to send script to Dischem |
| POST api/v2/{practiceId}/clinical/encounters/{encounterId}/followup/send |
Schedule sending sms as part of visit followups for encounter |
| POST api/v2/{practiceId}/clinical/userfeedback/send |
Sends user feedback to a predefined email address |
| POST api/v2/{practiceId}/clinical/patientcommunication/byId/{id}/retry |
Trigger command to retry patient communication sending |
| GET api/v2/clinical/patientcommunication/failed?since={since} |
Return list of patient communication which failed to send (available for admins) |
| POST api/v2/{providerId}/clinical/patient/genericinformation/{patientId}/revise |
Add/Update patient file generic information |
| POST api/v2/{providerId}/clinical/patient/genericinformation/{patientId}/{genericInformationId}/remove |
Remove patient file generic information |
| POST api/v2/{practiceId}/clinical/pathologyreports/{pathologyReportId}/parsescreening |
Parse pathology report and extract general screening |
| PUT api/v2/{practiceId}/clinical/encounters/{encounterId}/communications/{communicationId}/render |
Render encounter communication (stateless/pure function) |
| POST api/v2/{practiceId}/clinical/encounters/{encounterId}/communications/{communicationId}/render |
Render encounter communication (stateless/pure function) |
| POST api/v2/{practiceId}/clinical/pathologyreport/{pathReportId}/firestore/upload |
Upload path report to firestore (run on firestore node only, N3) |
| POST api/v2/{practiceId}/clinical/medicineinteractions |
Get Medicine interactions from integration |
| POST api/v2/{practiceId}/clinical/pathologyreport/xmltohtml |
Transform provided path report xml to html using xslt transformation (fully isolated endpoint) no projection data touched to allow easily replace in future |
| POST api/ClinicalNew?practiceId={practiceId}&patientId={patientId} |
Search for diagnosis |
| GET api/ClinicalNew?practiceId={practiceId}&formularyType={formularyType}&nappiCode={nappiCode}&schemeCode={schemeCode}&planCode={planCode}&optionCode={optionCode} |
Retrieve formulary information for medicines where we have formulary data stored, for display to the doctor. |
ExternalSystemsIntegration
Provides REST APIs and simplify access for external systems to DrApp
AuditEvent
| API | Description |
|---|---|
| GET api/v1/audit/nodes/{nodeId}/events |
Get latest events for specific node |
| GET api/v1/audit/nodes/{nodeId}/events/top/{top} |
Get latest events for specific node |
| GET api/v1/audit/events |
Get latest events for specific node, filtered |
| GET api/v1/{tenant}/audit/events/{aggregateRootId} |
Get latest events for specified AR |
| GET api/v1/audit/nodes |
Method for getting nodes |
| GET api/v1/audit/events/{tenant}/from/{fromDate}/to/{toDate} |
Get events for tenant |
| GET api/v1/audit/sync/events |
Get latest top messages which come from external system (mymps) |
FunderConfiguration
Provides REST APIs for FunderConfiguration BC
| API | Description |
|---|---|
| GET api/v1/patient/medschemes |
Get all medical aids |
| GET api/v1/patient/funderconfigurations/specificrules |
Get all specific rules |
| GET api/v1/{practiceid}/patient/funderconfigurations/specificrules/{patientId}/{dateOfService} |
Get specific rules for provided patient |
| POST api/v1/patient/funderconfigurations/specificrules |
Update all specific rules in the system |
| POST api/v1/{practiceid}/patient/updatefunderconfiguration |
Update medical aids |
| POST api/v1/patient/updatefunderconfiguration |
Update medical aids |
| GET api/v1/patient/funderconfigurations/refresh |
Refresh list of medical aids (load from prism) |
PatientDocumentResource
| API | Description |
|---|---|
| GET api/v1/document?url={url}&practiceId={practiceId}&saveAs={saveAs} |
No documentation available. |
ChargeCode
Provides REST APIs for ChargeCode AR
| API | Description |
|---|---|
| GET api/v1/billing/chargecodes |
Get all charge codes |
| GET api/v1/billing/chargecodes/{type} |
Get all charge codes |
| POST api/v1/billing/chargecodes/update |
Used to do update of charge code |
| POST api/v1/billing/chargecodes/bulkupdate |
Used to do add of charge code |
| POST api/v1/billing/chargecodes/deactivate |
Used to do deactivate of charge code |
ClinicalAdmin
Provides REST API to manage special use cases for admin persons
| API | Description |
|---|---|
| POST api/v1/{providerId}/clinical/encounters/reimport/{practiceTenantId} |
Reimport all encounters from one tenant to another |
| POST api/v1/{practiceId}/clinical/encounter/{encounterId}/correct |
Allow to correct (update) encounter which was already completed |
| POST api/v1/{providerTenantId}/clinical/encounters/import |
Import a historical encounter into a new providerTenantId |
| POST api/v1/{providerId}/clinical/encountertemplates/import/bulk |
Used to import multiple single-item templates with a types(diagnosis, procedure, medicine, consumable) |
CardPayment
Provides REST APIs for processing of credit card transactions
WaitingRoom
Provides REST APIs waiting room functionality for Patient Event BC
| API | Description |
|---|---|
| GET api/v1/{practiceid}/patientevent/waitingroom |
Get list of patient visits in waiting room |
| GET api/v1/{practiceid}/patientevent/waitingroom/summary |
Get list of patient visits in waiting room with summary |
| GET api/v1/{practiceid}/patientevent/waitingroom/summaryforpractice |
Get list of patient visits waiting room with summary for all providers within a practice |
| POST api/v1/{practiceId}/patientevent/waitingroom/{patientId}/capture |
Initiate capturing encounter workflow (checkin visit if not created, mark as in progress and then encounter will be created) |
| POST api/v1/{practiceId}/patientevent/waitingroom/{patientId}/checkin |
Use to checkin provided patient to waiting room, if patient already checked in do nothing and just return patientVisitId |
| POST api/v1/{practiceId}/patientevent/waitingroom/clear |
Use to clear whole waiting room at once |
Claim
Provides REST APIs for Claiming BC
| API | Description |
|---|---|
| POST api/v1/{practiceid}/claiming/claims/sendclaim |
Send claim |
| GET api/v1/{practiceid}/claiming/claims/{claimid} |
Get claim by their id |
Account
Provide REST APIs for authentication account BC
| API | Description |
|---|---|
| GET api/v1/authentication/account/practices |
Returns the list of practices for which the user is authorised to access. The method to be called after the authentication. |
| POST api/v1/authentication/account/users |
Used to register user in system |
| GET api/v1/authentication/account/users |
Get list of all users |
| GET api/v1/authentication/account/users/{lookupfilter}/search |
Search users according to provided filter |
| PUT api/v1/authentication/account/users/{userid} |
Updates an existing user |
| POST api/v1/authentication/account/users/{userid}/password |
Updates an existing user password |
| GET api/v1/authentication/account/users/{userId} |
Get user details by username |
| GET api/v1/authentication/account/users/byName/{userName} |
Get user details by username |
| DELETE api/v1/authentication/account/users/{userid} |
Deletes an existing user |
| POST api/v1/authentication/account/initialise |
Creates admin user if it doesn't exist |
Reminder
Use to access Reminder API
| API | Description |
|---|---|
| GET api/v1/{providerId}/infrastructure/reminders |
Get reminders for provider |
| POST api/v1/{providerId}/infrastructure/reminders/{reminderId}/update |
Update/Create reminder |
| POST api/v1/{providerId}/infrastructure/reminders/{reminderId}/complete |
Complete reminder |
| DELETE api/v1/{providerId}/infrastructure/reminders/{reminderId}/delete |
Delete reminder |
CommunicationTemplate
Provides API for managing templates
Notification
Use to access Notification API
Billing
Provides REST APIs for Billing BC
Tenant
Provides REST APIs for Tenant BC
| API | Description |
|---|---|
| GET api/v1/infrastructure/tenant |
Get tenant list |
| GET api/v1/infrastructure/tenant/{tenantid} |
Get tenant by id |
| GET api/v1/infrastructure/tenant/xref/{xref} |
Get tenant by xRef (e.g. mps-83b5f484521892640000005056843e73, nova-999992_hpcsaNo) |
| DELETE api/v1/infrastructure/tenant/{tenantid} |
Removes tenant |
| POST api/v1/infrastructure/tenant/{tenantid} |
Updates existing tenant |
| PUT api/v1/infrastructure/tenant/{tenantid} |
Updates existing tenant |
| POST api/v1/infrastructure/tenant |
Creates new Tenant |
FeatureUsage
Provides API for managing feature used
| API | Description |
|---|---|
| GET api/v1/infrastructure/featureusage |
Get all feature usage |
| GET api/v1/infrastructure/featureusage/feature/{feature} |
Get feature usage by tenant |
| GET api/v1/infrastructure/featureusage/tenant/{tenantId}/feature/{feature} |
Get feature usage by tenant |
| GET api/v1/infrastructure/featureusage/tenant/{tenantId} |
Get feature usage by tenant |
| POST api/v1/infrastructure/featureusage |
Use to log new feature usage in system |
| PUT api/v1/infrastructure/featureusage |
Use to log new feature usage in system |
Timer
Provides REST APIs for timer BC
| API | Description |
|---|---|
| GET api/v1/infrastructure/timer |
Get timers list |
| GET api/v1/infrastructure/timer/fromdate/{from}/todate/{to} |
Get timers list based on followup date range |
| GET api/v1/infrastructure/timer/{nodeid} |
Get timers list for node |
| POST api/v1/infrastructure/timer |
Sets timer |
| POST api/v1/infrastructure/timer/{timerid} |
Cancels timer |
PatientDocument
Infrastructure
Provides REST APIs for Infrastructure BC
| API | Description |
|---|---|
| GET api/v1/{practiceid}/infrastructure/network/state |
No documentation available. |
| GET api/v1/infrastructure/api/routes |
Get list of all REST endpoints |
| POST api/v1/infrastructure/memory/collect/{level} |
Collect memory to specific generation level |
| POST api/v1/infrastructure/memory/collect/loh |
Collect Large Object Heap |
| GET api/v1/infrastructure/processing/commands/dlq |
Download messages which stuck currently in .commands dlq |
| POST api/v1/infrastructure/processing/commands/dlq/retry/{count} |
Get specified no. of messages from dlq and return them back to original queue |
| POST api/v1/infrastructure/command/send |
Receive any AR command as json string and fire into CQRS infrastructure Please make sure to set $type field to help serializer get proper command type, e.g. RemoveCommunicationTemplate command will look like this: "{\"$type\":\"Com.Healthbridge.Core.CommonDomain.Interface.Commands.RemoveCommunicationTemplate, Com.Healthbridge.Core.CommonDomain.Interface\"}" |
| POST api/v1/infrastructure/projections/snapshot |
Make snapshot for in-memory projections, as result return checkpoint token |
| POST api/v1/infrastructure/providers/{tenantXRef}/add?sendUserCredentialsToProvider={sendUserCredentialsToProvider} |
Setup doctor environment (create ProviderConfiguration, register user, insert default templates, etc) |
| POST api/v1/infrastructure/testing/create/{practiceId}/counts/{count} |
Temporal endpoint for performance testing (creates practices based on provided) |
| GET api/v1/{tenantId}/clinical/all/setup?username={username}&password={password} |
Create new provider context including all data inside based on provided tenantId |
Clinical
Provides REST API for Clinical BC
TokenProviders
Provides REST APIs tor retrive tokens
| API | Description |
|---|---|
| GET api/v1/infrastructure/{practiceId}/tokenproviders/{type} |
Get access token for specific provider (by provider name - signalr, practice_signalr, etc) |
| GET api/v1/infrastructure/{practiceId}/tokenforbridgeit/{issuer} |
Get bridgeIT access token for specific provider |
| GET api/v1/infrastructure/{practiceId}/tokenproviders |
Get all access tokens for different providers |