Skip to main content

Account Management

Account is an entity which manages the relationships between multiple entities which also contains its own metadata.

Accounts in Merlin?

The account in the VIP is not the same as the Merlin legacy terminology, within Merlin the "Accounts" is referred to as "billing", were-as "Account" in the VIP is the link between the Client (Contact Type), Patients and Billing.

Relationships​

Below you will see that the account is the bridge between a Contact, Patients and Billing.

The account contains specific metadata which supports the relationships between these entities, such as a key field called account-number which is an tenant unique integer identifier for the account usable for human readable formats.

erDiagram Account ||--o{ Patient : Related Account { uuid account-uuid } Patient { uuid patient-uuid uuid account-uuid } Account ||--|| Contact : Related Contact { uuid contact-uuid } Account ||--o{ Billing : Has Billing { uuid billing-uuid uuid account-uuid }
caution

In the current iteration there is a 1:1 relationship between Account and Contact.

This is due the current legacy support, however please plan for a 1:M relationship where 1 Account may have Many Billing accounts.

  1. An Account cannot be created without a Contact of the Client Type.
  2. A Patient cannot be created without an Account specified.

Account Schema​

Please take note of the following points for this schema:

  1. Account-Number - Is only unique within the Tenant-Id, this is generated upon creation.
  2. Account-Type - Known as Client Category within the Merlin UI.
  3. Registered-Location-UUID - The location the account will be managed from within this Tenant.
  4. Remaining Metadata - When creating an account the majority of the account metadata can be left empty for default values to replicate the Merlin function.

Cross Domain UUID References​

ReferenceDomainResourceNote
registered-location-uuidlocation-management/locationsAssociation of the account to a practice location for account management.
discount-category-uuidbilling/discount-categoriesAssociation of the account to discount category (automatic discounts during billing).

Security Scopes​

The following authorisation scopes are required to access different resources within this domain:

  • account-mgt:read
  • account-mgt:create
  • account-mgt:update
  • account-mgt:remove
  • account-mgt:accounts:read
  • account-mgt:accounts:create
  • account-mgt:accounts:update
  • account-mgt:accounts:remove