Call the API

Salesforce Healthcare API uses the following URL format, which aligns with the FHIR standard:

  • Resource type - FHIR resource type

  • API version - Version of the FHIR API

  • FHIR version - Version of the FHIR standard

  • FHIR module - Module of the FHIR resource

    FHIR ResourceFHIR Module
    Administrationadmin
    Bundlebundle
    Care Managementcare_management
    Clinical Summaryclinical-summary
    Clinical Diagnosticsclinical-diagnostics
    Clinical Workflowclinical-workflow
    Medicationsclinical-medications
    Prior Authorizationprior-auth
    Formsforms

  • Domain name:

    • For US region in the Production environment - api.healthcloud.salesforce.com
    • For US region in the Sandbox environment - api.healthcloud.salesforce.com/sandBox/
    • For EU region in the Production environment - eu.api.healthcloud.salesforce.com
    • For EU region in the Sandbox environment - eu.api.healthcloud.salesforce.com/sandBox/
    • For CA region in the Production environment - ca.api.healthcloud.salesforce.com
    • For CA region in the Sandbox environment - ca.api.healthcloud.salesforce.com/sandBox/
    • For Australia region in the Production environment - au.api.healthcloud.salesforce.com
    • For Australia region in the Sandbox environment - au.api.healthcloud.salesforce.com/sandBox/

For example, to get information about a patient’s condition from the sandbox environment, make a GET request to this URL:

To get information about a patient’s condition from the production environment, make a GET request to this URL:

For more information, see the Salesforce Healthcare API reference.