Clinician Statuses

How do I retrieve a list of clinician statuses?

The List Providers endpoint of the Axuall API allows you to regularly poll for clinician statuses. This allows you to:

1. Establish a regular schedule to see the clinician status based on your business needs.
2. Retrieve a list of providers that have had a status update since the last pull.
3. Use the list of providers to pull their clinician data from the Verified Share endpoint.

The List Providers can be used to achieve this. The following search parameters are recommended for knowing when to pull a clinician's data through the Verified Share endpoint based on the status of them:

1. Set the Invitation status to Account_shared or Application_submitted. This will filter the provider list to clinicians whose presentations are available via the Verified Share endpoint.

📘

What is a presentation?

Presentations are a snapshot of a clinicians data that includes all of their credentials. When any of their credentials change, the presentation date will update to the latest date the change occurred.

2. Set the min_last_wallet_shared and max_last_wallet_shared to intervals you are regularly polling.

The following invitation statuses are available to track the clinician's progress through completing their wallet if they are an engaged one or the status of their account if they are unengaged:

1. Invite_bounced: The invitation sent to the clinician failed. This is likely due to an invalid email address.

   1. 📘

      Axuall Support

      In this instance, the clinician will not be able to proceed with the wallet and a support ticket should be placed with Axuall to investigate this further.

2. Invitation_sent: An invitation was sent to the clinician.
3. Invite_canceled: The invitation sent to the clinician was canceled.
4. In_process: The clinician has logged in and started the wallet.
5. Account_shared: The clinician's data is available in the admin center and Verified Share endpoint. This status will return for unengaged clinicians.
6. Application_submitted: The clinician has shared their wallet with the subscriber group. This status will return for engaged clinicians.
7. Reminder_sent: A reminder email has been sent to the clinician to complete their wallet.

Registration status tracks the latest event performed by a provider in their wallet. It will change more frequently than the invitation status because it tracks login events. For example, if a provider logs into their wallet outside of a share event, the status will change to in_progress to reflect that the provider has logged in. The following registration statuses are available to track the clinician's registration status in the Axuall system:

1. Pending: The clinician was not successfully registered in the Axuall system and cannot proceed forward until the issue is resolved.

   1. 📘

      Axuall Support

      In this instance, the clinician will not be able to proceed with the wallet and a support ticket should be placed with Axuall to investigate this further.

2. Invitation_sent: An invitation was sent to the clinician.
3. In_progress: The clinician has logged into the wallet for an engaged user or the provider's presentation is being created for unengaged users.
4. Account_shared: The clinician has shared their wallet with the subscriber group or the data is now available and can be retrieved from the Verified Share API endpoint.

Workflow

Provider Registration + List Providers + Verified Share

Provider Registration: Allows for the loading of providers with existing data clients have on hand.

Verified Share: Automate real-time data transfer between Axuall and the system of record.