Account Management
The main entry point to access and invoke Updox API calls is through creating an Account. An Account represents a single group of Users, Contacts, Patients, Settings, and Portal accounts. Different systems refer to this same concept in different ways; for example: clients, practices, accounts, etc.
Within each Account there must be at least one User to auth with. A User represents a single group of Messages, Preferences, and Settings. Different systems also refer to users in various, sometime overlapping, ways; for example: providers, doctors, nurses, admins, office, etc.
Contents |
Account Management
The Updox API provides three methods to create an Account: PracticeCreate, PracticeUpdate, and PracticeSave.
Creating or updating an Account requires Vendor-level credentials.
PracticeCreate
The PracticeCreate API method is an explicit call to create a new Account. It accepts multiple fields of both information about the Account as well as settings, though only the name field is required. Providing Account information will help to facilitate referencing the Account for support issues, while providing settings may be required for use in a particular integration.
- Samples and examples using the PracticeCreate API method
- Interactive API page for the PracticeCreate API method
Account Information Fields
name
Name of the account or practice.
address1
address2
city
state
Valid state or US territory
postal
Five or nine digits only
phone
Ten digits only
fax
Account Settings Fields
accountId
When creating an Account, the accountId passed into the Application Authentication Header with the request will become the new accountId used to reference and auth with the newly created Account. If that accountId is already in use, then the request will fail with an responseCode value of 4130: account already exists.
active
The active setting for Accounts sets the active status. An inactive account will be denied authorization, and in the interests of security, any attempt to authorize will be met with the same failure message as invalid credentials. The exceptions to this are the methods Template:PracticeUpdateLink and Template:PracticeSaveLink which allow re-activation of an Account. Thus, care must be taken when setting the active flag.
directAddress
The directAddress setting for Accounts sets the direct address for the Account. This is the address that will be used for direct messages sent from the Account level, opposed to a specific User. Direct messages sent from and to the Account are viewable by all Users in the Account.
timeZone
The timeZone setting for Accounts sets the timeZone for the Account which effects the representation of date-times for items. The default value is Zulu time, and the valid values are:
- America/Anchorage
- America/Chicago
- America/Denver
- America/New_York
- America/Los_Angeles
- America/Phoenix
- America/Puerto_Rico
- Pacific/Honolulu
- Zulu
websiteAddress
The websiteAddress setting for Accounts sets the specific domain for the Patient Portal for that account. For example, in the Updox production region, if an Account sets the websiteAddress to "updox" then the web address for the Patient Portal of that account would be https://updox.myupdox.com. The websiteAddress must be globally unique across all Updox accounts and the call to create a practice will fail if the address is already in use.
PracticeUpdate
PracticeUpdate is an explicit call to update the information or settings of an Account. It provides the same fields as PracticeCreate, and every field will be updated with the new values. That is, if an Account has a value saved for city, then not passing in a value for city to PracticeUpdate will clear that value.
Note that when updating an Account, the accountId passed into the Application Authentication header will reference the Account to be updated. If an Account does not exist for that accountId, the request will fail.
- Samples and examples using the PracticeUpdate API method
- Interactive API page for the PracticeUpdate API method
PracticeSave
PracticeSave is a non-explicit call to *either* create *or* update an Account. If an Account does not exist for the accountId passed into the Application Authentication header, then a new Account will be created. Otherwise, the matching Account will be updated. In the respective cases, PracticeSave performs as PracticeCreate and PracticeUpdate.
