H1 APIs

https://ribbon.readme.io/v2.2/
Admin
H1 APIs provide healthcare enterprises with accurate data on doctors, insurance plans, and costs of...
Tokens:1,563
Snippets:6
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Query Insurance Plans API Example (cURL)

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

This cURL example shows how to query insurance plans through the H1 APIs platform. It includes parameters for state and plan type, along with necessary authorization and content type headers. This endpoint is useful for developing insurance comparison services.

```bash
# API Base URL (example - actual URL not documented)
API_BASE="https://api.h1.co/v2.2"

# Authentication (method not documented in extracted files)
# Likely requires API key or OAuth token

# Example: Query insurance plans (endpoint structure inferred)
curl -X GET "${API_BASE}/insurance-plans?state=CA&type=PPO" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

--------------------------------

### Get Cost of Care Data API Example (cURL)

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

This cURL command demonstrates how to retrieve cost of care data from the H1 APIs platform. It takes parameters such as procedure and zipcode, and requires authentication and content type headers. This is relevant for building cost transparency tools.

```bash
# API Base URL (example - actual URL not documented)
API_BASE="https://api.h1.co/v2.2"

# Authentication (method not documented in extracted files)
# Likely requires API key or OAuth token

# Example: Get cost of care data (endpoint structure inferred)
curl -X GET "${API_BASE}/costs?procedure=knee_replacement&zipcode=10001" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

--------------------------------

### Search Doctors API Example (cURL)

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

This example demonstrates how to search for doctors using the H1 APIs platform via cURL. It specifies query parameters for specialty and location, and includes authorization and content type headers. The expected response structure for doctor data is also outlined.

```bash
# API Base URL (example - actual URL not documented)
API_BASE="https://api.h1.co/v2.2"

# Authentication (method not documented in extracted files)
# Likely requires API key or OAuth token

# Example: Search for doctors (endpoint structure inferred)
curl -X GET "${API_BASE}/doctors?specialty=cardiology&location=New+York" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Expected response structure (not documented)
# {
#   "data": [
#     {
#       "id": "doc_123",
#       "name": "Dr. Jane Smith",
#       "specialty": "Cardiology",
#       "location": { "city": "New York", "state": "NY" },
#       "credentials": ["MD", "FACC"]
#     }
#   ],
#   "pagination": { "page": 1, "total": 150 }
# }
```

--------------------------------

### Get Cost of Care Data

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

Retrieves cost of care data for specific procedures and locations.

```APIDOC
## GET /costs

### Description
Fetches cost of care data for medical procedures in a given geographic area.

### Method
GET

### Endpoint
/costs

### Query Parameters
- **procedure** (string) - Optional - The medical procedure to get cost data for.
- **zipcode** (string) - Optional - The zipcode to search for cost data.

### Request Example
```json
{
  "example": "curl -X GET \"https://api.h1.co/v2.2/costs?procedure=knee_replacement&zipcode=10001\" \
  -H \"Authorization: Bearer YOUR_API_KEY\" \
  -H \"Content-Type: application/json\""
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of cost of care objects matching the query. (Schema not documented)

#### Response Example
```json
{
  "example": "(Response structure not documented)"
}
```
```

--------------------------------

### Query Insurance Plans

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

Allows querying for insurance plans based on state and type.

```APIDOC
## GET /insurance-plans

### Description
Retrieves a list of insurance plans based on specified filters.

### Method
GET

### Endpoint
/insurance-plans

### Query Parameters
- **state** (string) - Optional - The state to filter insurance plans by.
- **type** (string) - Optional - The type of insurance plan (e.g., PPO, HMO) to filter by.

### Request Example
```json
{
  "example": "curl -X GET \"https://api.h1.co/v2.2/insurance-plans?state=CA&type=PPO\" \
  -H \"Authorization: Bearer YOUR_API_KEY\" \
  -H \"Content-Type: application/json\""
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of insurance plan objects matching the query. (Schema not documented)

#### Response Example
```json
{
  "example": "(Response structure not documented)"
}
```
```

--------------------------------

### Search for Doctors

Source: https://context7.com/context7/ribbon_readme_io_v2_2/llms.txt

Allows searching for doctors based on specialty and location.

```APIDOC
## GET /doctors

### Description
Searches for doctors based on specified criteria like specialty and location.

### Method
GET

### Endpoint
/doctors

### Query Parameters
- **specialty** (string) - Optional - The medical specialty to filter by.
- **location** (string) - Optional - The location to filter doctors by.

### Request Example
```json
{
  "example": "curl -X GET \"https://api.h1.co/v2.2/doctors?specialty=cardiology&location=New+York\" \
  -H \"Authorization: Bearer YOUR_API_KEY\" \
  -H \"Content-Type: application/json\""
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of doctor objects matching the query.
  - **id** (string) - Unique identifier for the doctor.
  - **name** (string) - The doctor's full name.
  - **specialty** (string) - The doctor's medical specialty.
  - **location** (object) - The doctor's location details.
    - **city** (string) - The city of the doctor's practice.
    - **state** (string) - The state of the doctor's practice.
  - **credentials** (array) - A list of the doctor's professional credentials.
- **pagination** (object) - Pagination details for the results.
  - **page** (integer) - The current page number.
  - **total** (integer) - The total number of results available.

#### Response Example
```json
{
  "example": "{\n  \"data\": [\n    {\n      \"id\": \"doc_123\",\n      \"name\": \"Dr. Jane Smith\",\n      \"specialty\": \"Cardiology\",\n      \"location\": { \"city\": \"New York\", \"state\": \"NY\" },\n      \"credentials\": [\"MD\", \"FACC\"]\n    }\n  ],\n  \"pagination\": { \"page\": 1, \"total\": 150 }\n}"
}
```
```
Tokens:
Raw