Provider Services API

Complete these steps to deploy and configure the Provider Services API and its OneKey System API through MuleSoft Direct. Setup connects the applications to Salesforce and IQVIA OneKey, grants the integration user the required access, and prepares the shared reference data used by SBC and DCR.

Prerequisites

• MuleSoft Direct setup is required. For more information, see the MuleSoft Direct setup guide.
• Obtain the credentials required to connect to the external MDM system.
• To integrate the application with Life Sciences Cloud, set up a Local External Client App in your Salesforce org. When you configure the external client app, select Run as Integration User. You'll need the credentials from this external app during the MuleSoft Direct setup.
• Make sure the Integration User connected to the external client app has read and write access to all mapped entities and fields in Life Sciences Cloud.
  • Create a custom permission set that uses the Life Sciences Commercial license and grants access to all required entities and fields.
  • Create a second custom permission set that uses the Salesforce API Integration license, and enable the following System Permissions:
    • Modify All Data
    • Customize Application
  • Assign both custom permission sets and the Life Sciences Field Medical permission set to the integration user.
  • Enable Field-Level Security (FLS) for the integration user profile for all mapped fields.
  • If you use the out-of-the-box field mappings, make sure FLS is enabled for the following fields:
    • Account
      • Phone
      • Fax
      • PersonBirthDate
      • PersonTitle
      • PersonHomePhone
      • PersonMobilePhone
    • ContactPointAddress
      • IsActive
    • HealthcareProvider
      • SourceSystemModifiedDate
      • ProfessionalTitle
      • IsPrivacyLawEnabled
      • OperatingCountryCode
      • IsActive
    • BusinessLicense
      • ContactPointAddressId
    • ContactPointBestContactTime
      • SourceSystemIdentifier
      • DayOfWeek
      • IsActive
    • ProviderAffiliation
      • SourceSystemIdentifier
      • IsActive
    • HealthcareProviderSpecialty
      • Rank
• Make sure the IntegrationJobRun.Status picklist includes these values:
  • New
  • InProgress
  • Completed
  • CompletedWithError
  • Failure
  • AbortInitiated
  • Aborted
• Make sure the PrimaryProviderRestriction Salesforce org preference is enabled in Salesforce Setup.
• Make sure State and Country/Territory Picklists are enabled.
• The Codes Job in Provider Bulk Sync is a one-time execution process and a required setup prerequisite before you use Search Before Create or Data Change Request. Run the job after deployment to load the required dynamic picklist values.

Setup

Deploy the OneKey System API first because both SBC and DCR use it for OneKey connectivity and mapping.

Deploy the OneKey System API

If Provider Bulk Sync is already deployed, the OneKey System API is already available. Otherwise, complete these steps to deploy it manually:

1. Log in to Salesforce.
2. From Setup, search for and open Integrations Setup.
3. Select OneKey System API, and click Enable.
4. Enter the application display name, target business group, and deployment environment, and click Next.
5. Select the OneKey System API tab, and enter these application properties:

1. To add optional configuration, click Add Additional Parameters, and enter the required details.
2. Click Proceed to deploy the application.

Deploy the Provider Services API

Deploy the Process API after the OneKey System API so its System API connection is available.

1. In MuleSoft Direct, select Provider Services API, and click Enable.
2. Enter the application display name, target business group, and deployment environment, and click Next.
3. Select the Provider Services tab, and enter these application properties:

1. To add optional configuration, click Add Additional Parameters, and enter the required details.
2. Click Proceed to deploy the application.

Post Deployment

Complete these shared steps before enabling either feature:

1. Configure the OneKey-supported countries as two-character country codes in the onekey.download.codesCountryList runtime property. This limits reference-data retrieval to contracted countries.
2. Run the required one-time Codes Job in Provider Bulk Sync. This loads the dynamic picklist values used by SBC and DCR mappings.

Search Before Create (SBC)

Use the synchronous API operations after the shared setup is complete.

1. Review the endpoints, sample payloads, error responses, and request-field constraints in the Provider Services API specification.
2. Use the provider-services/v1 base path. For example, call https://{{hostname}}/provider-services/v1/provider/search to search for providers.

Data Change Request (DCR)

Enable both DCR schedules so qualified requests are submitted and processed requests are monitored.

1. Log in to Anypoint Platform.
2. Select the organization and deployment environment in Runtime Manager.
3. Open Provider Services API, and go to Schedules.
4. Enable or disable the DCR Submission and DCR Monitoring jobs as required.

Extensions

To support external DCRs, customize the DCR Handler, not the Provider Services app. DCR comments aren't in the out-of-the-box OneKey mapping. For field-mapping changes, country-specific overrides, configuration limits, and Salesforce DCR Handler extensions, see Extend Connector.