Application Registration
The Netsmart CareConnect FHIR APIs have received a significant update which introduces a new authorization server and new tenant specific base URLs. The process for registering your application for the new APIs has changed as a result.
To get started working with the Netsmart APIs you will first need to:
- Determine the API(s) you will use.
- Create an Account.
- Register your Application.
- Request Authorization.
Before You Begin
We have implemented new authorization servers and APIs to better support the latest SMART on FHIR requirements. The process to register and obtain authorization is different depending on the APIs you are intending to use.
Current APIs
This following APIs use our new developer portal and authorization server.
- Provider Patient Access:
/provider/patient-access/v2/{tenant} - Provider System Access:
/provider/system-access/v2/{tenant} - Payer Patient Access:
/payer/patient-access/v2/{tenant} - Payer System Access:
/payer/system-access/v2/{tenant}
Previous APIs
The following APIs use our original authorization server.
- Certified Patient Access (v1):
/uscore/v1 - Certified Bulk Data Export (v1):
/uscore/v1/bulk-data - General Purpose FHIR R4:
/v4 - General Purpose FHIR STU3:
/fhir - PatientImage API:
/v4/PatientImage - CCD API:
/ccd
Create an Account
- Current
- Previous
This feature is currently in early testing and is subject to change.
- To create a Developer account, navigate to the Developer Portal for the environment you wish to work with:
- Select Sign Up.
- Enter the following information:
- Username (must be unique and cannot be your email address)
- Given Name (i.e., First Name)
- Family Name (i.e., Last Name)
- Email Address
- Password (choose a unique strong password to keep your account secure)
- Re-enter Password
- Select Sign Up.
- Verification process to be documented.
- To create a Developer account, open the Authorization server for the environment you wish to work with:
- Select 'Create an Account'.
- Enter the following information:
- Email Address
- Username (this will be created automatically based on your email address, but may be modified)
- Password(choose a unique strong password to keep your account secure)
- Company
- Agree to the Terms of Service then select 'Create Account'.
Register your Application
Once you are logged in, you are now able to register your application.
- Current
- Previous
- Select Applications in the top navigationbar.
- Select Create Application.
- This will launch a guided setup to get your application registered. Prompts include:
- Type (e.g., Patient-facing application or System integration)
- Platform (e.g., Web server application or Mobile/Desktop application)
- Access (i.e., Provider APIs or Payer APIs)
- Authentication (i.e., Client Secret or Private Key JWT)
- Details (e.g., Application name, Company Name, Redirect URIs, etc.)
- At the end of the guided setup, review the answers and the resulting OAuth configuration. Go back to make any corrections as needed.
- If correct, select Create Application.
- You will be shown your application details.
- Select 'New Application' to register your application
- Enter the relevant information for your application:
- Application Name (Required)
- Application Description (Required)
- Home Page (Optional)
- Privacy Policy (Optional)
- Redirect URI (Optional)
- JWK Set URI (Optional)
- Select 'Create Application'.
Now that your app is registered, you can retrieve the client id and secret and be able to use this app with one of our solutions once it has been authorized.
Request Authorization
- Current
- Previous
- Select the Tenant Authorization tab.
- Under Request Tenant Authorization, search for and select the Organization (tenant) you would like access to.
- Select Request Authorization.
- Your authorization request has now been submitted and will be reviewed by a owner of that tenant.
Open and complete this form to request authorization for your application: