FAQ's categories
  • After I register, how can I get the Developer Portal documentation?

    Ensure you have logged in using the Log In feature in the right-hand side of the page header. Then, navigate to the Documentation page by clicking Documentation in the page header.

  • Do you support the Fast Healthcare Interoperability Resources (FHIR) API?

    Yes, we support FHIR APIs as outlined in the Cures Act.

    We support the regulatory FHIR requirements as outlined in the relevant Cures Act regulations at 45 CFR 170.315(g)(10). Our standard Developer Portal (this portal) provides documentation for our proprietary APIs and other interoperability solutions, so please see our FHIR-specific portal at https://fhir.advancedmd.com for more information about our FHIR capabilities.

  • How can I contact AdvancedMD's Interoperability support?

    Please use the Contact page located in the footer of this portal site to access our support form. Our InterOps support team will contact you with answers or to request additional clarification.

  • How can i restore my password?

    There is Log in / Sign up block in the top right corner next to Search field. Please, click on any of the buttons, you will be redirected to the Login page. Switch to the Reset your password tab. Fill in your password. Instructions will be sent to your email. 

  • How can I test the APIs?

    To test the provided API, follow these general steps:

    1. Obtain a license and sandbox key:
      1. Contact our Sales team here to request a license and a sandbox key, which is a test environment with fake patient data you can use to test your API calls against.
    2. Access API Documentation:
      • Refer to the API documentation provided in the APIs block. Look for information on endpoints, authentication methods, request parameters, and response formats.
    3. Understand Authentication Requirements:
      • Identify the authentication method required for accessing the API. Common methods include API keys, OAuth tokens, or other authentication mechanisms. Ensure that you have the necessary credentials.
    4. Construct Test Requests:
      • Create test requests based on the information in the API documentation. Include necessary headers, parameters, and authentication details. Pay attention to request methods (GET, POST, PUT, DELETE) and their corresponding endpoints.
    5. Submit Requests:
      • Send the constructed requests to the API endpoints. Monitor the responses for status codes, which indicate the success or failure of the request. A successful request typically returns a status code in the 2xx range.
    6. Inspect Responses:
      • Examine the responses for the expected data format and content. Check for any error messages or unexpected behavior. Use the information provided in the API documentation to interpret response data.
    7. Explore Different Endpoints:
      • Test various API endpoints to explore different functionalities. Pay attention to how the API handles different types of requests and parameters.
  • How do I access the documentation?

    Full access also requires you have a confidentiality agreement in place with AdvancedMD, whether that be through a client Agreement, an API Developer Agreement, or a Non-disclosure Agreement. Please contact our Sales team here to discuss which agreement makes the most sense for you.

    Once you have an agreement in place with AdvancedMD, you will need to Register. On our Developer Portal main page, click Log In in the right-hand side of the site header, or click here.

    Note that your user must be approved by an AdvancedMD team member before you will be granted full access to our documentation. Please allow several business days for approval to be given.

  • What is the ODBC?

    In addition to our REST APIs, AdvancedMD also offers a custom ODBC driver that developers can use to extract and maintain a backup of nearly all client data. This service is commonly used by clients and their developer partners to support ETL workflows into their own data warehouses for custom analytics, reporting, and business intelligence initiatives.