{ "info": { "_postman_id": "e8747531-0084-4ae6-8f64-66778493a499", "name": "OCHCA-Provider-Directory-API", "description": "This collections contains the endpoints that are used to retrieve the data from ProviderDirectory Database", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "11940041" }, "item": [ { "name": "Lookup", "item": [ { "name": "Specialities", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/specialties", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "specialties" ] }, "description": "---\n\n### Retrieve Specialties\n\n#### Endpoint\n\n`GET /api/v1/Lookup/specialties`\n\n#### Headers\n\n- `Accept`: `application/json`\n \n\n#### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/specialties\nAccept: application/json\n\n ```\n\n#### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `code` | String | The unique code for the specialty. |\n| `description` | String | The name of the specialty. |\n| `enabled` | String | Indicates if the specialty is active. |\n| `ordinal` | Integer | Order of priority or ranking. |\n\n---" }, "response": [] }, { "name": "Schedule Codes", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/schedule-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "schedule-codes" ] }, "description": "---\n\n## Retrieve Schedule Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/schedule-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/schedule-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | The unique schedule code. |\n| `ordinal` | Integer | Ordering or ranking of the schedule. |\n| `description` | String | A short description of the schedule. |\n| `enabled` | String | Indicates if the schedule is active (`Y`/`N`). |\n\n---\n\n## Notes\n\n- **Authentication**: Not required for this API.\n \n- **Formats**: Use the `Accept` header to specify `application/json`.\n \n- **Null Values**: Some fields (e.g., `ordinal2` and `days`) may be null.\n \n\n---" }, "response": [] }, { "name": "Facility Types", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/facility-types", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "facility-types" ] }, "description": "---\n\n## Retrieve Facility Types\n\n### Endpoint\n\n`GET /api/v1/Lookup/facility-types`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/facility-types\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Facility code identifying the type. |\n| `ordinal` | Integer | Ordering or ranking of the facility type. |\n| `description` | String | Short description of the facility type. |\n| `description2` | String | Detailed description, providing additional context or examples. |\n| `enabled` | String | Indicates if the facility type is active (`Y` for Yes, `N` for No). |\n\n---\n\n## Notes\n\n- **Authentication**: No authentication is required to call this API.\n \n- **Formats**: Use the `Accept` header to indicate whether you want JSON (`application/json`).\n \n- **Handling Details**: Optional fields like `description2` may contain additional examples or explanations. Ensure your application handles these appropriately.\n \n- **Response Structure**: The response contains a list of facility types, each with its unique `code`, description, and metadata.\n \n\n---" }, "response": [] }, { "name": "Service Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/service-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "service-codes" ] }, "description": "---\n\n## Retrieve Service Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/service-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/service-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code representing the service. |\n| `ordinal` | Integer | Ordering or ranking of the service. |\n| `description` | String | Short description of the service. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n| `enabled` | String | Indicates if the service is active (`Y` for Yes, `N` for No). |\n\n---\n\n## Notes\n\n- **Authentication**: No authentication is required for this API.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Availability**: The `enabled` field specifies whether a service is currently active (`Y`) or inactive (`N`).\n \n\n---" }, "response": [] }, { "name": "Population Served Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/population-served-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "population-served-codes" ] }, "description": "## Retrieve Population Served Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/population-served-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/population-served-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code representing the population type served. |\n| `ordinal` | Integer | Ordering or ranking of the population served. |\n| `description` | String | Short description of the population served. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n| `enabled` | String | Indicates if the population type is active (`Y` for Yes, `N` for No). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to retrieve responses in JSON (`application/json`).\n \n- **Active Status**: The `enabled` field indicates whether the population type is currently in use (`Y`) or not (`N`)." }, "response": [] }, { "name": "Licensure Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/licensure-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "licensure-codes" ] }, "description": "## Retrieve Licensure Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/licensure-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/licensure-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code representing the licensure type. |\n| `ordinal` | Integer | Ordering or ranking of the licensure type. |\n| `description` | String | Short description of the licensure type or qualification. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n| `enabled` | String | Indicates if the licensure type is active (`Y` for Yes, `N` for No). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Active Status**: The `enabled` field indicates whether the licensure type is currently in use (`Y`) or not (`N`)." }, "response": [] }, { "name": "State Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/state-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "state-codes" ] }, "description": "## Retrieve State Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/state-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/state-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code representing the state abbreviation. |\n| `ordinal` | Integer | Ordering or ranking of the state. |\n| `description` | String | Full name of the state. |\n| `description2` | String | State capital city. |\n| `enabled` | String | Indicates if the state code is active (`Y` for Yes, `N` for No). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Active Status**: The `enabled` field indicates whether the state code is currently in use (`Y`) or not (`N`).\n \n\n### Example Use Case\n\nThe state codes can be used to populate dropdown menus or to retrieve state-based data for further functionality." }, "response": [] }, { "name": "Gender Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/gender-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "gender-codes" ] }, "description": "## Retrieve Gender Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/gender-codes`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/gender-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code representing the gender. |\n| `ordinal` | Integer | Ordering or ranking of the genders. |\n| `description` | String | Short description of the gender identity. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n| `enabled` | String | Indicates if the gender code is active (`Y` for Yes, `N` for No). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Active Status**: The `enabled` field indicates whether the gender code is currently in use (`Y`) or not (`N`).\n \n\n### Example Use Case\n\nThe gender codes can be used for demographic data collection, reporting, or filtering user-specific records." }, "response": [] }, { "name": "Taxonomy Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/taxonomy", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "taxonomy" ] }, "description": "## Retrieve Taxonomy Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/taxonomy`\n\n### Headers\n\n- `Accept`: `application/json`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/taxonomy\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code for the taxonomy type. |\n| `description` | String | Short description of the taxonomy type. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Taxonomy Purpose**: These codes correspond to healthcare provider specialties and types of services offered.\n \n\n### Example Use Case\n\nThe taxonomy codes can be used:\n\n- To classify healthcare providers by specialty or type.\n \n- As part of the process for creating or filtering provider profiles.\n \n- Serve as the dropdown in search feature" }, "response": [] }, { "name": "Language Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/language-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "language-codes" ] }, "description": "This endpoint makes an HTTP GET request to retrieve language codes from the specified API version. The purpose of this request is to fetch a list of language codes along with their corresponding details.\n\n### Request\n\nThe request is sent to the following URL:\n\n```\nhttps://{{app_domain}}/api/v{{version_num}}/Lookup/language-codes\n\n ```\n\n### Response\n\nUpon a successful execution, the server responds with a status code of 200 and a JSON array containing language code objects. Each language code object includes the following properties:\n\n- `vers` (version number)\n \n- `code` (language code)\n \n- `description` (description of the language)\n \n- `description2` (additional description, if available)" }, "response": [] }, { "name": "Cultural Capability Codes", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/cultural-cap-codes", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "cultural-cap-codes" ] }, "description": "## Retrieve Cultural Capability Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/cultural-cap-codes`\n\n### Headers\n\n- `Accept`: `application/json` or `application/xml`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/cultural-cap-codes\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code for the cultural capability. |\n| `ordinal` | Integer | Ordering or ranking of the cultural capability. |\n| `description` | String | Short description of the cultural capacity. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n| `enabled` | String | Indicates whether the cultural capability code is active (`Y` for Yes, `N` for No). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Usage**: These codes are used for identifying cultural capabilities and special considerations for individuals or groups.\n \n\n### Example Use Cases\n\n- Populate a dropdown or filter for cultural focus/specialization in a provider directory.\n \n- Support data collection systems to categorize or identify culturally specific needs and preferences." }, "response": [] }, { "name": "Telehealth", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Lookup/telehealths", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Lookup", "telehealths" ] }, "description": "## Retrieve TeleHealth Codes\n\n### Endpoint\n\n`GET /api/v1/Lookup/telehealths`\n\n### Headers\n\n- `Accept`: `application/json` or `application/xml`\n \n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Lookup/telehealths\nAccept: application/json\n\n ```\n\n### Key Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `vers` | Integer | Version of the record. |\n| `code` | String | Unique code for the TeleHealth service type. |\n| `description` | String | Description of the TeleHealth availability. |\n| `description2` | String | Detailed or alternate description (may be `null`). |\n\n## Notes\n\n- **Authentication**: This API does not require authentication.\n \n- **Formats**: Use the `Accept` header to specify response format (`application/json`).\n \n- **Usage**: The TeleHealth codes define availability and types of services provided (e.g., only TeleHealth, in-person, or both).\n \n\n### Code Descriptions\n\n| Code | Description |\n| --- | --- |\n| `N` | Does not provide TeleHealth services. |\n| `B` | Services both in-person and TeleHealth. |\n| `O` | Services only through TeleHealth. |\n\n### Example Use Cases\n\n- Identify TeleHealth availability for a healthcare provider.\n \n- Use codes to filter or categorize providers who offer TeleHealth versus in-person services." }, "response": [] } ], "description": "The endpoints in Lookup are used to populate all data for the dropdowns on UI and any related data for search feature in Provider Directory website.\n\nThe APIs in this URL collection do not require authorized token." }, { "name": "Provider", "item": [ { "name": "All Providers", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Provider/providers?page=1&pageSize=10", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Provider", "providers" ], "query": [ { "key": "page", "value": "1", "description": "Specifies the page number of the results to retrieve. It is used for pagination. If not provided, the default is set to `1`.\n" }, { "key": "pageSize", "value": "10", "description": "Defines the number of items to display on each page of the results. Used to limit the dataset returned for each page. Defaults to `10` if not specified. Maximum value is `100`.\n" } ] }, "description": "## Retrieve All Providers\n\n### Endpoint\n\n`GET /api/v1/Provider/providers`\n\nOr\n\n`GET /api/v1/Provider/providers?page=1&pageSize=10`\n\n### Description\n\nThis endpoint retrieves a list of all providers along with detailed provider and practice site information. This api supports pagination to retrieve the records from database. There are two query params: `Page` and `PageSize`. By default, the `PageSize` is set to 10. The maximum value that can be set for `PageSize` is 100.\n\n### Authentication\n\nThis API requires an **authentication token**. Authenticate using the `/api/Authentication/authenticate` endpoint to obtain a token and include it in the `Authorization` header with the prefix `Bearer`.\n\n#### Example Authentication Request\n\n`POST /api/Authentication/authenticate`\n\nBody:\n\n``` json\n{\n \"UserId\": \"{{client_id}}\",\n \"Password\": \"{{client_pwd}}\"\n}\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Example Request\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Provider/providers\nAccept: application/json\nContent-Type: application/json\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5c...\n\n ```\n\n---\n\n### Explanation of Provider Object\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | Integer | The unique ID of the provider. |\n| `lastName` | String | Provider's last name (e.g., \"Julieanna\", \"Gonzalez\"). |\n| `firstName` | String | Provider's first name (e.g., \"Julieanna\", \"Andrea\"). |\n| `middleName` | String | Provider's middle name (if available). |\n| `gender` | String | Provider's gender (`M` for Male, `F` for Female). |\n| `doB` | Date | Date of birth of the provider (YYYY-MM-DD). |\n| `email` | String | Provider's email address. |\n| `npi` | String | Provider's National Provider Identifier (NPI). |\n| `taxonomy` | String | Provider's taxonomy classification. |\n| `engFluency` | String | Indicates English fluency (`Y` for Yes, `N` for No). |\n| `culturalTraining` | String | Indicates if the provider has cultural training. |\n| `medicarePd` | String | Indicates whether the provider accepts Medicare insurance. |\n| `chipPd` | String | Indicates whether the provider accepts CHIP (Children's Health Insurance Program). |\n| `tgitrainingPd` | String | Indicates whether the provider has TGI training. |\n| `populationServedPd` | String | Codes for populations served (e.g., `CYS`, `PER`). |\n| `specialtiesPd` | String | Specialty codes defining the provider's specializations. |\n| `providerLanguages` | Array | Languages spoken by the provider with fluency ratings. |\n| `providerSites` | Array | A list of the provider's practice sites, including site details. |\n\n---\n\n### Explanation of Provider Site Object\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | Integer | Unique ID of the provider's affiliation with a site. |\n| `isPrimary` | Boolean | Indicates whether this is the primary site for the provider. |\n| `site.name` | String | Name of the site (e.g., \"CYS Seneca OC South\", \"AMHS Telecare TAO\"). |\n| `site.address` | String | Physical address of the site. |\n| `site.city` | String | City where the site is located. |\n| `site.state` | String | State where the site is located. |\n| `site.zipCode` | String | ZIP Code of the site address. |\n| `site.phone` | String | Phone number for the site. |\n| `site.webSite` | String | Website URL for the site. |\n| `site.telehealthAvail` | String | Indicates telehealth availability (`Y`, `N`, `B`). |\n\n---\n\n### Example Use Cases\n\n1. **Retrieve All Providers with Basic Details**:\n \n - Fetch a list of all providers including general details like name, gender, and email.\n \n - Include information about primary sites and telehealth availability.\n \n2. **Languages and Cultural Details**:\n \n - Check providers’ language fluency levels (e.g., Spanish fluency for Andrea Gonzalez).\n \n - Confirm cultural training/capabilities for providers.\n \n3. **Specialized Filters**:\n \n - Analyze providers' affiliations and check site details like ADA compliance and telehealth capabilities.\n \n\n---\n\n### Notes\n\n- **Authentication**: Use a Bearer token obtained from the authentication endpoint.\n \n- Providers are associated with one or more practice sites.\n \n- Each site has detailed metadata such as location, services, telehealth options, and more.\n \n- Use Lookup collection endpoints to understand the codes." }, "response": [] }, { "name": "Provider by Id", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Provider/10", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Provider", "10" ] }, "description": "## Retrieve Provider Details by ID\n\n### Endpoint\n\n`GET /api/v1/Provider/{id}`\n\n### Authentication\n\nThis API requires an **authentication token**. Authenticate using the `/api/Authentication/authenticate` endpoint to obtain a token and include it in the `Authorization` header with the prefix `Bearer`.\n\n#### Example Authentication Request\n\n`POST /api/Authentication/authenticate`\n\nBody:\n\n``` json\n{\n \"UserId\": \"{{client_id}}\",\n \"Password\": \"{{client_pwd}}\"\n}\n\n ```\n\n---\n\n### Example Request for Provider Details\n\n`GET /api/v1/Provider/10`\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Key Fields\n\n#### Provider Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID of the provider (e.g., 10). |\n| `lastName` | Provider's last name (e.g., Gonzalez). |\n| `firstName` | Provider's first name (e.g., Andrea). |\n| `doB` | Provider's date of birth (e.g., 1992-09-17). |\n| `email` | Email address of the provider. |\n| `npi` | National Provider Identifier (e.g., 1285300319). |\n| `taxonomy` | Provider's taxonomy code (e.g., 101Y00000X). |\n| `engFluency` | Indicates if the provider is fluent in English (`Y` for Yes, `N` for No). |\n| `medicarePd` | Whether the provider accepts Medicare insurance (e.g., `N` for No). |\n| `chipPd` | Whether the provider accepts CHIP (Children's Health Insurance Program) insurance. |\n| `populationServedPd` | Codes for populations served (e.g., `CYS`, `PER`). |\n| `specialtiesPd` | Specialty codes defining the provider's specializations. |\n| `culturalCapabilitiesPd` | Codes for cultural capabilities. |\n\n#### Provider Language Object\n\n| Field | Description |\n| --- | --- |\n| `code` | The language code (e.g., `spa` for Spanish). |\n| `fluency` | Fluency level (e.g., `B` for Basic). |\n\n#### Provider Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID of the provider's site relationship. |\n| `siteId` | ID of the site where the provider practices. |\n| `licenseNumber` | License number for the provider (e.g., APCC13352). |\n| `telehealthFlag` | Indicates telehealth availability (`B`, `Y`, `N`). |\n| `fieldSrvcFlag` | Indicates field service availability (`Y` for Yes, `N` for No). |\n| `acceptNew` | Indicates whether new patients are accepted (`Y` for Yes). |\n| `site.name` | Name of the site (e.g., \"CYS Seneca OC South\"). |\n| `site.address` | Address of the site (e.g., 22942 El Toro Rd., Lake Forest). |\n| `site.telehealthAvail` | Telehealth availability options. |\n| `site.serviceType` | Codes for the kinds of services the site provides. |\n| `site.ageGrpServed` | Age groups served (e.g., `C` for Children). |\n\n---\n\n### Example Use Cases\n\n1. **Retrieve Specific Provider Information**:\n \n - Request detailed information about \"Andrea Gonzalez\" using their unique Provider ID (10).\n \n - Understand whether this provider accepts new patients and CHIP insurance.\n \n2. **Access Practice Site Details**:\n \n - Identify the CYS program site (\"CYS Seneca OC South\") and its telehealth services and contact details.\n \n3. **Language Services**:\n \n - Check if the provider speaks other languages (e.g., `spa` - Spanish).\n \n\n---\n\n### Notes\n\n- Authentication tokens must be refreshed periodically.\n \n- Replace `{id}` in the endpoint with the desired provider's unique ID.\n \n- Use the Lookup endoints to get the codes for service types, population served, etc." }, "response": [] }, { "name": "Provider Search", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Provider/search?FirstName=&LastName=&Gender=&Language=&CulturalCapabilityTraining=&Speciality=&ProviderType=&Telehealth=&AcceptNewPatient=&CulturalCapability=&Medicare=&CHIP=&TGITraining=", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Provider", "search" ], "query": [ { "key": "FirstName", "value": "", "description": "Filter by provider's first name." }, { "key": "LastName", "value": "", "description": "Filter by provider's last name." }, { "key": "Gender", "value": "", "description": "Gender of the provider. Valid Values (AG=Another Gender Identity,F=Female,FTM=Transgender Female to Male,GQ=Genderqueer,M=Male,MTF=Transgender Male to Female,U=Undisclosed)" }, { "key": "Language", "value": "", "description": "Language code to filter for providers who speak the given language. Valid Values ((aar=Afar,amh=Amharic,ara=Arabic,ase=American Sign Language (ASL),cmn=Mandarin,deu=German,ell=Greek,eng=English,fas=Farsi,fil=Filipino,fra=French,guj=Gujarati,hat=Haitian Creole,heb=Hebrew,hin=Hindi,hmm=Hmong,hye=Armenian,ita=Italian,jpn=Japanese,kan=Kannada,khm=Cambodian,kik=Gikuyu,kor=Korean,lao=Laotian,mar=Marathi,nld=Flemish,nor=Norwegian,orm=Oromo,pan=Punjabi,pol=Polish,por=Portuguese,rus=Russian,sin=Sinhala,spa=Spanish,swe=Swedish,tel=Telugu,tgl=Tagalog,tha=Thai,tur=Turkish,urd=Urdu,vie=Vietnamese,yue=Cantonese,zho=Other Chinese)" }, { "key": "CulturalCapabilityTraining", "value": "", "description": "\"Y\" (Yes) or \"N\" (No)" }, { "key": "Speciality", "value": "", "description": "Filter by provider's specialty code. Valid Values (1A=Adoptive Clinical Training (ACT),1B=Aging Issues,1C=Anger Management,1D=CADTP Certified Counselors,1E=CCAPP Certified Counselors,1F=CAADE Certified Counselors,1G=Family Therapy,1H=Individual Therapy,1I=Educational Related Mental Health Services (ERMHS),1J=Juvenile Justice,1K=Medication Education and Support,1L=Mental Health Rehab Specialist (MHRS)/Mental Health Specialist (MHS))" }, { "key": "ProviderType", "value": "", "description": "Provider's Taxonomy Code" }, { "key": "Telehealth", "value": "", "description": "Valid Values (B=Services both in-person and TeleHealth,N=Does not provide TeleHealth services,O=Services only through TeleHealth)" }, { "key": "AcceptNewPatient", "value": "", "description": "\"Y\" (Yes) or \"N\" (No)" }, { "key": "CulturalCapability", "value": "", "description": "Filter for providers with cultural training. Valid Values (A1=Adoptees,A2=Adults,A3=African American,A4=Aging,A5=Asian/Pacific Islander,B1=Bicultural/Multicultural issues,C1=Chicano American,C2=Children and Adolescents,C3=Children and Youth,C4=Co-Occurring Disorders,D1=Dual Diagnosis,E1=European-American,F1=Family Systems,F2=Foster Home Youth,G1=Gangs,G2=Geriatric Issues,G3=Group Home Youth,H1=Hearing Impaired,H2=HIV/AIDS,I1=Iranian,J1=Justice Involved,K1=Korean,L1=Latino/Latina/LatinX,L2=Law Enforcement,L3=LGBTQ+,M1=Middle Eastern,M2=Military Culture,M3=Multicultural,M4=Multilingual,M5=Multiracial,N1=Native American,O1=Older Adults,P1=Pacific Asian,P2=Perinatal,P3=Physically Disabled,R1=Refugee,S1=Serious Emotional Disturbance (SED) of a Child ,T1=Teens,T2=Transitional Aged Youth (TAY),V1=Veterans,V2=Victims of Abuse,V3=Vietnamese,V4=Visually Impaired)" }, { "key": "Medicare", "value": "", "description": "\"Y\" (Yes) or \"N\" (No). Indicate if the provider has medicare training and support." }, { "key": "CHIP", "value": "", "description": "\"Y\" (Yes) or \"N\" (No). Indicate if the provider has CHIP training. CHIP = Children's Health Insurance Program" }, { "key": "TGITraining", "value": "", "description": "\"Y\" (Yes) or \"N\" (No). Indicate if the provider has TGI training. TGI = Transgender, Gender Diverse, or Intersex" } ] }, "description": "## Search for Providers\n\n### Endpoint\n\n`GET /api/v1/Provider/search`\n\n### Description\n\nSearch for providers based on various filters such as first name, last name, gender, language proficiency, telehealth availability, or specialties. The API returns providers meeting the specified criteria, along with details on associated sites and other information.\n\n---\n\n### Example Query\n\nSearch for providers with the last name **Khan**:\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Provider/search?FirstName=&LastName=Khan&Gender=&Language=&CulturalCapabilityTraining=&Speciality=&ProviderType=&Telehealth=&AcceptNewPatient=&CulturalCapability=&Medicare=&CHIP=&TGITraining=\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Key Fields\n\n#### Provider Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID for the provider. |\n| `lastName` | Last name of the provider. |\n| `firstName` | First name of the provider. |\n| `gender` | Gender of provider (`M` for Male, `F` for Female). |\n| `doB` | Date of birth of the provider in `YYYY-MM-DD` format. |\n| `email` | Email contact of the provider. |\n| `npi` | National Provider Identifier (NPI). |\n| `taxonomy` | The specialty or taxonomy code of the provider (e.g., `1041C0700X`). |\n| `engFluency` | Indicates if the provider is fluent in English (`Y` for Yes). |\n| `medicarePd` | Whether the provider accepts Medicare (`Y` for Yes, `N` for No). |\n| `chipPd` | Whether the provider accepts CHIP coverage (`Y` for Yes, `N` for No). |\n| `tgitrainingPd` | Indicates if the provider has received TGI training (`Y` for Yes). |\n| `populationServedPd` | Codes for populations served (e.g., CYS, PER, etc.). Use Lookup endpoints to get more information. |\n| `specialtiesPd` | Codes for provider's specialties (e.g., 1A,1B, etc.). Use Lookup endpoints to get more information. |\n| `providerLanguages` | List of languages spoken by the provider including fluency levels (e.g., `spa`, `tgl`). |\n| `providerSites` | Associated sites where the provider practices. |\n\n#### Provider Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID in ProviderSite table. ProviderSite is the relationship table used to hold the many-to-many relationship between `Provider` and `Site` table. |\n| `providerId` | ID linking the provider. |\n| `siteId` | ID linking the site. |\n| `deanumber` | Provider DEA Number |\n| `effDate` | Provider's contract effective date |\n| `expDate` | Provider's contract expireation date |\n| `profitStatus` | A code denoting the profit status of the provider. (01 = 501(C)(3) Non-profit, 02 = For profit – closely held, 03 = For profit, publicly traded, 04 = Other, 88 = Not applicable – the individual only practices as part of a group, 99 – Unknown) (unused/ignore) |\n| `endDate` | Not being used. |\n| `licenseNumber` | Provider’s California practitioner license or certificate number |\n| `licenseType` | Type of Licensure |\n| `licenseState` | License State |\n| `licenseExpire` | License Expiration date |\n| `boardCertType` | Type of Board Certification. Not being used on Provider Directory website. |\n| `mhpFocus` | Mental Health Provider Practice Focus. Not used in Provider Directory website |\n| `mhpaoE` | Mental Health Provider Area of Expertise. Not used in Provider Directory website |\n| `serviceType` | Service Types that Provider provide |\n| `modality` | Modality Type for DMC-ODS provider. Not used in Provider Directory website |\n| `fteservingC` | Full-Time Equivalent – Serving Children. Not used in Provider Directory website. |\n| `fteservingA` | Full-Time Equivalent – Serving Adult. Not used in Provider Directory website. |\n| `mccurrLoadC` | Maximum Number of Medi-Cal Members this Provider will Accept-Children. (unused/ignore) |\n| `mccurrLoadA` | Maximum Number of Medi-Cal Members this Provider will Accept-Adults. (unused/ignore) |\n| `telehealthFlag` | Indicate whether provider provides telehealth. |\n| `fieldSrvcFlag` | Indicate whether provider provides field-based service. |\n| `fieldSrvcDist` | Field-based service distance. |\n| `acceptNew` | Indicate whether provider is accepting new patients. |\n| `acceptChildren` | Indicate whether provider can accept children patients. |\n| `validFlag` | This field is for backend logic of 274 Final rule. Indicate whether the record is validated. |\n| `isPrimary` | Indicate whether the information is for the primary site. |\n| `site.name` | Name of the practice site (e.g., \"CYS Seneca OC South\"). |\n| `site.npi2` | Facility NPI |\n| `site.address` | Physical address of the site. |\n| `site.city` | City where the site is located. |\n| `site.state` | State where the site is located. |\n| `site.phone` | Phone number of the site. |\n| `site.webSite` | Website URL of the site for further details. |\n| `site.telehealthAvail` | Details about telehealth availability (`Y` for Yes, `N` for No, `B` for Both in-person/telehealth). |\n| `site.ageGrpServed` | Age groups served by the site (e.g., `C` for Children). |\n| `site.serviceType` | Services offered at the site (e.g., `IC`, `MH`, etc.). |\n| `site.adaCompliant` | Indicate whether the site is handicapped accessible (ADA Compliant). |\n| `site.tddTtyAvail` | Indicate whether TDD/TTY Equipment is available at the site. |\n| `providerDto` | This is a Data Transfer Object that is being used in some logic in the frontend UI. It contains the same information as the provider's information at the top level of the JSON response body. |\n\n---\n\n### Example Use Cases\n\n1. **Find a Provider with Specific Qualifications**:\n \n - Example: Search for providers fluent in Spanish and with TGI training, who also accept CHIP and Medicare.\n \n2. **Provider's Associated Sites**:\n \n - Retrieve information about all practice sites for a provider, including ADA compliance and contact details.\n \n3. **Target Specific Subsets**:\n \n - Fetch only providers of a certain specialty or taxonomy, such as Clinical Social Workers (`1041C0700X`).\n \n\n---\n\n### Notes\n\n- Authentication is required for API requests.\n \n- Replace query parameters with appropriate values to filter results as needed.\n \n- Use the Lookup endpoints to get the code for certain query params." }, "response": [] }, { "name": "Provider Languages", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Provider/provider-languages", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Provider", "provider-languages" ] }, "description": "## Get Provider Languages\n\n### Endpoint\n\n`GET /api/v1/Provider/provider-languages`\n\n### Description\n\nRetrieve the list of providers and their respective spoken languages, fluency levels, and validity of the language data.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Provider/provider-languages\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n| Field | Description |\n| --- | --- |\n| `providerId` | The unique identifier of the provider. |\n| `code` | Language code representing the language spoken by the provider (e.g., `spa` for Spanish, `rus` for Russian). |\n| `fluency` | Fluency level of the language (`B` for Bilingual, etc.). |\n| `validFlag` | Indicator if the language data for this provider is valid (`Y` for Yes). |\n| `hash` | Unique identifier for the language record, used for verification purposes. |\n| `dbInsertDt` | Timestamp of when the entry was created in the database. |\n| `dbUpdateDt` | Timestamp of the most recent update to the entry in the database. |\n| `provider` | Contains provider details (null in this response). |\n\n---\n\n### Example Use Cases\n\n1. **Retrieve Available Languages for Providers**:\n \n - E.g., A client application needs a list of all providers who speak Spanish.\n \n2. **Filter Providers by Language Fluency**:\n \n - Only providers with `fluency` matching `B` or `N`.\n \n\n---\n\n### Notes\n\n- Authentication is required to access this endpoint.\n \n- Replace the query parameters in the URL as needed to filter results." }, "response": [] } ], "description": "This folder contains the endpoints related to the Provider table. Some endpoints require the search query paramaters on the URL. To get the information, please use the lookup endpoints to find the information that you need to query." }, { "name": "Site", "item": [ { "name": "All Sites", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/sites?page=1&pagesize=10", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "sites" ], "query": [ { "key": "page", "value": "1", "description": "Specifies the page number of the results to retrieve. It is used for pagination. If not provided, the default is set to `1`.\n" }, { "key": "pagesize", "value": "10", "description": "Defines the number of items to display on each page of the results. Used to limit the dataset returned for each page. Defaults to `10` if not specified. Maximum value is `100`.\n" } ] }, "description": "## Get Sites\n\n### Endpoint\n\n`GET /api/v1/Site/sites`\n\nOr\n\n`GET /api/v1/Site/sites?page=1&pagesize=10`\n\n### Description\n\nRetrieve a list of sites and associated information such as site address, provider affiliation, services offered, telehealth availability, and more.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Site/sites\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n#### Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID for the site. |\n| `planType` | Plan type of the site (e.g., `MHP` for Mental Health Plan). |\n| `name` | Name of the site. |\n| `address` | Address of the site. |\n| `city` | City where the site is located. |\n| `state` | State where the site is located. |\n| `zipCode` | The ZIP code for the site location. |\n| `webSite` | Website URL for the site. |\n| `facilityId` | Facility ID for the site. |\n| `adacompliant` | Whether the site is ADA-compliant (`Y` for Yes, `N` for No). |\n| `telehealthAvail` | Availability of telehealth services (`B` for Both, `Y` for Yes, `N` for No). |\n| `languageLineAvail` | Indicates whether a language line is available. |\n| `mcbmaximum` | Maximum client base the site can handle. |\n| `mcbcurrent` | Current client base the site has. |\n| `ageGrpServed` | Age group served by the site (e.g., `A` for Adults). |\n| `serviceType` | Types of services provided at the site (e.g., `CIS`, `MHS`, etc.). |\n\n#### Provider Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | ID linking the provider to the site. |\n| `providerDto` | Details about providers at the site, including name, gender, taxonomy, and NPI. |\n\n#### Provider Language Object (inside `providerDto`)\n\n| Field | Description |\n| --- | --- |\n| `providerId` | Unique ID of the provider. |\n| `code` | Language code of the language spoken (e.g., `spa` for Spanish). |\n| `fluency` | Fluency level of the provider (`B` for Bilingual). |\n| `validFlag` | Indicates if the language data is valid (`Y` for Yes). |\n\n---\n\n### Example Use Cases\n\n1. **Retrieve General Site Data**:\n \n - Retrieve details about all sites including location, telehealth services, and service types provided.\n \n2. **Find Providers at a Site**:\n \n - Identify all the providers at a specific site and their associated languages.\n \n\n---\n\n### Notes\n\n- Authentication is required to access the data.\n \n- Replace query parameters in the API URL as needed to refine results." }, "response": [] }, { "name": "Site By Id", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/1", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "1" ] }, "description": "## Get Site Details by ID\n\n### Endpoint\n\n`GET /api/v1/Site/{id}`\n\n### Description\n\nRetrieve detailed information about a specific site by its unique ID. Includes site details, associated providers, schedules, and program descriptions.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Site/1\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n#### Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique ID for the site. |\n| `planType` | Plan type of the site (e.g., `MHP` for Mental Health Plan). |\n| `name` | Name of the site. |\n| `address` | Address of the site. |\n| `city` | City where the site is located. |\n| `state` | State where the site is located. |\n| `zipCode` | The ZIP code for the site location. |\n| `phone` | Phone number of the site for contact purposes. |\n| `webSite` | Website URL for the site. |\n| `adacompliant` | Whether the site is ADA-compliant (`Y` for Yes, `N` for No). |\n| `telehealthAvail` | Availability of telehealth services (`B` for Both, `Y` for Yes, `N` for No). |\n| `serviceType` | Types of services provided at the site (e.g., `CIS`, `MHS`, etc.). |\n| `mcbmaximum` | Maximum client base the site can handle. |\n| `mcbcurrent` | Current client base the site has. |\n\n#### Provider Site Object\n\n| Field | Description |\n| --- | --- |\n| `providerId` | Unique ID linking the provider to the site. |\n| `licenseNumber` | Provider's license number. |\n| `licenseType` | License type held by the provider (e.g., `CSW`, `MFT`, etc.). |\n| `serviceType` | Services offered by the provider (e.g., `MH`, `TC`, etc.). |\n| `fteservingC` | Full-time employee resource allocation for Children. |\n| `fteservingA` | Full-time employee resource allocation for Adults. |\n| `mccurrLoadC` | Current maximum load for Children. |\n| `mccurrLoadA` | Current maximum load for Adults. |\n| `mcmaxLoadC` | Allowed maximum load for Children. |\n| `mcmaxLoadA` | Allowed maximum load for Adults. |\n| `telehealthFlag` | Indicates telehealth availability (`B` for Both, `Y` for Yes). |\n| `affliation` | Provider's affiliation with the clinic or organization. |\n\n#### Site Schedule Object\n\n| Field | Description |\n| --- | --- |\n| `code` | Schedule code identifying the category. |\n| `timeOpen` | Daily opening time of the site. |\n| `timeClose` | Daily closing time of the site. |\n| `validFlag` | Indicates if the schedule entry is valid (`Y` for Yes). |\n\n#### Program Description\n\nProvides an overview of the site's purpose, processes, and key functions.\n\n---\n\n### Example Use Cases\n\n1. **Retrieve Complete Site Details**:\n \n - Includes location, services, telehealth availability, providers, schedule, and program descriptions.\n \n2. **Site Schedules**:\n \n - Check opening and closing times for a specific site.\n \n\n---\n\n### Notes\n\n- Authentication is required to access this endpoint.\n \n- Replace the `{id}` parameter in the URL with the site's ID to fetch specific details." }, "response": [] }, { "name": "Search Site", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/search?SiteName=1&ZipCode=&Address=&Address2=&City=&State=&WithinDistance=&ProgramType=&IsAdaCompliant=&IsTddTtyAvail=", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "search" ], "query": [ { "key": "SiteName", "value": "1", "description": "Partial or full name of the site to search for\n" }, { "key": "ZipCode", "value": "", "description": "ZIP code to filter results by a specific area.\n" }, { "key": "Address", "value": "", "description": "Address of the site. This includes the street name, street number, etc." }, { "key": "Address2", "value": "", "description": "Additional address details (e.g., suite or unit number).\n" }, { "key": "City", "value": "", "description": "City where the site is located.\n" }, { "key": "State", "value": "", "description": "State where the site is located.\n 2 characters code (AK=Alaska,AL=Alabama,AR=Arkansas,AZ=Arizona,CA=California,CO=Colorado,CT=Connecticut,DE=Delaware,FL=Florida,GA=Georgia,HI=Hawaii,IA=Iowa,ID=Idaho,IL=Illinois,IN=Indiana,KS=Kansas,KY=Kentucky,LA=Louisiana,MA=Massachusetts,MD=Maryland,ME=Maine,MI=Michigan,MN=Minnesota,MO=Missouri,MS=Mississippi,MT=Montana,NC=North Carolina,ND=North Dakota,NE=Nebraska,NH=New Hampshire,NJ=New Jersey,NM=New Mexico,NV=Nevada,NY=New York,OH=Ohio,OK=Oklahoma,OR=Oregon,PA=Pennsylvania,RI=Rhode Island,SC=South Carolina,SD=South Dakota,TN=Tennessee,TX=Texas,UT=Utah,VA=Virginia,VT=Vermont,WA=Washington,WI=Wisconsin,WV=West Virginia,WY=Wyoming)" }, { "key": "WithinDistance", "value": "", "description": "Distance (in miles) from the given `zip code`.\nThis field should be used in conjunction with the zip code to identify the site or program located near the specified zip code." }, { "key": "ProgramType", "value": "", "description": "Valid values (AMHS, CYS, ASO, SUD)" }, { "key": "IsAdaCompliant", "value": "", "description": "Whether the site is ADA-compliant. \"Y\" = Yes or \"N\" = No" }, { "key": "IsTddTtyAvail", "value": "", "description": "Whether the site has TDD/TTY availability\n. \"Y\" = Yes or \"N\" = No" }, { "key": "Latitude", "value": "", "description": "Latitude coordinate for proximity-based search (requires `Longitude` and `WithinDistance`).\n", "disabled": true }, { "key": "Longitude", "value": "", "description": "Longitude coordinate for proximity-based search (requires `Latitude` and `WithinDistance`).\n", "disabled": true } ] }, "description": "## Site Search Endpoint\n\n### Endpoint\n\n`GET /api/v1/Site/search`\n\n### Description\n\nSearch for sites based on a variety of query parameters, including name, address, city, state, distance, and program type.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Site/search?SiteName=1&ZipCode=&Address=&Address2=&City=&State=&WithinDistance=&ProgramType=&IsAdaCompliant=&IsTddTtyAvail=&Latitude=&Longitude=\n\n ```\n\n---\n\n### Explanation of Fields in Response\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique identifier for the site. |\n| `name` | Name of the site. |\n| `address` | Primary address of the site. |\n| `address2` | Additional address details (e.g., building, suite, or unit). |\n| `city` | City where the site is located. |\n| `state` | State where the site is located. |\n| `zipCode` | ZIP code of the site’s location. |\n| `phone` | Phone number for contacting the site. |\n| `fax` | Fax number for the site (if available). |\n| `webSite` | Website URL for additional information. |\n| `adacompliant` | Indicates whether the site complies with ADA requirements (`Y` for Yes, `N` for No). |\n| `tddTtyAvail` | Indicates whether TDD/TTY services are available (`Y` for Yes, `N` for No). |\n| `telehealthAvail` | Availability of telehealth services (`Y`, `N`, or `B` for both in-person and telehealth). |\n| `serviceType` | Types of services provided by the site (e.g., Mental Health Services, Community Integration). |\n| `latitude` | GPS latitude coordinate for geographical location. |\n| `longitude` | GPS longitude coordinate for geographical location. |\n| `mcbmaximum` | Maximum client base that the site can handle. |\n| `mcbcurrent` | Current client base that the site is serving. |\n| `ageGrpServed` | Age groups served by the site (`C` for children, `A` for adults, or both). |\n| `facilityId` | Facility-specific identifier for back-end reference. |\n| `programType` | Describes the specific program or service offering at the site (e.g., Mental Health Services). |\n| `hash` | Unique hash identifier for the entry (used for integrity checks). |\n\n---\n\n### Example Use Cases\n\n1. **Search by Site Name**:\n \n - Use the `SiteName` parameter to search for a site by a partial or full name.\n \n2. **Filter on ADA Compliance**:\n \n - Include the `IsAdaCompliant` parameter to find ADA-compliant sites.\n \n3. **Proximity Search**:\n \n - Use `zipcode` and `WithinDistance` parameters to search for sites within a specific radius. (see example)\n \n - Example: /v1/Site/search?zipcode=90680&withindistance=5\n \n4. **Program-Specific Search**:\n \n - Use the `ProgramType` parameter to find sites offering specific program types like `CIS` or `MHS`.\n \n\n---\n\n### Notes\n\n- All query parameters are optional.\n \n- Combination of parameters will refine search results more specifically.\n \n- If no parameters are provided, the endpoint will return all sites." }, "response": [] }, { "name": "Site Schedule by Id", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/site-schedule/1", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "site-schedule", "1" ] }, "description": "## Get Site Schedule by Site ID\n\n### Endpoint\n\n`GET /api/v1/Site/site-schedule/{siteId}`\n\n### Description\n\nRetrieve the schedule details for a specific site by its unique site ID. Includes details such as opening/closing times and schedule validity.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Site/site-schedule/1\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n#### Site Schedule Object\n\n| Field | Description |\n| --- | --- |\n| `siteId` | The unique identifier for the site whose schedule is being retrieved. |\n| `code` | Code representing the schedule type or category. |\n| `timeOpen` | The opening time of the site for this schedule. |\n| `timeClose` | The closing time of the site for this schedule. |\n| `validFlag` | Indicates whether the schedule is valid (`Y` for Yes, `N` for No). |\n| `schedule` | Placeholder for additional schedule details (currently `null`). |\n| `hash` | Unique hash for the schedule data for data integrity purposes. |\n| `dbInsertDt` | Timestamp when this schedule data was inserted into the database. |\n| `dbUpdateDt` | Timestamp when this schedule data was last updated in the database. |\n\n---\n\n### Example Use Cases\n\n1. **Retrieve Specific Site Schedules**:\n \n - Use the **site ID** to fetch the opening and closing schedules for a specific site.\n \n\n---\n\n### Notes\n\n- The `siteId` parameter is required to query schedules for a specific site.\n \n- Each site can have multiple schedules, but this endpoint may return a single or multiple entries depending on the data." }, "response": [] }, { "name": "Query ProviderSite by SiteId", "request": { "method": "GET", "header": [ { "key": "accept", "value": "application/json" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/provider-site/1", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "provider-site", "1" ] }, "description": "## Get Providers Associated with Site\n\n### Endpoint\n\n`GET /api/v1/Site/provider-site/{siteId}`\n\n### Description\n\nRetrieve detailed information about providers associated with a particular site by its unique site ID. This is primarily used to display the **Site Detail Page**, including all relevant details about providers operating at the site.\n\n---\n\n### Example Query\n\n``` http\nGET https://bhpproviderdirectory.ochca.com/api/v1/Site/provider-site/1\n\n ```\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n#### Provider-Site Object\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique identifier for the provider-site relationship. |\n| `providerId` | Unique ID of the provider associated with the site. |\n| `siteId` | Unique ID for the site. |\n| `isPrimary` | Indicates whether this is the primary site for the provider (`true` or `false`). |\n| `effDate` | Date when the relationship began. |\n| `expDate` | Expiry date for the relationship. |\n| `profitStatus` | Indicator of the provider's profit status (e.g., `88`). |\n| `licenseNumber` | Provider's professional license number. |\n| `licenseType` | Type of license held by the provider (e.g., `CSW`, `MFT`). |\n| `licenseExpire` | Expiry date of the provider's license. |\n| `serviceType` | List of services offered by the provider for this site (e.g., `MH`, `TC`). |\n| `fteservingC` | Full-time employee allocation for Children. |\n| `fteservingA` | Full-time employee allocation for Adults. |\n| `mccurrLoadC` | Current case load for Children. |\n| `mccurrLoadA` | Current case load for Adults. |\n| `mcmaxLoadC` | Maximum allowable client load for Children. |\n| `mcmaxLoadA` | Maximum allowable client load for Adults. |\n| `telehealthFlag` | Indicates telehealth availability (`B` for Both in-person and telehealth). |\n| `fieldSrvcFlag` | Indicates whether field services are provided (`Y` for Yes). |\n| `fieldSrvcDist` | Maximum distance (in miles) for providing field services. |\n| `acceptNew` | Indicates whether the provider is accepting new clients (`Y` for Yes). |\n| `acceptChildren` | Specifies whether children clients are accepted. |\n| `affliation` | Provider’s affiliation with the clinic or organization. |\n| `validFlag` | Indicates whether the entry is valid. |\n| `comment` | Any comments or additional information provided. |\n\n#### Provider DTO (Nested Object)\n\n| Field | Description |\n| --- | --- |\n| `id` | Unique identifier for the provider. |\n| `lastName` | Provider's last name. |\n| `firstName` | Provider's first name. |\n| `gender` | Gender of the provider (`M` for Male, `F` for Female). |\n| `doB` | Date of birth of the provider. |\n| `email` | Email address of the provider. |\n| `npi` | National Provider Identifier (NPI) for the provider. |\n| `taxonomy` | Specifies the provider's taxonomy or area of expertise. |\n| `engFluency` | Indicates English fluency of the provider (`Y` for Yes). |\n| `culturalTraining` | Indicates whether the provider has cultural competence training (`Y` for Yes). |\n| `medicarePd` | Indicates if the provider accepts Medicare (`Y` for Yes). |\n| `chipPd` | Indicates if the provider participates in the Children's Health Insurance Program (CHIP). |\n| `tgitrainingPd` | Indicates if the provider has received Trauma and Grief-Informed training (`Y` for Yes). |\n\n#### Provider Languages (Nested Object)\n\n| Field | Description |\n| --- | --- |\n| `code` | Language code (e.g., `spa` for Spanish). |\n| `fluency` | Level of fluency in the language (`B` for Bilingual). |\n| `validFlag` | Indicates if the language data is valid (`Y` for Yes). |\n\n---\n\n### Example Use Cases\n\n1. **Display the Site Detail Page**:\n \n - Populate all site-specific provider details, including services, license information, and telehealth availability.\n \n2. **Language Support**:\n \n - Identify the languages supported by providers at a given site to serve diverse populations effectively.\n \n3. **License and Service Validation**:\n \n - Ensure license validity (`licenseExpire`) and active services (`serviceType`) for each provider.\n \n\n---\n\n### Notes\n\n- The `siteId` parameter is required to fetch specific provider details for a given site.\n \n- A provider may have a primary or secondary association with a site; this is indicated by the `isPrimary` field.\n \n- Use the nested **Provider DTO** for detailed provider-level information, including NPI, taxonomy, and training." }, "response": [] }, { "name": "All Site Names", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/all-site-names", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "all-site-names" ] }, "description": "Retrieves a comprehensive list of all site or program names available in the provider directory system.\n\n### Endpoint\n\n`GET /api/v1/Site/all-site-names`\n\n### Authentication\n\n- **Required**: Bearer token authentication\n \n- Add the token to the Authorization header: `Authorization: Bearer {your_access_token}`\n \n\n### Request\n\n#### HTTP Method\n\nGET\n\n#### Headers\n\n| Header | Value | Required |\n| --- | --- | --- |\n| Authorization | Bearer {token} | Yes |\n| Content-Type | application/json | Yes |\n\n#### Parameters\n\nThis endpoint does not require any parameters.\n\n### Response\n\n#### Success Response\n\n- **Status Code**: 200 OK\n \n- **Content Type**: application/json\n \n- **Response Body**: Array of strings containing site names\n \n\n### Usage Notes\n\n- The endpoint returns all site names without filtering\n \n- Names are returned as an array of strings in alphabetical order\n \n- Each name uniquely identifies a facility or service location\n \n- Site names may include program type prefixes (e.g., AMHS, CYS, ADAS)\n \n\n### Error Responses\n\n| Status Code | Description |\n| --- | --- |\n| 401 | Unauthorized - Invalid or missing authentication token |\n| 403 | Forbidden - Insufficient permissions |\n| 500 | Internal Server Error |\n\n## Example Use Cases\n\n- Retrieve a complete list of available site names\n \n- Display all names in a dropdown menu or autocomplete textbox\n \n- Search for specific types of facilities by filtering the returned names" }, "response": [] }, { "name": "All Site Address", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/all-site-address", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "all-site-address" ] }, "description": "## Endpoint\n\n`GET /api/v1/Site/all-site-address`\n\n---\n\n## Description\n\nThis endpoint retrieves a comprehensive list of **all unique site addresses** from the provider directory. The response will be a collection of plain strings, each representing a unique site address.\n\n---\n\n## Example Query\n\nhttp GET [https://bhpproviderdirectory.ochca.com/api/v1/Site/all-site-address](https://bhpproviderdirectory.ochca.com/api/v1/Site/all-site-address)\n\n### Headers\n\n| **Name** | **Value** |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Authorization` | `Bearer {tokenString}` |\n\n---\n\n## Response Explanation\n\nThe API returns a list of all **unique site addresses** in string format.\n\n| **Field** | **Description** |\n| --- | --- |\n| `item` | A site address represented as a string. |\n\n**Example:** `\"1300 S. Grand Ave.\"`\n\n---\n\n## Error Responses\n\n| **HTTP Status Code** | **Description** |\n| --- | --- |\n| `401 Unauthorized` | Missing or invalid authentication token. |\n| `403 Forbidden` | User is not authorized to access this resource. |\n| `500 Internal Server Error` | An unexpected error occurred on the server side. |\n\n---\n\n## Notes\n\n- **Authentication:** A valid Bearer **token** in the `Authorization` header is required to use this endpoint.\n \n- **Response Format:** Returns all site addresses in a **plain JSON array of strings**.\n \n- **Uniqueness:** The list automatically removes duplicate addresses.\n \n- **Order:** The response may not be sorted—sorting, if needed, must be handled on the client side.\n \n\n---\n\n## Example Use Cases\n\n1. **Generate Address Lists:** Use this endpoint to retrieve all site addresses for data analysis, generating reports, or validating input fields.\n \n2. **Populate External Tools:** Populate addresses in dropdown menus or integrate them into other services or databases needing consistent address data.\n \n3. **Error Checking:** Detect missing or incorrect addresses by comparing them with the provided directory.\n \n4. **Auto complete:** In provider directory website, this API is used to populated the dropdown autocomplete list." }, "response": [] }, { "name": "All Site Address2 (suite, building, floor)", "request": { "method": "GET", "header": [ { "key": "accept", "value": "*/*" } ], "url": { "raw": "https://bhpproviderdirectory.ochca.com/api/v1/Site/all-site-address2", "protocol": "https", "host": [ "bhpproviderdirectory", "ochca", "com" ], "path": [ "api", "v1", "Site", "all-site-address2" ] }, "description": "## Get All Site Address 2\n\n### Endpoint\n\n`GET /api/v1/Site/all-site-address2`\n\n### Description\n\nRetrieve a list of secondary addresses (Address 2) for all available sites. The response provides additional details such as suite numbers, floors, or specific building names.\n\n---\n\n#### Headers\n\n| Name | Value |\n| --- | --- |\n| `Accept` | `application/json` |\n| `Content-Type` | `application/json` |\n| `Authorization` | `Bearer {{tokenString}}` |\n\n---\n\n### Explanation of Fields\n\n#### Address 2 Details\n\nThe API returns a collection of strings, each representing the secondary part of a site's address. These could include:\n\n- Suite numbers (e.g., `Suite 200`).\n \n- Floor details (e.g., `2nd Floor` or `4th Floor`).\n \n- Specific room or building information (e.g., `East Building Suite 107` or `Bldg. C, Ste. 213-W`).\n \n\n---\n\n### Notes\n\n- This endpoint requires a valid Bearer token for authentication. Ensure to include it in the `Authorization` header.\n \n- This API is helpful for mapping and providing more granular location details for individual sites." }, "response": [] } ], "description": "This folder contains all endpoints related to query data from the Site and ProviderSite table in the database. Use the Lookup endpoints to get the necessary search query paramaters for specific endpoints." } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ] }