Generate API Credentials

Generate API Credentials

API Credentials that are generated in the PM are used to integrate with the PM API.

  • The PM API documentation guides Users through the process of integrating with the API using these credentials.

Generate New API Credentials

  1. On the Left Side Menu, select Interfaces.
  2. Select API Credentials.

  1. Select Generate New Credentials.

  1. Ensure the appropriate PM User is selected in the Associated User dropdown.
  • This should pre-fill the Client ID, Client Secret, and Refresh Token.
  1. Name: Enter the name of the application that is being integrated with the PM.
  2. Email: Enter the email of the User who is responsible for developing and maintaining the integration.
  3. Use Chart Number Instead of Patient ID (optional): If checked, the API responses will send the Chart Number in place of any Patient IDs.
  • This can be useful when integrating an EHR/EMR.
  1. Implementing Webhooks (optional): If checked, this allows for a two-way integration.
  2. Select Save [F2].

API Credentials (FHIR API)

The API Credentials at the top of the popup are used to integrate into the FHIR API, but are generated simultaneously with the Gateway Service User API Credentials.

Gateway Service User API Credentials (PM API)

The Service User API Credentials are required to complete the authorization process in the API Gateway, which then allows the User to integrate into the PM API and all other APIs (such as the POPS API).

  1. Select the Modify icon next to an existing set of API Credentials.
  2. Gateway Client ID: This is unique to the Gateway, which allows the User to authenticate with the API Gateway to access the other APIs.
  3. Gateway Client Secret: This is unique to the Gateway, which allows the User to authenticate with the API Gateway to access the other APIs.

  1. Username and Password: Matches with the Client ID above.
  2. Database ID: The unique identifier that allows the API to determine which Database the request is associated with.
            

PM API Documentation

The PM API Documentation provides instructions on integrating directly into the PM API using the API Credentials that were generated in the PM (see instructions above for more information)

  • To access the PM API Documentation, select the API Documentation link on the API Credentials Page.


    • Related Articles

    • Interface System Settings

      Interface API_PASSWORD - API PASSWORD Contact support with questions about this setting. API_URL - API URL Contact support with questions about this setting. API_USERNAME - API USERNAME Contact support with questions about this setting.

    • Billing/Rendering Providers

      Providers can be added using the NPPES Import Tool that completes the Provider screen which only requires editing. If the Provider cannot be found using the NPPES tool, the Provider can be added manually from a link that displays only after you have ...

    • Add or Modify Referring Providers/PCP

      Add or Modify Referring Providers/PCP One Library is kept for both the Referring Provider and PCP. System Settings for Referring Provider Access System Settings: Admin > System Settings > Charges > REFPROVIDER Auto-populate the Referring Provider on ...

    • Interface Dashboard

      The Interface Dashboard is used for Incoming and Outgoing Messages from your Clinical Documentation or other third party groups using HL7, SFTP, or API connections. Learn More Incoming Mappings Edit or Change a Mapping

    • Anesthesia Visit Concurrency

      Anesthesia Visit Concurrency Concurrency occurs when an anesthesiologist is medically directing or medically supervising the work of one or more anesthesia professionals. The appropriate billing modifier is determined by the maximum number of cases ...