### Successful API Status Response Source: https://docs.develophealth.ai/api-reference/quickstart This is an example of a successful JSON response when querying the API status endpoint. It indicates that the API is operational and there are no errors. ```json { "status": "success", "error": null, "data": { "message": "API is operational" } } ``` -------------------------------- ### Make First API Request to Check Status using cURL Source: https://docs.develophealth.ai/api-reference/quickstart This example demonstrates making your first request to the Develop Health API to check its operational status using cURL. It includes the necessary Authorization header. A successful response indicates the API is ready. ```bash curl -H "Authorization: Bearer YOUR_JWT_TOKEN" https://api.develophealth.io/status ``` -------------------------------- ### API Authentication Source: https://docs.develophealth.ai/api-reference/quickstart Demonstrates how to authenticate API requests using a bearer token. Replace YOUR_JWT_TOKEN with your actual API key. ```APIDOC ## GET /status ### Description Checks the operational status of the API. ### Method GET ### Endpoint `https://api.develophealth.io/status` ### Parameters #### Headers - **Authorization** (string) - Required - 'Bearer YOUR_JWT_TOKEN' ### Request Example ```bash curl -H "Authorization: Bearer YOUR_JWT_TOKEN" https://api.develophealth.io/status ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the request ('success' or 'error'). - **error** (object|null) - Contains error details if the status is 'error'. - **data** (object) - Contains the API response data. - **message** (string) - A message indicating the API is operational. #### Response Example ```json { "status": "success", "error": null, "data": { "message": "API is operational" } } ``` ``` -------------------------------- ### Benefit Verification Source: https://docs.develophealth.ai/api-reference/quickstart Endpoint for initiating a benefit verification process. ```APIDOC ## POST /benefit-verification ### Description Initiates the benefit verification process. ### Method POST ### Endpoint `https://api.develophealth.io/benefit-verification` ### Parameters #### Headers - **Authorization** (string) - Required - 'Bearer YOUR_JWT_TOKEN' #### Request Body *Detailed request body schema would be specified here.* ### Request Example *Example request body would be provided here.* ### Response #### Success Response (200) *Details of a successful response would be provided here.* #### Response Example *Example success response would be provided here.* #### Error Responses - **401 Unauthorized**: Invalid API key or missing authorization header. - **500 Internal Server Error**: An error on our server side. ``` -------------------------------- ### Prior Authorization Source: https://docs.develophealth.ai/api-reference/quickstart Endpoint for submitting a prior authorization request. ```APIDOC ## POST /prior-authorization ### Description Submits a prior authorization request. ### Method POST ### Endpoint `https://api.develophealth.io/prior-authorization` ### Parameters #### Headers - **Authorization** (string) - Required - 'Bearer YOUR_JWT_TOKEN' #### Request Body *Detailed request body schema would be specified here.* ### Request Example *Example request body would be provided here.* ### Response #### Success Response (200) *Details of a successful response would be provided here.* #### Response Example *Example success response would be provided here.* #### Error Responses - **401 Unauthorized**: Invalid API key or missing authorization header. - **500 Internal Server Error**: An error on our server side. ``` -------------------------------- ### Authenticate API Request using cURL Source: https://docs.develophealth.ai/api-reference/quickstart This snippet shows how to authenticate an API request using a bearer token with cURL. Ensure you replace 'YOUR_JWT_TOKEN' with your actual API key. This is crucial for accessing protected API resources. ```bash curl -X GET 'https://api.develophealth.io/status' -H 'Authorization: Bearer YOUR_JWT_TOKEN' ``` -------------------------------- ### Install PyJWT Library for Python Source: https://docs.develophealth.ai/api-reference/webhooks Installs the PyJWT library, which is necessary for decoding and verifying JWT (JSON Web Token) signatures in Python. This is a prerequisite for the signature verification code. ```bash pip install PyJWT ``` -------------------------------- ### GET /authorized-providers Source: https://docs.develophealth.ai/api-reference/provider-authorization/get_authorized_providers Retrieve a list of all authorized providers for the organization. This includes providers who are pending authorization (signed_at is null) and those who have completed the authorization process (signed_at is populated). ```APIDOC ## GET /authorized-providers ### Description Retrieve a list of all authorized providers for the organization. This includes providers who are pending authorization (signed_at is null) and those who have completed the authorization process (signed_at is populated). ### Method GET ### Endpoint https://api.develophealth.ai/authorized-providers ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Indicates the status of the request. Can be 'success' or 'error'. - **error** (object) - Contains details about an error if the request failed. - **title** (string) - The title of the error. - **description** (string) - A description of the error. - **code** (string) - An error code. - **data** (array) - A list of AuthorizedProviderResponse objects. - **npi** (string) - The NPI of the provider. - **first_name** (string) - The first name of the provider. - **last_name** (string) - The last name of the provider. - **email** (string) - The email of the provider. - **signed_at** (string, date-time) - The date and time when the provider signed the authorization form. If null, the authorization is pending. #### Response Example ```json { "status": "success", "data": [ { "npi": "1234567890", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "signed_at": "2024-01-15T10:30:00Z" }, { "npi": "987654321", "first_name": "Jane", "last_name": "Smith", "email": "jane.smith@example.com", "signed_at": null } ] } ``` ### Error Handling - **401 Unauthorized**: If the authentication token is invalid or missing. - **500 Internal Server Error**: If there is an issue on the server side. ``` -------------------------------- ### GET /websites/develophealth_ai Source: https://docs.develophealth.ai/api-reference/medication-benefit-check/get_item Retrieves benefit verification details for a given patient, including insurance information and verification methods. ```APIDOC ## GET /websites/develophealth_ai ### Description Retrieves the benefit verification details for a patient. This includes their insurance information, patient coverage status, and the methods used for verification. ### Method GET ### Endpoint /websites/develophealth_ai ### Parameters #### Query Parameters - **patient_id** (string) - Required - The unique identifier for the patient. ### Request Example GET /websites/develophealth_ai?patient_id=12345abc ### Response #### Success Response (200) - **state_province** (string) - State or province of the patient's address. - **zip_postal_code** (string) - ZIP or postal code of the patient's address. - **country** (string) - Country of the patient's address. - **phone** (string) - Patient's phone number. - **fax** (string | null) - Patient's fax number (if available). - **npi** (string) - National Provider Identifier. - **in_network_payers** (array) - A list of in-network payers. - **entity** (object) - Information about the entity. - **legal_name** (string) - Legal name of the entity. - **tax_id** (string) - Tax ID of the entity. - **insurance** (array) - List of insurance policies. - **scanned_content** (object) - Extracted information from insurance card. - **client_name** (string) - Name of the insurance client. - **group_number** (string) - Group number for the insurance policy. - **member_name** (string) - Name of the insurance member. - **member_number** (string) - Member number for the insurance policy. - **payer_name** (string) - Name of the insurance payer. - **plan_name** (string) - Name of the insurance plan. - **rx_bin** (string) - Rx BIN number. - **rx_group** (string) - Rx Group number. - **rx_pcn** (string) - Rx PCN number. - **discrete_content** (object) - Discrete insurance data (if available). - **url** (string) - URL to the insurance document. - **patient_coverage_status** (string) - Status of patient coverage (e.g., 'covered'). - **verification_methods** (array) - Details about the verification methods used. - **id** (string) - Unique identifier for the verification method. - **type** (string) - Type of verification method (e.g., 'ai_call'). - **transcript** (string) - Transcript of the verification call. - **recording_url** (string) - URL to the recording of the verification call. - **patient_plan_fund_source** (string) - Source of patient plan funds. - **patient_coverage_type** (string) - Type of patient coverage. - **priority** (integer) - Priority level of the verification. #### Response Example ```json { "state_province": "CO", "zip_postal_code": "80247", "country": "USA", "phone": "1231231234", "fax": null, "npi": "0000000000", "in_network_payers": [], "entity": { "legal_name": "Test Entity", "tax_id": "111223333" }, "insurance": [ { "scanned_content": { "client_name": "Company", "group_number": "12345678", "member_name": "John Smith", "member_number": "12345678", "payer_name": "United", "plan_name": "Plus Plan", "rx_bin": "123456", "rx_group": "ADV", "rx_pcn": "FAC" }, "discrete_content": {}, "url": "https://example.com/insurance_doc" }, { "scanned_content": { "error": "Unable to extract information from card" }, "discrete_content": {}, "url": "https://example.com/insurance_doc2" } ], "patient_coverage_status": "covered", "verification_methods": [ { "id": "bva_23j3234", "type": "ai_call", "transcript": "Call transcript", "recording_url": "https://example.com/recording" } ], "patient_plan_fund_source": "question_not_asked", "patient_coverage_type": "question_not_asked", "priority": 2 } ``` #### Error Response (422) - **detail** (array) - Details of the validation error. - **loc** (array) - Location of the error in the request. - **msg** (string) - Error message. - **type** (string) - Error type. #### Response Example ```json { "detail": [ { "loc": [ "" ], "msg": "", "type": "" } ] } ``` ``` -------------------------------- ### Example Webhook Payload for Benefit Verification Update Source: https://docs.develophealth.ai/api-reference/webhooks This JSON object represents a typical webhook payload sent when a benefit verification's status changes. It includes event-specific fields like 'title', 'description', and 'event_type', along with the 'data' object containing the benefit verification details. The 'data' object's schema is consistent with the GET /benefit-verification endpoint. ```json { "title": "Benefit Verification Updated", "description": "A Benefit Verification has been updated.", "event_type": "benefit_verification.status_change", "data": { "id": "bv_nBElDPw", "object": "benefit_verification", "status": "completed" // ... See the GET /benefit-verification endpoint docs for the full schema } } ``` -------------------------------- ### POST /patient-enrollment Source: https://docs.develophealth.ai/api-reference/patient-enrollment/post Submits a patient enrollment form for a specified support program. This endpoint requires authentication and detailed patient, prescription, and evidence information. ```APIDOC ## POST /patient-enrollment ### Description Submits a patient enrollment form for a specified support program. This endpoint requires authentication and detailed patient, prescription, and evidence information. ### Method POST ### Endpoint https://api.develophealth.io/patient-enrollment ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **patient** (object) - Required - Information about the patient including name, date of birth, address, and insurance details. - **programId** (string) - Required - Identifier for the support program. You can obtain this from the Find patient support programs endpoint. - **prescription** (object) - Optional - Details of the patient's prescription. - **evidence** (array) - Optional - A collection of evidence items supporting the enrollment request. - **metadata** (object) - Optional - Optional metadata containing internal details about the enrollment. Useful for custom tagging or referencing. ### Request Example ```json { "patient": { "first_name": "", "last_name": "", "date_of_birth": "2023-12-25", "address": { "street": "", "city": "", "state_province": "", "zip_postal_code": "", "country": "" }, "email": "jsmith@example.com", "phone": "", "insurance_details": { "data": { "group_number": "", "payer": "", "membership_number": "", "rx_bin": "", "rx_group": "" }, "assets": [ { "name": "", "type": "Insurance Card Front", "url": "" } ] }, "metadata": { "patient_id": "" } }, "programId": "", "prescription": { "drug_name": "", "dosage": "", "directions": "", "extra": {} }, "evidence": [ { "type": "Visit Note", "date_created": "2023-11-07T05:31:56Z", "content": {}, "assets": [ { "name": "", "type": "Insurance Card Front", "url": "" } ] } ], "metadata": { "enrollment_id": "" } } ``` ### Response #### Success Response (200) - **description** (any) - Patient enrollment form submitted successfully #### Response Example ```json { "message": "Patient enrollment form submitted successfully" } ``` #### Error Responses - **400**: Invalid request data. - **401**: Access token is missing or invalid. ``` -------------------------------- ### Patient Enrollment API Source: https://docs.develophealth.ai/features/automated-support-enrollment This endpoint manages the entire enrollment procedure for patients into support programs, from form preparation to final confirmation. ```APIDOC ## POST /api-reference/patient-enrollment ### Description Initiates and manages the patient enrollment process into support programs, including form autofilling and fax preparation. ### Method POST ### Endpoint /api-reference/patient-enrollment ### Parameters #### Request Body - **patient_data** (object) - Required - Contains information about the patient and their prescription. - **first_name** (string) - Required - Patient's first name. - **last_name** (string) - Required - Patient's last name. - **date_of_birth** (string) - Required - Patient's date of birth (YYYY-MM-DD). - **medication** (string) - Required - The name of the prescribed medication. - **prescribing_physician** (string) - Required - Name of the prescribing physician. - **program_name** (string) - Required - The specific support program to enroll in. ### Request Example ```json { "patient_data": { "first_name": "Jane", "last_name": "Doe", "date_of_birth": "1990-05-15", "medication": "ExampleDrug", "prescribing_physician": "Dr. Smith", "program_name": "ExampleDrug Patient Support" } } ``` ### Response #### Success Response (200) - **enrollment_status** (string) - The status of the enrollment process. - **form_preview_url** (string) - A URL to preview the pre-filled enrollment form. - **message** (string) - A confirmation message regarding the enrollment preparation. #### Response Example ```json { "enrollment_status": "Prepared for Review", "form_preview_url": "https://develophealth.ai/forms/preview/12345", "message": "Enrollment form is ready for your review and fax submission." } ``` ``` -------------------------------- ### GET /api-reference/medication-benefit-check/get_item Source: https://docs.develophealth.ai/benefit-verification/overview Retrieves the details of a previously initiated benefit verification request using its unique identifier. ```APIDOC ## GET /api-reference/medication-benefit-check/get_item ### Description Retrieves the details of a previously initiated benefit verification request using its unique identifier. ### Method GET ### Endpoint /api-reference/medication-benefit-check/get_item ### Parameters #### Path Parameters None #### Query Parameters - **verification_id** (string) - Required - The unique identifier for the benefit verification request. #### Request Body None ### Request Example ``` GET /api-reference/medication-benefit-check/get_item?verification_id=bv_abcde12345 ``` ### Response #### Success Response (200) - **verification_id** (string) - Unique identifier for this verification request. - **status** (string) - The current status of the verification (e.g., "pending", "processing", "completed", "failed"). - **results** (array) - An array of verification results for each medication. - **medication_name** (string) - The name of the medication. - **is_covered** (boolean) - Indicates if the medication is covered. - **prior_authorization_required** (boolean) - Indicates if prior authorization is required. - **patient_financial_responsibility** (string) - The estimated cost to the patient. #### Response Example ```json { "verification_id": "bv_abcde12345", "status": "completed", "results": [ { "medication_name": "Lipitor", "is_covered": true, "prior_authorization_required": false, "patient_financial_responsibility": "$10/month" }, { "medication_name": "Metformin", "is_covered": true, "prior_authorization_required": true, "patient_financial_responsibility": "$5/month (with PA)" } ] } ``` ``` -------------------------------- ### POST /provider/authorize Source: https://docs.develophealth.ai/api-reference/provider-authorization/post Authorizes a provider by providing their NPI, first name, last name, and email. This endpoint initiates the provider authorization process. ```APIDOC ## POST /provider/authorize ### Description Authorizes a provider by providing their NPI, first name, last name, and email. This endpoint initiates the provider authorization process. ### Method POST ### Endpoint https://api.develophealth.ai/provider/authorize ### Parameters #### Header Parameters - **Authorization** (string) - Required - Bearer authentication header of the form `Bearer `, where `` is your auth token. #### Request Body - **npi** (string) - Required - The NPI of the provider. - **first_name** (string) - Required - The first name of the provider. - **last_name** (string) - Required - The last name of the provider. - **email** (string) - Required - The email of the provider. ### Request Example ```json { "npi": "", "first_name": "", "last_name": "", "email": "" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the status of the operation, expected to be 'success'. #### Response Example ```json { "status": "success" } ``` #### Error Response (400) - **status** (string) - Indicates the status of the operation, expected to be 'error'. - **error** (object) - Contains details about the error, including `title`, `description`, and `code`. #### Error Response Example (400) ```json { "status": "error", "error": { "title": "Provider Authorization Already Initiated", "description": "Authorization has already been initiated for a provider with this NPI or email", "code": "PROVIDER_AUTHORIZATION_ALREADY_INITIATED" } } ``` #### Error Response (422) - **detail** (array) - Contains a list of validation errors, each with `loc` (location), `msg` (message), and `type`. #### Error Response Example (422) ```json { "detail": [ { "loc": [ "" ], "msg": "", "type": "" } ] } ``` ``` -------------------------------- ### Support Program API Source: https://docs.develophealth.ai/features/automated-support-enrollment This endpoint allows developers to verify the availability of support programs based on a specific medication prescribed to a patient. ```APIDOC ## GET /api-reference/support-program ### Description Verifies the availability of support programs for a given medication. ### Method GET ### Endpoint /api-reference/support-program ### Parameters #### Query Parameters - **medication** (string) - Required - The name of the prescribed medication. ### Request Example ``` GET /api-reference/support-program?medication=ExampleDrug ``` ### Response #### Success Response (200) - **programs** (array) - A list of available support programs for the medication. - **program_name** (string) - The name of the support program. - **provider** (string) - The entity providing the support program. #### Response Example ```json { "programs": [ { "program_name": "ExampleDrug Patient Support", "provider": "PharmaCorp Hub" } ] } ``` ``` -------------------------------- ### GET /prior-authorization/{id} Endpoint Specification (OpenAPI) Source: https://docs.develophealth.ai/api-reference/prior-authorization/get_item Defines the GET request for retrieving a specific prior authorization by its ID. It includes details on the endpoint path, HTTP method, server URL, authentication requirements (Bearer token), and expected request/response structures. The response schema specifies success and error statuses, along with detailed data for prior authorizations. ```yaml paths: path: /prior-authorization/{id} method: get servers: - url: https://api.develophealth.ai request: security: - title: FronteggJWTAuthentication parameters: query: {} header: Authorization: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your auth token. cookie: {} parameters: path: id: schema: - type: string required: true title: Id query: {} header: {} cookie: {} body: {} response: '200': application/json: schemaArray: - type: object properties: status: allOf: - anyOf: - type: string enum: - success - type: string enum: - error title: Status default: success error: allOf: - $ref: '#/components/schemas/ApiError' data: allOf: - allOf: - $ref: '#/components/schemas/GetPriorAuthResponseData' title: Data description: >- Contains the data from your prior authorization request, or None if an error occurred. title: GetPriorAuthResponse description: >- Represents the response structure for a GET /prior-authorization/:id request. This class extends the generic ApiResponse, specifically tailored to handle responses related to prior authorizations. It primarily includes the data attribute, which holds detailed information about the benefit verification process and its results. refIdentifier: '#/components/schemas/GetPriorAuthResponse' examples: example: value: status: success data: id: pa_sdkfj3f object: prior_authorization url: >- https://platform.develophealth.ai/prior-authorizations/pa_sdkfj3f status: completed diagnoses: - code: E66.9 evidence: - content: bmi_value: 32 date_measured: '2023-11-10' date_created: '2023-11-10T10:15:00' title: BMI Chart - content: medication_name: Metformin response: No significant weight loss date_created: '2023-11-10T10:15:00' title: Previous Medication History patient: address: street: 123 Health St. city: Wellness state_province: CA zip_postal_code: '12345' country: USA date_of_birth: '1980-01-01' email: johndoe@email.com first_name: John last_name: Doe gender: male internal_id: '123456' phone: 123-456-7890 insurance: - scanned_content: client_name: Company group_number: '12345678' member_name: John Doe member_number: '12345678' payer_name: United plan_name: Plus Plan rx_bin: '123456' rx_group: ADV rx_pcn: FAC discrete_content: {} url: https://example.com/insurance_doc - scanned_content: error: Unable to extract information from card discrete_content: {} url: https://example.com/insurance_doc2 prescription: days_supply: 30 quantity: 2 directions: Inject subcutaneously once a week drug_name: Wegovy strength: 0.25 mg/0.5 mL (0.25 mg dose) dose_form: injectable route_of_administration: subcutaneous extra: prescribing_information: Prescribed for weight management in patients with obesity prescription_date: '2024-02-14T05:46:07.764000' provider: address: street: 456 Care Blvd. ``` -------------------------------- ### POST /websites/develophealth_ai/enrollment Source: https://docs.develophealth.ai/api-reference/patient-enrollment Enrolls a patient into a support program. This endpoint simplifies the process of accessing patient support programs, which can lead to improved patient outcomes and satisfaction by addressing financial and educational barriers to medication adherence. ```APIDOC ## POST /websites/develophealth_ai/enrollment ### Description Enrolls a patient into a support program. This endpoint simplifies the process of accessing patient support programs, which can lead to improved patient outcomes and satisfaction by addressing financial and educational barriers to medication adherence. ### Method POST ### Endpoint /websites/develophealth_ai/enrollment ### Parameters #### Header Parameters - **Authorization** (string) - Required - Bearer authentication header of the form `Bearer `, where `` is your auth token. #### Request Body - **patient** (object) - Required - Patient enrollment details. - **programId** (string) - Required - Identifier for the support program. You can obtain this from the Find patient support programs endpoint. - **prescription** (object) - Prescription details. - **evidence** (object[]) - A collection of evidence items supporting the enrollment request. - **metadata** (object) - Optional metadata containing internal details about the enrollment. Useful for custom tagging or referencing. ### Request Example ```json { "patient": { "programId": "prog_123", "prescription": {}, "evidence": [ { "type": "medical_record", "url": "http://example.com/medical_record.pdf" } ], "metadata": { "internal_ref": "ref_456" } } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating successful enrollment. #### Response Example ```json { "message": "Patient enrollment form submitted successfully" } ``` ``` -------------------------------- ### POST /api-reference/medication-benefit-check/post Source: https://docs.develophealth.ai/benefit-verification/overview Initiates a benefit verification request for a given patient and a list of prescribed drugs. This endpoint will determine if each drug is covered, if prior authorization is needed, and the patient's estimated financial responsibility. ```APIDOC ## POST /api-reference/medication-benefit-check/post ### Description Initiates a benefit verification request for a given patient and a list of prescribed drugs. This endpoint will determine if each drug is covered, if prior authorization is needed, and the patient's estimated financial responsibility. ### Method POST ### Endpoint /api-reference/medication-benefit-check/post ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **patient_id** (string) - Required - Unique identifier for the patient. - **medications** (array) - Required - A list of medications to verify. - **name** (string) - Required - The name of the medication. - **dosage** (string) - Required - The dosage of the medication. - **frequency** (string) - Required - The frequency of the medication. ### Request Example ```json { "patient_id": "pat_12345", "medications": [ { "name": "Lipitor", "dosage": "20mg", "frequency": "daily" }, { "name": "Metformin", "dosage": "500mg", "frequency": "twice daily" } ] } ``` ### Response #### Success Response (200) - **verification_id** (string) - Unique identifier for this verification request. - **status** (string) - The current status of the verification (e.g., "pending", "processing", "completed", "failed"). - **results** (array) - An array of verification results for each medication. - **medication_name** (string) - The name of the medication. - **is_covered** (boolean) - Indicates if the medication is covered. - **prior_authorization_required** (boolean) - Indicates if prior authorization is required. - **patient_financial_responsibility** (string) - The estimated cost to the patient. #### Response Example ```json { "verification_id": "bv_abcde12345", "status": "completed", "results": [ { "medication_name": "Lipitor", "is_covered": true, "prior_authorization_required": false, "patient_financial_responsibility": "$10/month" }, { "medication_name": "Metformin", "is_covered": true, "prior_authorization_required": true, "patient_financial_responsibility": "$5/month (with PA)" } ] } ``` ``` -------------------------------- ### Get Benefit Verification Source: https://docs.develophealth.ai/api-reference/medication-benefit-check/get_item Retrieves the status and details of a benefit verification request. This endpoint is used to check the progress and outcome of a previously submitted benefit verification. ```APIDOC ## GET /websites/develophealth_ai/benefit_verification ### Description Retrieves the status and details of a benefit verification request. This endpoint is used to check the progress and outcome of a previously submitted benefit verification. ### Method GET ### Endpoint /websites/develophealth_ai/benefit_verification ### Parameters #### Query Parameters - **verification_id** (string) - Required - The unique identifier for the benefit verification request. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **id** (string) - The ID of the benefit verification request. - **object** (string) - The type of object the response is about, which is 'benefit_verification'. - **status** (BenefitVerificationStatus) - The current status of the benefit verification (e.g., pending, completed, failed). - **status_description** (string) - Provides additional information about the verification status. - **error** (FailureDetails) - Specific error information if the benefit verification failed. - **review_status** (ReviewStatus) - The status on if this benefits investigation has been reviewed in the portal. - **drugs** (array) - List of drug coverage information related to the verification. - **drug_history** (DrugHistory) - The patient's drug history. - **diagnoses** (array) - List of diagnoses for the patient. - **patient** (PatientInfo) - Demographic information for the patient. - **provider** (ProviderInfo) - Details of the healthcare provider. - **entity** (EntityInfo) - Information about the legal entity the provider is associated with. #### Response Example ```json { "id": "bv_123abc", "object": "benefit_verification", "status": "completed", "status_description": "Benefit verification completed successfully.", "error": null, "review_status": "unreviewed", "drugs": [ { "name": "Lisinopril", "tier": 1, "coverage_status": "covered" } ], "drug_history": { "drugs": [ { "name": "Metformin", "start_date": "2022-01-15" } ] }, "diagnoses": [ { "name": "Type 2 Diabetes", "code": "E11.9" } ], "patient": { "first_name": "Jane", "last_name": "Doe", "date_of_birth": "1985-07-22", "gender": "female" }, "provider": { "name": "General Hospital", "npi": "1234567890" }, "entity": { "name": "Health Network Group" } } ``` #### Error Response (4xx/5xx) - **title** (string) - Title of the error. - **message** (string) - A detailed message explaining the error. - **detail_message** (string) - A more detailed message that can be used to identify the specific issue that caused the error. - **detail_code** (string) - A more detailed code that can be used to identify the specific issue that caused the error. #### Error Response Example ```json { "title": "Unable to Gather Benefits", "message": "We were unable to gather benefits from the insurance company. This could be due to a variety of reasons, such as the insurance company not being able to provide the information, or the information provided not being sufficient to determine the patient's coverage status.", "detail_message": "The insurance provider returned an invalid response for the given policy number.", "detail_code": "INVALID_POLICY_RESPONSE" } ``` ``` -------------------------------- ### GET /websites/develophealth_ai Source: https://docs.develophealth.ai/api-reference/clinical-qualification/get_item Retrieves clinical qualification data, including details about prescribed drugs, patient visit notes, and provider information. ```APIDOC ## GET /websites/develophealth_ai ### Description Retrieves a comprehensive overview of clinical qualifications, including details on prescribed drugs (such as Wegovy, Zepbound, and Ozempic), associated supply information, administration directions, and qualification status. It also includes patient visit notes with content and creation dates, and provider details encompassing name, NPI, contact information, and address. ### Method GET ### Endpoint /websites/develophealth_ai ### Parameters #### Query Parameters None #### Path Parameters None ### Request Body None ### Request Example None ### Response #### Success Response (200) - **results** (array) - A list of drug qualification objects, each containing: - **drug** (object) - Details about the prescribed drug: - **days_supply** (integer) - Number of days the supply is intended for. - **quantity** (integer) - The quantity of the drug prescribed. - **directions** (string) - Instructions for administering the drug. - **drug_name** (string) - The name of the drug. - **strength** (string) - The dosage strength of the drug. - **dose_form** (string) - The form of the drug (e.g., injectable). - **route_of_administration** (string) - The method of administration (e.g., subcutaneous). - **status** (string) - The qualification status of the drug (e.g., 'qualified', 'unqualified'). - **unqualified_reasons** (array) - A list of reasons if the drug is unqualified. - **visit_notes** (array) - A list of visit notes objects, each containing: - **content** (string) - The textual content of the visit note. - **date_created** (string) - The date and time the note was created. - **provider** (object) - Information about the healthcare provider: - **address** (object) - Provider's address details. - **fax** (string) - Provider's fax number. - **first_name** (string) - Provider's first name. - **internal_id** (string) - Provider's internal identifier. - **last_name** (string) - Provider's last name. - **npi** (string) - Provider's National Provider Identifier. - **phone** (string) - Provider's phone number. - **questionnaires** (array) - A list of questionnaire objects, each containing: - **questions** (array) - A list of question-answer pairs. - **date_created** (string) - The date and time the questionnaire was created. #### Response Example ```json { "results": [ { "drug": { "days_supply": 30, "quantity": 2, "directions": "Inject subcutaneously once a week", "drug_name": "Wegovy", "strength": "0.25 mg/0.5 mL (0.25 mg dose)", "dose_form": "injectable", "route_of_administration": "subcutaneous" }, "status": "qualified", "unqualified_reasons": [] }, { "drug": { "days_supply": 28, "quantity": 4, "directions": "Inject subcutaneously once a week", "drug_name": "Zepbound", "strength": "1 mg/dose", "dose_form": "injectable", "route_of_administration": "subcutaneous" }, "status": "qualified", "unqualified_reasons": [] } ], "visit_notes": [ { "content": "Patient presents with a BMI of 32, indicating obesity. Recommended to start Wegovy for weight management.", "date_created": "2023-11-10T10:00:00" } ], "provider": { "address": { "street": "456 Care Blvd.", "city": "Healtown", "state_province": "CA", "zip_postal_code": "67890", "country": "USA" }, "fax": "987-654-3211", "first_name": "Alice", "internal_id": "provider_12345", "last_name": "Smith", "npi": "1234567890", "phone": "987-654-3210" }, "questionnaires": [ { "questions": [ { "answer": "I usually eat a balanced diet and exercise 3 times a week.", "question": "Please describe your current diet and exercise routine." }, { "answer": "Yes, I have tried metformin without significant results.", "question": "Have you previously tried other weight loss medications?" } ], "date_created": "2023-11-01T08:00:00" } ] } ``` #### Error Response (422) - **detail** (array) - Contains validation error details. - **loc** (array) - Location of the error within the request. - **msg** (string) - Description of the validation error. - **type** (string) - Type of validation error. #### Response Example ```json { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } ``` ```