Data Dictionary
MWI Terminology
There is several terminologies that are used across UI's, API's, this section will cover both previous and new terminology and mappings between them to help you understand what users will see, and what you will see in the API.
Each term will be badged with EXISTING or NEW to guide you in our transition between terminology.
| Term | Meaning | Merlin UI (Legacy) |
|---|---|---|
Tenant NEW | A customers identifier within the MWI Integration Platform | Within GAPI (v2 API) this was referred to as GroupId |
Location NEW | A location within the customers tenant. Identifier for Location is unique across all customers. | Sites |
Space NEW | A space within a location which can be defined for a purpose, such as Stock Room, Consult etc | Stock Centre, Kennel, Ward |
Contact EXISTING | A person which can be uniquely identified as a system Actor (Client, User, Practitioner). A contact is all of these actors at the parent level. A contact of the same Actor type should not be duplicated. | Previously Contact and Account were 1 entity, in the Merlin UI they still appear so. |
Practitioner EXISTING | A member of clinical staff, Practitioner is a child entity of Contact. | Surgeon |
User EXISTING | A user of the system which is a child entity of Contact. This is different from a Practitioner however they may be related. | User |
Daylist NEW | Field under Practitioner Type, this is to identify tasks which are not related to a client appointment but are related to a care task such as hospital stay or operation | Special Surgeon |
Cities EXISTING | Part of the address as a fixed list of cities accepted by the system | City, Town |
Account NEW | An account is the relationship between different entities under the common account.
| Currently a single Entity with Contact. |
Account Type NEW | Categorisation of the Account by the intended purpose, e.g. Monthly Accounts, Small Animal Accounts | Client Category |
Account Category EXISTING | Categorisation of the Account by the accounts current State, i.e. Bad Debtor, Payment Plan, etc. | Account Category |
Billing NEW | Transactional record of all financial activity undertaken for an Account.
| Accounts |
Patient NEW | The animal registered within the tenant, All information related to the identification of the Patient or their status is within this domain. | Animal, Patient |
Clinical NEW | The domain of Clinical is where all information of recording clinical action or notes is stored.
| Treatment, Treatment History, Treatment Draft, Weight Chart, Clinical Notes |
Formulary NEW | The domain of Formulary is where all information regarding the services and products the tenant (practice) sells is configured. | Code Entry, Various Libraries (metadata) |
Formulary Type NEW | Categorisation of the Formulary records under headings, such as Consultation | Treatment Type, Code Type |
Inventory NEW | The domain of Inventory is where the source product is identified and managed including various batches and the tracking of its usage across multiple locations and spaces. | Stock Control, Wholesale |
Calendar NEW | The Calendar domain is where all scheduling is to occur from staff rota’s, room booking, equipment booking, Practitioner allocation and appointment booking. | Diary |
Communications NEW | Domain for ownership of all communication processes and recording of send communications. | SMS, Email, Communication Logs |
Reminders NEW | Reminder records of clinical work completed for their renewal or action dates, such as annual vaccinations or apply treatment reminders | Patient Reminders, Compliance Reminders, Appointment, Reminders |