Get Started

Through the Care Span Web API your applications can retrieve transaction content. The base address of the API is https://test-api.carespan.clinic. To access transaction data through the Web API, an application must get the user’s permission to access the data. Authorization is via the pro health Accounts service at https://test-api.carespan.clinic.

• Get a Care Span Web Services Client ID and Client Secret to use when making your API calls
• Read the details for your choice of API to get instructions for making Web Service calls.
• Read the Terms of Use to make sure your integration adheres to the fine print

User can use API to get the transaction details to following the below steps.

• User Registration :

  Before start using WEB API all users must register at WEB API portal.

• Email Activation:

  After register on site You will receive the account verification code using that code you need to verify user account and then Admin will verify your account details and send the client_id/orgID and client_secret/token details on your register email address.

  .
• Login oAuth :

  When user get the client_id/orgID,client_secret/password details on mail user must authenticate the details on WEB API portal before making any transaction APIs calls. User must authenticate account using Login oauth methods.

  For Security purpose your authentication valid only for 1 hour time span. After that you need to refresh access token to continue access for transactions APIs.

• Transaction API calls:

  When user successfully verify with the Login oAuth method you can access the transaction APIs.

  • Patient Facing Appointment Resources
    • Get Patient Appointments
    • Create Appointment
    • Update Appointment
    • Update Appointment - Patient Arrives Encounter
    • Update Appointment - Patient Leaves Encounter
    • Get Doctor Available Slots
    • Get Doctors OnCall Schedules
    • Request OnCall Communication
    • Get Audit Event
  • User Resources
    • Create Doctor
    • Update Doctor
    • Delete Doctor
    • Create Patient
    • Update Patient
    • Delete Patient
    • Fetch Patient Historical Consultation
    • Fetch Patient Prescription Records
    • Create Document Reference