### Start Visit Response Source: https://web.healthcloud.sh/api-reference Response received after successfully creating a medical visit. Contains authorization details. ```json { "detail": "Authorization for Paul Mutinda successfully created", "edi_auth_id": 17387, "edi_auth_guid": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "member_number": 1234567, "first_name": "string", "last_name": "string", "auth_token": "234567-5TFHXF" } ``` -------------------------------- ### Get Logged-In User (CLI) Source: https://web.healthcloud.sh/api-reference Use this CLI command to retrieve information about the currently logged-in user. Replace the placeholder access token with a valid one. ```bash curl --header "Authorization: Bearer xusWuHUK0RibYYZRswJKUQIIfuiwf1" \ https://accounts.multitenant.slade360.co.ke/v1/user/me/ ``` -------------------------------- ### Validate Authorization Token Source: https://web.healthcloud.sh/api-reference Validate the `auth_token` obtained from the start visit endpoint. Requires member details and the authorization token. ```json { "first_name": "John", "last_name": "Kerry", "other_names": "string", "member_number": "DEMO/001", "auth_token": "CGY7WNU8S8", "visit_type": "OUTPATIENT", "scheme_code": "string", "scheme_name": "string", "payer_code": "string" } ``` -------------------------------- ### Start Visit via OTP Source: https://web.healthcloud.sh/api-reference Create a medical visit for an authenticated member using OTP. Ensure the member is already looked up and authenticated before calling this endpoint. ```json { "beneficiary_id": 1, "factors": [ "OTP" ], "benefit_type": "OUTPATIENT", "benefit_code": 340, "policy_number": 1334993, "policy_effective_date": "2022-01-17T00:00:00+03:00", "otp": 913180, "beneficiary_contact": 254712345678, "scheme_name": "string", "scheme_code": "string" } ``` -------------------------------- ### Get Access Token (Password Grant) Source: https://web.healthcloud.sh/api-reference Use this payload to obtain an access token by providing user email and password. Ensure you have a valid client ID and secret. ```json { "grant_type": "password", "client_id": "TTxh4hr0NeyBR7HAlZnLSlO9CWXfwoHnIUaqWQli", "client_secret": "77vejSg0ohd75U9TtAVcPrfg1WWfBNqrhIVzOYk7e...", "username": "test@mail.com", "password": "string" } ``` -------------------------------- ### validate_authorization_token Source: https://web.healthcloud.sh/api-reference Validates the authorization token previously obtained from the start visit endpoint. This is a crucial step for confirming the validity of a member's authorization. ```APIDOC ## POST /authorizations/validate_authorization_token/ ### Description Validates the `auth_token` returned by the start visit endpoint. This endpoint confirms the validity of a member's authorization. ### Method POST ### Endpoint https://is-api.multitenant.slade360.co.ke/v1/authorizations/validate_authorization_token/ ### Parameters #### Request Body - **first_name** (string) - Required - The member's first name. - **last_name** (string) - Required - The member's last name. - **other_names** (string) - Optional - The member's other names. - **member_number** (string) - Required - The member's member number (printed on the insurance card). - **auth_token** (string) - Required - The `auth_token` retrieved either from a successful call to the start visit endpoint or copied from the slade provider portal after starting a patient visit. - **visit_type** (string) - Optional - Enum: "OUTPATIENT" "INPATIENT". Specifies the type of visit. - **scheme_code** (string) - Optional - The code of the scheme. - **scheme_name** (string) - Optional - The name of the scheme. - **payer_code** (string) - Optional - Unique identifier for the payer from the provider's EMR system. ### Request Example ```json { "first_name": "John", "last_name": "Kerry", "other_names": "string", "member_number": "DEMO/001", "auth_token": "CGY7WNU8S8", "visit_type": "OUTPATIENT", "scheme_code": "string", "scheme_name": "string", "payer_code": "string" } ``` ### Response #### Success Response (200) - **status** (string) - The status of the validation (e.g., "Success"). - **message** (string) - A message indicating the result of the validation. - **authorization_guid** (string) - The authorization GUID. - **authorization_date** (string) - The date of the authorization. - **benefit_balance** (integer) - The remaining benefit balance. - **reserved_amount** (integer) - The amount reserved. - **auth_expiry** (string) - The expiry date and time of the authorization. - **auth_status** (string) - The status of the authorization (e.g., "AUTHORIZED"). - **copay_value** (integer) - The copay value. - **copay_type** (string) - The type of copay (e.g., "FLAT"). - **member_number** (string) - The member's number. - **member_name** (string) - The member's full name. - **scheme_name** (string) - The name of the scheme. - **service_type** (string) - The type of service. - **is_wellness_member** (boolean) - Indicates if the member is a wellness member. #### Response Example ```json { "status": "Success", "message": "Successful validation of authorization token", "authorization_guid": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "authorization_date": "2023-04-15T05:11:52.980845Z", "benefit_balance": 30000, "reserved_amount": 0, "auth_expiry": "2023-04-17T08:11:52.686677+03:00", "auth_status": "AUTHORIZED", "copay_value": 800, "copay_type": "FLAT", "member_number": "DEMO/001", "member_name": "John Kerry", "scheme_name": "Muungano Scheme", "service_type": "OUTPATIENT", "is_wellness_member": true } ``` ``` -------------------------------- ### Health CRM Profile Response Source: https://web.healthcloud.sh/api-reference Example response from Health CRM after successfully posting a profile. It includes an ID that can be used to retrieve the assigned Health ID. ```json { "id": "85979e5f-3c20-4f5f-bf52-eec658bd27e9", "first_name": "John", "last_name": "Doe", "other_name": "Brian", "gender": "MALE", "date_of_birth": "1998-02-03", "slade_code": 1234, "service_name": "SLADE_ADVANTAGE", "contacts": [ { "id": "3c94df07-7552-4b60-9f2c-63344850", "contact_type": "PHONE_NUMBER", "contact_value": "+254719158559", "valid_from": null, "valid_to": null, "verified": true, "created": "2023-07-18T10:18:25.525859+03:00", "updated": "2023-07-18T10:18:25.525881+03:00", "source": "Slade Advantage", "label": "Phone Number" } ], "identifiers": [ { "id": "725fc654-9cbb-3dcf-9d3d-4c6f928faddb", "identifier_type": "PATIENT_NO", "identifier_value": "GH-53847234", "valid_from": null, "valid_to": null, "verified": true, "created": "2023-07-18T10:18:25.611068+03:00", "updated": "2023-07-18T10:18:25.611076+03:00", "source": "Slade Advantage", "label": "Patient Number" } ], "service": { "id": "3b27d817-352e-4b36-8630-5218fbceca92", "name": "SLADE_ADVANTAGE", "label": "Slade Advantage", "code": "01", "callback_url": "https://api.advantage.release.slade360edi.com/api/patients/patients/set_health_id/", "description": "It is a comprehensive software solution that streamlines and enhances the operations of MSPs (Medical Service Providers)." }, "enrolment_date": "2018-02-03", "service_account_number": "GH-53847234" } ``` -------------------------------- ### Successful Balance Reservation Response Source: https://web.healthcloud.sh/api-reference This is a sample successful response (200 OK) after creating a balance reservation. It includes details of the reservation. ```json { "id": 123, "providerName": "string", "guid": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "replicated": "2022-05-27T14:58:16.163579+03:00", "beneficiaryCode": "string", "policyNumber": "string", "policyEffectiveDate": "string", "payerSladeCode": 0, "authorization": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "invoiceNumber": "string", "providerSladeCode": 0, "amount": 0, "benefitCode": "string", "parentBenefitCode": "string", "benefit": "string", "dateReserved": "string", "amountReleased": 0, "dateReleased": "string", "releasedBy": "string", "reservedVia": "string", "expiryDate": "string", "releaseNotes": "string", "payerInvoiceReference": "string" } ``` -------------------------------- ### Credit Note Response Sample Source: https://web.healthcloud.sh/api-reference This is a sample successful response (200 OK) when submitting a credit note. It returns the details of the created credit note. ```json { "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "invoice_number": "CRN 123", "invoice_date": "2021-03-15T22:01:00Z", "lines": [ { "item_code": "C012", "item_name": "Panadol", "charge_date": "2021-03-15T22:01:00Z", "unit_price": 200, "quantity": 2, "line_copay": 250, "discount": 60, "line_number": 1, "is_cancellation": false } ] } ``` -------------------------------- ### Get Specific Remittance Source: https://web.healthcloud.sh/api-reference Retrieves a specific claim remittance for a medical provider using the claim ID. Requires OAuth2 authorization. ```json { "provider_invoice_no": "INV123", "proposed_amount": 200000.34, "approved_amount": 202100.6, "balanced_paid_amount": 1500.23, "balance_invoiced_amount": 4000.3, "copay_amount": 250, "provider": 125 } ``` -------------------------------- ### Member Eligibility Response Sample Source: https://web.healthcloud.sh/api-reference This is a sample JSON response for a successful retrieval of member eligibility and cover details. It includes information about the member, their cover, and available benefits. ```json { "eligibilityTime": "2023-03-15T10:24:37.138676Z", "member": { "id": 636561, "beneficiaryCode": "DEMO/001", "title": "Mr", "names": "John Kerry", "gender": "M", "dateOfBirth": "1989-12-31T21:00:00Z", "isVip": false, "isPrincipal": true, "principalMember": null, "principalRelationship": null, "contacts": [ { "id": 1, "contactValue": "+254790830838" } ], "group": "Muungano Scheme", "category": "CAT A", "categoryCode": "CAT A", "isActive": true, "isEnrolled": true }, "cover": { "policyNumber": "POL/001", "schemeCode": "POL/001", "schemeName": "Muungano Scheme", "status": "LIVE", "validFrom": "2023-01-01T00:00:00+03:00", "validTo": "2050-01-01T00:00:00+03:00" }, "benefits": [ { "benefitCode": 340, "availableBalance": 500000, "benefitLimit": 500000, "benefitName": "Inpatient shared", "benefitType": "INPATIENT", "copayValue": 500, "copayType": "FLAT", "copayAppliesTo": [ "CONSULTATION" ], "status": "AVAILABLE", "errors": [ ], "visitLimit": 15000, "reservedAmount": 0 } ] } ``` -------------------------------- ### Get Health ID Response Source: https://web.healthcloud.sh/api-reference Response containing the unique Health ID after a successful retrieval from Health CRM. This ID is assigned to a unique person. ```json { "profile_id": "85979e5f-3c20-4f5f-bf52-bd27e9", "health_id": 1234010000000013 } ``` -------------------------------- ### create_balance_reservation Source: https://web.healthcloud.sh/api-reference Creates a balance reservation for a member's benefit balance. It is recommended to make reservations for every service to prevent claim rejections due to overutilization. ```APIDOC ## POST /balances/reservations/reserve_from_authorization/ ### Description Create a balance reservation. ### Method POST ### Endpoint https://provider-edi-api.multitenant.slade360.co.ke/v1/balances/reservations/reserve_from_authorization/ ### Authorizations _oauth2_sec_ ### Request Body schema application/json - **authorization** (string) - Required - The `edi_auth_guid` returned in the start visit response. - **invoice_number** (string) - The invoice number for the anticipated bill. - **amount** (number ) - Required - Amount to be reserved from the member's benefit balance. ### Request Example ```json { "authorization": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "invoice_number": "ORE1234/22", "amount": 2500 } ``` ### Responses #### Success Response (200) Response after successfully creating a balance reservation. - **id** (number) - Description - **providerName** (string) - Description - **guid** (string) - Description - **replicated** (string) - Description - **beneficiaryCode** (string) - Description - **policyNumber** (string) - Description - **policyEffectiveDate** (string) - Description - **payerSladeCode** (number) - Description - **authorization** (string) - Description - **invoiceNumber** (string) - Description - **providerSladeCode** (number) - Description - **amount** (number) - Description - **benefitCode** (string) - Description - **parentBenefitCode** (string) - Description - **benefit** (string) - Description - **dateReserved** (string) - Description - **amountReleased** (number) - Description - **dateReleased** (string) - Description - **releasedBy** (string) - Description - **reservedVia** (string) - Description - **expiryDate** (string) - Description - **releaseNotes** (string) - Description - **payerInvoiceReference** (string) - Description #### Response Example ```json { "id": 123, "providerName": "string", "guid": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "replicated": "2022-05-27T14:58:16.163579+03:00", "beneficiaryCode": "string", "policyNumber": "string", "policyEffectiveDate": "string", "payerSladeCode": 0, "authorization": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "invoiceNumber": "string", "providerSladeCode": 0, "amount": 0, "benefitCode": "string", "parentBenefitCode": "string", "benefit": "string", "dateReserved": "string", "amountReleased": 0, "dateReleased": "string", "releasedBy": "string", "reservedVia": "string", "expiryDate": "string", "releaseNotes": "string", "payerInvoiceReference": "string" } ``` #### Error Responses - **400** Bad Request - **401** Unauthorized - **404** Object Not Found - **500** Internal Server Error ``` -------------------------------- ### Get Specific Claim Remittance Source: https://web.healthcloud.sh/api-reference Retrieve a specific claim remittance for a given medical provider using the claim ID. This endpoint requires OAuth2 authentication. ```APIDOC ## GET /remittances/claim_remittance/ ### Description Retrieve a specific claim remittance for a specific medical provider. ### Method GET ### Endpoint https://provider-edi-api.multitenant.slade360.co.ke/v1/remittances/claim_remittance/ ### Authorizations _oauth2_sec_ ### Parameters #### Query Parameters - **claim_id** (integer) - Required - Claim ID referencing the ClaimRemittance. ### Responses #### Success Response (200) A specific ClaimRemittance as a JSON object. ```json { "provider_invoice_no": "INV123", "proposed_amount": 200000.34, "approved_amount": 202100.6, "balanced_paid_amount": 1500.23, "balance_invoiced_amount": 4000.3, "copay_amount": 250, "provider": 125 } ``` #### Error Responses - **400**: Bad request - **401**: Unauthorized - **404**: Resource not found - **500**: Internal server error ``` -------------------------------- ### start_visit_via_otp Source: https://web.healthcloud.sh/api-reference Creates a medical visit for an authenticated member using an One-Time Password (OTP). This endpoint is used after a member has been successfully looked up and authenticated. ```APIDOC ## POST /authorizations/start_visit/ ### Description Creates a medical visit for an insured member already authenticated using OTP. This endpoint is used after a member has been successfully looked up and authenticated. ### Method POST ### Endpoint https://is-api.multitenant.slade360.co.ke/v1/authorizations/start_visit/ ### Parameters #### Request Body - **beneficiary_id** (integer) - Required - The `member['id']` value from the member's eligibility response. - **factors** (Array of strings) - Required - Methods used to authenticate the member. `['OTP']` - **benefit_type** (string) - Required - The `benefits[index]['benefitType']` value from the member's eligibility response. - **benefit_code** (string) - Required - The `benefits[index]['benefitCode']` value from the member's eligibility response. - **policy_number** (string) - Required - The `cover['policyNumber']` value from the member's eligibility response. - **policy_effective_date** (string) - Required - The `cover['validFrom']` value from the member's eligibility response. - **otp** (integer) - Required - An OTP code sent to the member's phone number. - **beneficiary_contact** (string) - Required - The member's phone number used when requesting for the OTP. - **scheme_name** (string) - Optional - The name of the scheme. - **scheme_code** (string) - Optional - The code of the scheme. ### Request Example ```json { "beneficiary_id": 1, "factors": [ "OTP" ], "benefit_type": "OUTPATIENT", "benefit_code": 340, "policy_number": 1334993, "policy_effective_date": "2022-01-17T00:00:00+03:00", "otp": 913180, "beneficiary_contact": "254712345678", "scheme_name": "string", "scheme_code": "string" } ``` ### Response #### Success Response (200) - **detail** (string) - A message indicating the success of the operation. - **edi_auth_id** (integer) - The EDI authorization ID. - **edi_auth_guid** (string) - The EDI authorization GUID. - **member_number** (integer) - The member's number. - **first_name** (string) - The member's first name. - **last_name** (string) - The member's last name. - **auth_token** (string) - The authorization token for subsequent operations. #### Response Example ```json { "detail": "Authorization for Paul Mutinda successfully created", "edi_auth_id": 17387, "edi_auth_guid": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "member_number": 1234567, "first_name": "string", "last_name": "string", "auth_token": "234567-5TFHXF" } ``` ``` -------------------------------- ### Submit Invoice Attachment Response Source: https://web.healthcloud.sh/api-reference This is a sample successful response (200 OK) when submitting an invoice attachment. It returns details of the created attachment. ```json { "id": "682690b6-7b09-4025-b90d-adedea3d1a91", "invoice": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "created": "2021-03-22T13:36:38.926093Z", "updated": "2021-03-22T13:36:38.926093Z", "business_partner": 2, "title": "Invoice scan for John.", "description": "Invoice scan for John.", "data": "/path/to/file" } ``` -------------------------------- ### Create Medical Claim Response Source: https://web.healthcloud.sh/api-reference This is a sample successful response (200 OK) after creating a medical claim. It includes details of the created claim. ```json { "id": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "created": "2021-03-22T13:36:38.926093Z", "updated": "2021-03-22T13:36:38.926093Z", "business_partner": 2, "payer_code": 457, "payer_name": "Jubilee Health Insurance Company", "patient_name": "John Doe", "patient_number": "P12345", "member_number": 1362049, "location_code": "T01", "location_name": "Town", "service_type": "OUTPATIENT", "scheme_code": 288918, "scheme_name": "SIL Scheme", "visit_number": "V029122", "visit_start": "2021-03-12T21:00:00Z", "visit_end": "2021-03-12T21:00:00Z", "icd10_codes": [ { "code": "J10", "name": "Influenza" } ], "currency": "KES", "authorization_code": "234567-5TFHXF", "claim_id": 11672, "workflow_state": "PENDING", "attributes": null } ``` -------------------------------- ### Create Balance Reservation Payload Source: https://web.healthcloud.sh/api-reference This is the JSON payload used to create a new balance reservation. Ensure all required fields are included. ```json { "authorization": "35b36a8a-6799-4ab5-81d8-1635adef3a6b", "invoice_number": "ORE1234/22", "amount": 2500 } ``` -------------------------------- ### Submit Claim Attachment Source: https://web.healthcloud.sh/api-reference Upload supporting documents for a claim by making a POST request. Claim attachments include documents like claim forms, preauthorization forms, and lab requests. ```APIDOC ## POST /claim_attachments/upload_attachment/ ### Description Upload supporting documents for a claim. This endpoint accepts claim forms, preauthorization forms, prescriptions, lab orders, imaging orders, and other relevant documents. ### Method POST ### Endpoint https://is-api.multitenant.slade360.co.ke/v1/claim_attachments/upload_attachment/ ### Authorization _oauth2_sec_ ### Parameters #### Request Body schema: application/json - **claim** (string) - Required - The `id` field retrieved from the create_claim response, `claim['id']`. - **attachment** (string) - Required - The file attachment to be submitted (A file blob). - **attachment_type** (string) - Required - Enum: "CLAIM_FORM" "PREAUTH_FORM" "PRESCRIPTION" "LAB_ORDER" "IMAGING_ORDER" "OTHER". - **description** (string) - Optional - Text description for the uploaded file. ### Request Example ```json { "claim": "5a736bc8-3be6-4cf2- 9311-be4b42dd0e70", "attachment": "/path/to/file.pdf;type=application/pdf", "attachment_type": "CLAIM_FORM", "description": "Claim form for John." } ``` ### Responses #### Success Response (200) Returns the created claim attachment as a JSON object. - **id** (string) - Description - **claim** (string) - Description - **created** (string) - Description - **updated** (string) - Description - **business_partner** (integer) - Description - **title** (string) - Description - **description** (string) - Description - **attachment_type** (string) - Description - **data** (string) - Description #### Response Example (200) ```json { "id": "682690b6-7b09-4025-b90d-adedea3d1a91", "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "created": "2021-03-12T21:00:00Z", "updated": "2021-03-12T21:00:00Z", "business_partner": 2, "title": "Claim form for John.", "description": "Claim form for John.", "attachment_type": "CLAIM_FORM", "data": "/path/to/file" } ``` #### Error Responses - **400** Bad request - **401** Unauthorized - **404** Resource not found - **500** Internal server error ``` -------------------------------- ### Claim Attachment Response (200 OK) Source: https://web.healthcloud.sh/api-reference This is a successful response when a claim attachment is created. It includes details of the uploaded attachment and its associated claim. ```json { "id": "682690b6-7b09-4025-b90d-adedea3d1a91", "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "created": "2021-03-12T21:00:00Z", "updated": "2021-03-12T21:00:00Z", "business_partner": 2, "title": "Claim form for John.", "description": "Claim form for John.", "attachment_type": "CLAIM_FORM", "data": "/path/to/file" } ``` -------------------------------- ### get_access_token Source: https://web.healthcloud.sh/api-reference Retrieve an access_token from the authorization server. This token will be used to authorize all API calls to the resource servers. ```APIDOC ## POST /oauth2/token/ ### Description Retrieve an `access_token` from the authorization server. This token will be used to authorize all API calls to the resource servers. ### Method POST ### Endpoint https://accounts.multitenant.slade360.co.ke/oauth2/token/ ### Parameters #### Request Body - **grant_type** (string) - Required - The type of grant to use (e.g., "password", "refresh_token"). - **client_id** (string) - Required - A unique identifier for your application on the authorization server. - **client_secret** (string) - Required - A private secret for your application. - **username** (string) - Optional - A registered user's email address (used with grant_type "password"). - **password** (string) - Optional - A registered user's password (used with grant_type "password"). ### Request Example ```json { "grant_type": "password", "client_id": "TTxh4hr0NeyBR7HAlZnLSlO9CWXfwoHnIUaqWQli", "client_secret": "77vejSg0ohd75U9TtAVcPrfg1WWfBNqrhIVzOYk7e...", "username": "test@mail.com", "password": "string" } ``` ### Response #### Success Response (200) - **token_type** (string) - The type of token (e.g., "Bearer"). - **access_token** (string) - The access token for API authorization. - **scope** (string) - The scopes granted with the token. - **refresh_token** (string) - A token to refresh the access token. - **expires_in** (integer) - The time in seconds until the access token expires. #### Response Example ```json { "token_type": "Bearer", "access_token": "A3wOnHxC5AcVbndTz3PR7RjRbYN", "scope": "auth.bp_read auth.bp_write", "refresh_token": "BytsnHxC5AcVbndTz3PR7RjRbty", "expires_in": 3600 } ``` ``` -------------------------------- ### Logged-In User Response Source: https://web.healthcloud.sh/api-reference A successful response for retrieving user information includes details such as ID, email, name, and organizational details. This response is returned with a 200 status code. ```json { "id": 0, "guid": "string", "email": "string", "first_name": "string", "last_name": "string", "other_names": "string", "is_staff": "string", "is_active": "string", "permissions": "string", "organisation": "string", "business_partner": "string", "roles": "string", "bp_type": "string", "allowed_scopes": "string" } ``` -------------------------------- ### Submit Invoice Source: https://web.healthcloud.sh/api-reference Submits a complete invoice with details of claim, invoice number, date, copays, and line items. Requires OAuth2 authorization. ```APIDOC ## POST /invoices/ ### Description Submit a complete invoice. ### Method POST ### Endpoint https://is-api.multitenant.slade360.co.ke/v1/invoices/ ### Authorizations _oauth2_sec_ ### Request Body #### Schema application/json - **claim** (string) - Required - A unique identifier for a previously created claim, `claim['id']` - **invoice_number** (string) - Required - Provider invoice number - **invoice_date** (string) - Required - An ISO 8601 timestamp of when the invoice was raised. - **copays** (Array of objects) - Optional - Copay information. - **copay_type** (string) - Required - Type of copay (e.g., "SELF_PAY") - **copay_amount** (number) - Required - The amount of the copay - **lines** (Array of objects) - Required - Specific invoice lines / bill items - **item_code** (string) - Required - Code for the item - **item_name** (string) - Required - Name of the item - **charge_date** (string) - Required - ISO 8601 timestamp of when the charge was made - **unit_price** (number) - Required - The price per unit - **quantity** (number) - Required - The number of units - **line_copay** (number) - Optional - Copay amount for this line item - **discount** (number) - Optional - Discount amount for this line item - **line_number** (number) - Required - The line item number - **is_cancellation** (boolean) - Required - Indicates if this line is a cancellation ### Request Example ```json { "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "invoice_number": "INV123", "invoice_date": "2021-03-15T22:01:00Z", "copays": [ { "copay_type": "SELF_PAY", "copay_amount": 1500 } ], "lines": [ { "item_code": "C012", "item_name": "Panadol", "charge_date": "2021-03-15T22:01:00Z", "unit_price": 200, "quantity": 2, "line_copay": 250, "discount": 60, "line_number": 1, "is_cancellation": false } ] } ``` ### Responses #### Success Response (200) Returns the created invoice as a JSON object. - **claim** (string) - Unique identifier for the claim. - **invoice_number** (string) - Provider invoice number. - **invoice_date** (string) - ISO 8601 timestamp of when the invoice was raised. - **copays** (Array of objects) - Copay information. - **copay_type** (string) - Type of copay. - **copay_amount** (number) - The amount of the copay. - **lines** (Array of objects) - Specific invoice lines / bill items. - **item_code** (string) - Code for the item. - **item_name** (string) - Name of the item. - **charge_date** (string) - ISO 8601 timestamp of when the charge was made. - **unit_price** (number) - The price per unit. - **quantity** (number) - The number of units. - **line_copay** (number) - Copay amount for this line item. - **discount** (number) - Discount amount for this line item. - **line_number** (number) - The line item number. - **is_cancellation** (boolean) - Indicates if this line is a cancellation. #### Response Example (200) ```json { "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "invoice_number": "INV123", "invoice_date": "2021-03-15T22:01:00Z", "copays": [ { "copay_type": "SELF_PAY", "copay_amount": 1500 } ], "lines": [ { "item_code": "C012", "item_name": "Panadol", "charge_date": "2021-03-15T22:01:00Z", "unit_price": 200, "quantity": 2, "line_copay": 250, "discount": 60, "line_number": 1, "is_cancellation": false } ] } ``` #### Error Responses - **400** - Bad request - **401** - Unauthorized - **404** - Resource not found - **500** - Internal server error ``` -------------------------------- ### Retrieve Member Eligibility (CLI) Source: https://web.healthcloud.sh/api-reference Use this command to retrieve medical cover details for a specific member. Ensure you replace placeholder values with actual member and payer identifiers. ```bash curl https://provider-edi-api.multitenant.slade360.co.ke/v1/beneficiaries/member_eligibility/?member_number=1234567&payer_slade_code=457 \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer xusWuHUK0RibYYZRswJKUQIIfuiwf1" ``` -------------------------------- ### Submit Invoice Payload Source: https://web.healthcloud.sh/api-reference This is a sample JSON payload for submitting a complete invoice. It includes claim details, invoice information, copays, and individual line items. ```json { "claim": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "invoice_number": "INV123", "invoice_date": "2021-03-15T22:01:00Z", "copays": [ { "copay_type": "SELF_PAY", "copay_amount": 1500 } ], "lines": [ { "item_code": "C012", "item_name": "Panadol", "charge_date": "2021-03-15T22:01:00Z", "unit_price": 200, "quantity": 2, "line_copay": 250, "discount": 60, "line_number": 1, "is_cancellation": false } ] } ``` -------------------------------- ### Request OTP via API Source: https://web.healthcloud.sh/api-reference Use this snippet to send an OTP to a member's registered phone number. Ensure you have the correct contact ID and authorization token. ```javascript const url = "https://provider-edi-api.multitenant.slade360.co.ke/v1/beneficiaries/beneficiary_contacts/5531/send_otp/" const headers = { "Accept": "*/*", "Authorization": "Bearer vWhUbs3ZPbbgT1R18VqIi2JtXiXx1e", "Content-Type": "application/json"} fetch(url, {method: "POST", headers}) .then(response => response.json( )) .then(data => console.log(data)) .catch(error => { console.log(error) }) ``` -------------------------------- ### Create Claim Source: https://web.healthcloud.sh/api-reference Creates a new medical claim. This endpoint requires specific payer, patient, visit, and diagnosis information. ```APIDOC ## POST /claims/ ### Description Create a medical claim. This endpoint is used to submit new medical visit information for processing. ### Method POST ### Endpoint https://is-api.multitenant.slade360.co.ke/v1/claims/ ### Parameters #### Request Body - **payer_code** (integer) - Required - Unique payer identifier on slade. - **payer_name** (string) - Required - Name of the payer. - **patient_name** (string) - Required - The member's name as recorded by the medical provider. - **member_number** (string) - Required - For members authorized via slade360, this will be the `auth_token` retrieved from a successful call to the authorization endpoint. For Non-wellness members (Members using cards not provided by Slade), use the actual member number printed on the member's insurance card. - **scheme_name** (string) - Required - The scheme name as recorded by the medical provider. - **visit_number** (string) - Required - The medical visit number. - **visit_start** (string) - Required - An ISO 8601 timestamp of when the visit started. - **visit_end** (string) - Required - An ISO 8601 timestamp of when the visit ended. - **icd10_codes** (Array of objects) - Required - An array of medical diagnoses for the member. - **code** (string) - Required - The ICD-10 code. - **name** (string) - Required - The name of the diagnosis. - **location_code** (string) - Optional - Provider location code. - **location_name** (string) - Optional - Provider location name. - **scheme_code** (string) - Optional - The member's scheme code. ### Request Example ```json { "payer_code": 457, "payer_name": "Jubilee Health Insurance Company", "patient_name": "John Doe", "member_number": "234567-5TFHXF", "scheme_name": "SIL Scheme", "visit_number": "V029122", "visit_start": "2021-03-12T21:00:00Z", "visit_end": "2021-03-12T21:00:00Z", "icd10_codes": [ { "code": "J10", "name": "Influenza" } ], "location_code": "T01", "location_name": "Town", "scheme_code": "2453" } ``` ### Response #### Success Response (200) Returns the created claim as a JSON response. - **id** (string) - Unique identifier for the claim. - **created** (string) - Timestamp when the claim was created. - **updated** (string) - Timestamp when the claim was last updated. - **business_partner** (integer) - Identifier for the business partner associated with the claim. - **payer_code** (integer) - Unique payer identifier. - **payer_name** (string) - Name of the payer. - **patient_name** (string) - The member's name. - **patient_number** (string) - The member's number. - **member_number** (integer) - The member's insurance number. - **location_code** (string) - Provider location code. - **location_name** (string) - Provider location name. - **service_type** (string) - Type of service provided. - **scheme_code** (integer) - The member's scheme code. - **scheme_name** (string) - The member's scheme name. - **visit_number** (string) - The medical visit number. - **visit_start** (string) - Timestamp of when the visit started. - **visit_end** (string) - Timestamp of when the visit ended. - **icd10_codes** (Array of objects) - Array of medical diagnoses. - **code** (string) - The ICD-10 code. - **name** (string) - The name of the diagnosis. - **currency** (string) - Currency used for the claim. - **authorization_code** (string) - Authorization code for the claim. - **claim_id** (integer) - Unique identifier for the claim. - **workflow_state** (string) - Current state of the claim in the workflow. - **attributes** (any) - Additional attributes associated with the claim. #### Response Example ```json { "id": "5a736bc8-3be6-4cf2-9311-be4b42dd0e70", "created": "2021-03-22T13:36:38.926093Z", "updated": "2021-03-22T13:36:38.926093Z", "business_partner": 2, "payer_code": 457, "payer_name": "Jubilee Health Insurance Company", "patient_name": "John Doe", "patient_number": "P12345", "member_number": 1362049, "location_code": "T01", "location_name": "Town", "service_type": "OUTPATIENT", "scheme_code": 288918, "scheme_name": "SIL Scheme", "visit_number": "V029122", "visit_start": "2021-03-12T21:00:00Z", "visit_end": "2021-03-12T21:00:00Z", "icd10_codes": [ { "code": "J10", "name": "Influenza" } ], "currency": "KES", "authorization_code": "234567-5TFHXF", "claim_id": 11672, "workflow_state": "PENDING", "attributes": null } ``` #### Error Responses - **400** Bad request - **401** Unauthorized - **404** Resource not found - **500** Internal server error ```