Applications

On the Applications tab, as a developer, you can:

• Register a new application and view if an application being registered in the Developer Portal is already published in the CAQH Endpoint Directory through an registration email received.
• Delete a registered application.
• Browse through existing applications and view the details (such as organization name and type, a callback URL, scope, environment, client ID, and a secret key) of each registered application.
• Search for applications by their names or/and by the name and the type of the organization to which the applications belong.
• Copy the client ID and the client secret for each application.
• View the date and time when a certain application has been created and when the client ID and the secret key status changes to Assigned or Unassigned.
• View the developer information in Developer Details, such as: the first and last names of the developer who registered the application, organization name and type to which a certain developer belongs, and registered Email ID.
• Select an environment (blank, sandbox, production) for which you want to request access.

Note Only developers can register or/and delete an application(s) through a developer's account. Administrators and Super Users can only review and manage a certain application by adding a client ID and a secret key, scopes, and by configuring the attributes for the application registration.

To register an application:

1. On the tab Applications, click Register Application if there are no applications in the section.

   -Or-

   Under Registered Applications, click Register Application if at least one application has been registered in the section.

2. In the Register Application pane, upload an image with your application's logo.
3. In Application/Endpoint Name, enter the name for your application.
4. In Organization Name, enter the name of your organization.

   Note If you have not entered the organization name, the Organization Type field is not available.

5. In Organization Type, from the drop-down list, select the type of your organization, such as Payer, Provider, Logistics, Employer, Retailer, Vendor, and Others. If you have selected Others, in the field that appears, enter the type of your organization deciphering Other.

   Note If you, as a developer, belong to a certain organization, then the Organization Type field is pre-populated with the organization type value fetched from the Smart Trading account, though, you retain the ability to update or remove the value from this field.

6. In Description, enter a short description for your application.
7. In Application/Endpoint URL, enter URL for your application if required.
8. In Callback URL, enter the callback link of the application.
9. In Environment, from the drop-down menu, select the environment (Blank, Sandbox, Production) for which you want to request access.
10. In Scopes, the scope is set up by the payor and is retrieved automatically.
    Click to view the default scopes.

    Scope	Grants
    patient/*.read	This scope permits your application to access the supported resources for a currently logged-in customer.
    openid	This scope permits your application to retrieve information about a currently logged-in customer.
    fhirUser	This scope permits your application to retrieve information about a currently logged-in customer.

11. Click Save or Cancel.

Note You cannot edit the applications once they are registered.

After you have registered the application, a notification email is sent o all the email addresses specified in the Registration Settings.

You can also delete an existing application from the Developer Portal.

To delete an application:

1. In the list with applications, select an application you want to delete, and then click Delete.
2. In the confirmation dialog, click Yes to confirm the application deletion.

Note After you delete an application, you are not able to access the application data.

After you have deleted the application, a notification email is sent to all the email addresses specified in the Registration Settings.

On the tab Applications, as an administrator or a super user, you can:

• Monitor and manage all the applications registered by the developers in the Developer Portal.
• View all the registered applications along with their details (such as organization name and type, a callback URL, scope, client ID, and a secret key).
• View a certain application name, the date and time when the application has been created, environment (blank, sandbox, production) for which access has been requested, and registered email ID.
• View the developer information in Developer Details, such as: the first and last names of the developer who registered the application, organization name and type to which a certain developer belongs, and registered Email ID.
• Search for applications by their names or/and by the name and the type of the organization to which the applications belong and sort the applications by a date of creation.

Also, you can:

• Configure attributes for application registration.
• Turn on or turn off the Payer Environment field to allow/not to allow the developers to request access for a production or sandbox environment while they register their applications.
• Set up/edit and update the client ID and the secret key for a certain application (once you, as a portal administrator or a super user, set up/edit and update the client ID and the secret key, an email notification is sent to a developer's registered email ID).
• Set up the access scope for the registered applications (the scopes define the authorization components of the customer that will be using your application).
• Configure the Terms and Conditions URL that is accepted by developers during registration of their accounts.
• Configure an email address(es) (email ID setup) to which the notifications will be sent when a certain application is registered/deleted.
• Set up the email disclaimer that is sent as a part of all the email notifications from the Developer Portal.

To allow developers to register their applications, set up registration configuration. To do this, first switch to Edit View on the top of the Developer Portal, and then click Registration Settings that will be displayed after you switch to the edit mode.

To set up a registration configuration:

1. On the tab Applications, click Registration Settings.
2. In the pane Registration Settings, in Scopes, enter the allowed access scopes for the application registration.
3. In the field for an email, enter the email address(es) separated by comma (,) to which application's notifications are sent.
4. In Email Disclaimer, enter the text for the email disclaimer that is sent as a part of all the email notifications from the Developer Portal.
5. Turn on/turn off the Payer Environment field to allow/not to allow the developers to request access for the production or sandbox environment while they register their applications.
6. Click Save.

Once the application is added by a developer, you, as a portal administrator or a super user, can manage the application workspace. Developers will be able to access the similar view and to register the applications. Note that changes made on this page do not require explicit publishing.