Overview

This document contains information on The API system provides a unified platform for managing providers, variables, files, blogs, and metadata with support for both standard REST and OData queries. It is categorized into several functional areas along with Webhook implementation information.

Authorization

This API requires a bearer token for authorization generating using Client Credentials flow . Ensure the generated token has necessary scopes to access the endpoint. Ensure you include the token in the authorization header in each request. The format for the header would need to be

Authorization: Bearer <your-token>

List of APIs

The following contains the list of APIs that are available client developers.

Metadata

API	Data	Endpoint
Metadata	Returns the OData metadata document, which describes the structure of the OData service. The metadata includes information about entity sets, schemas, relationships, functions, and annotations. This can be primarily used to understand the data model and generate queries dynamically.	GET /odata/$metadata Get Metadata Document
OData Service	Retrieves the OData service document, which provides an entry point into the OData service. This document lists available entity sets, singletons, and function imports, along with their metadata which allows clients to dynamically discover what resources and operations the service exposes.	GET /odata Get OData Service Document

Provider

API	Data	Endpoint
Providers	Retrieves a paginated list of healthcare providers with key details such as name, location, type, ownership, and ratings. Useful for browsing or searching provider directories.	GET /api/Provider/GetAllProviders/ {pageNumber}/{pageSize} Get Providers

Variable

API	Data	Endpoint
Variables	Retrieves a list of all system variables available in the application, including their IDs, names, keys, and types. Useful for configuration, mappings, or referencing predefined variables.	GET /api/Variable/GetAllVariables Get System Variables

Variable Data

API	Data	Endpoint
Variable Data	Fetches variable values for one or more providers based on specified provider numbers and variable keys. Allows querying targeted data rather than retrieving all variables at once.	POST /api/VariableData/ GetVariableData Get Variable Data
Variable Data by Radius	Retrieves variable data for a list of providers and additionally returns variable data for other providers within a specified radius of each base provider.	POST /api/VariableData/ GetVariableDatabyRadius Get Variable Data by Radius

Variable OData

API	Data	Endpoint
Variable OData	Retrieves variable data for providers in an OData-style format. Each record contains the provider details along with the variable name, value, and creation date. Allows querying targeted data rather than retrieving all variables at once.	GET /odata/VariableOData/GetOdata Get Variable by Provider
Variable OData Metadata	Returns the Variable OData metadata document, which describes the structure of the Variable OData.	GET /odata/VariableOData Get Variable Metadata
Variable OData Count	Returns the total number of records in the Variable OData entity set.	GET /odata/VariableOData/$count Get Variable OData Count

Webhook Outbound

An API endpoint must be provided to accept webhook POST requests and respond with a 200 OK status upon successful processing. Any other response codes will be considered failures, prompting a retry attempt. The payload would need to support the below sample.

{
    "EventType": "DISCHARGED",
    "EventDate": "2025-02-17",
    "FacilityId": 493,
    "PatientId": 5829546
}

Webhook Test

A test endpoint that takes in a Webhook outbound endpoint would be provided that would initiate a call back to the Outbound endpoint with the payload defined in the section above.