### Authorization Header Examples Source: https://kipuapi.kipuworks.com/api-docs/index.html Examples of the Authorization header format for SHA-256 and SHA-1 signatures. ```text APIAuth-HMAC-SHA256 8s6lf46sG7UkIco9zIPM1S0VdoYSexampleauthJAn0:vIu4TeSNSA3kv/OlTO68oSExIEo= ``` ```text APIAuth 8s6lf46sG7UkIco9zIPM1S0VdoYSexampleauthJAn0:vIu4TeSNSA3kv/OlTO68oSExIEo= ``` -------------------------------- ### Canonical String Examples Source: https://kipuapi.kipuworks.com/api-docs/index.html Examples of canonical strings used to generate the HMAC signature for POST and GET requests. ```text application/json,VpofNeoRAzRvCD/YjO1mSw==,/api/patients,Wed, 06 Nov 201915:38:34 GMT ``` ```text ,,/api/patients/census?phi_level=high &app_id=OFZdZaTiCgy5gZnjnpo-Y7pFNoQvgsLJvtQSPJpWJNM,Thu,07 Nov 2019 20:08:59 GMT ``` -------------------------------- ### Content-MD5 Header Example Source: https://kipuapi.kipuworks.com/api-docs/index.html Example of a Base64 encoded MD5 digest for request bodies. ```text VpofNeoRAzRvCD/YjO1mSw== ``` -------------------------------- ### GET /episodes/processes Source: https://kipuapi.kipuworks.com/api-docs/index.html Lists all patient processes. ```APIDOC ## GET /episodes/processes ### Description Lists all patient processes. ### Method GET ### Endpoint /episodes/processes ``` -------------------------------- ### GET /users Source: https://kipuapi.kipuworks.com/api-docs/index.html List all Users. ```APIDOC ## GET /users ### Description List all Users. ### Method GET ### Endpoint /users ``` -------------------------------- ### GET /patient_programs Source: https://kipuapi.kipuworks.com/api-docs/index.html Lists all patient programs. ```APIDOC ## GET /patient_programs ### Description Lists all patient programs. ### Method GET ### Endpoint /patient_programs ``` -------------------------------- ### Date Header Example Source: https://kipuapi.kipuworks.com/api-docs/index.html Format for the Date header using RFC 1123. ```text Wed, 06 Nov 2019 15:38:34 GMT ``` -------------------------------- ### GET /episodes/occupancy Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves current occupancy data for episodes. ```APIDOC ## GET /episodes/occupancy ### Description Retrieves current occupancy data for episodes. ### Method GET ### Endpoint /episodes/occupancy ``` -------------------------------- ### GET /group_sessions Source: https://kipuapi.kipuworks.com/api-docs/index.html List all group sessions. ```APIDOC ## GET /group_sessions ### Description List all group sessions. ### Method GET ### Endpoint /group_sessions ``` -------------------------------- ### GET /users/{user_id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Fetch a User Record. ```APIDOC ## GET /users/{user_id} ### Description Fetch a User Record. ### Method GET ### Endpoint /users/{user_id} ### Parameters #### Path Parameters - **user_id** (string) - Required - The ID of the user. ``` -------------------------------- ### GET /episodes/admissions Source: https://kipuapi.kipuworks.com/api-docs/index.html List admissions within a date range. ```APIDOC ## GET /episodes/admissions ### Description List admissions within a date range. ### Method GET ### Endpoint /episodes/admissions ``` -------------------------------- ### GET /contacts/{id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Fetches a contact. ```APIDOC ## GET /contacts/{id} ### Description Fetches a contact. ### Method GET ### Endpoint /contacts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contact. ``` -------------------------------- ### GET /episodes/latest Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves a list of the latest episodes. ```APIDOC ## GET /episodes/latest ### Description Retrieves a list of the latest episodes. ### Method GET ### Endpoint /episodes/latest ``` -------------------------------- ### GET /vaults/episodes Source: https://kipuapi.kipuworks.com/api-docs/index.html Lists all soft-deleted episodes. ```APIDOC ## GET /vaults/episodes ### Description Lists all soft-deleted episodes. ### Method GET ### Endpoint /vaults/episodes ``` -------------------------------- ### Multipart POST Request Example Source: https://kipuapi.kipuworks.com/api-docs/index.html A sample structure for a multipart/form-data POST request containing patient data and an image attachment. ```HTTP --MultipartBoundary Content-Disposition: form-data; name="document[recipient_id]" --MultipartBoundary Content-Disposition: form-data; name="document[data][first_name]" John --MultipartBoundary Content-Disposition: form-data; name="document[data][last_name]" Doe --MultipartBoundary Content-Disposition: form-data; name="document[data][dob]" 1909-09-09 --MultipartBoundary Content-Disposition: form-data; name="document[data][insurances_attributes][0][insurance_company]" Sample Insurance Company --MultipartBoundary Content-Disposition: form-data; name="document[data][insurances_attributes][0][subscriber_first_name]" John --MultipartBoundary Content-Disposition: form-data; name="document[data][insurances_attributes][0][subscriber_last_name]" Doe --MultipartBoundary Content-Disposition: form-data; name="document[data][insurances_attributes][0][origin_id]" 1 --MultipartBoundary Content-Disposition: form-data; name="document[data][patient_contacts_attributes][0][first_name]" Richard James --MultipartBoundary Content-Disposition: form-data; name="document[data][patient_contacts_attributes][0][last_name]" Perez Montero --MultipartBoundary Content-Disposition: form-data; name="document[data][patient_contacts_attributes][0][phone]" (555) 555-5555 --MultipartBoundary Content-Disposition: form-data; name="document[attachments_attributes][0][attachment_name]" 12345 --MultipartBoundary Content-Disposition: form-data; name="document[attachments_attributes][0][attachment_evaluation_item_id]" patient_image --MultipartBoundary Content-Disposition: form-data; name="document[attachments_attributes][0][attachment]"; filename="client_id.jpg" Content-type: image/jpeg --MultipartBoundary-- ``` -------------------------------- ### API Response Examples Source: https://kipuapi.kipuworks.com/api-docs/index.html Standard JSON response formats for successful requests and common authentication or authorization errors. ```json { "status" : "Delivered" } ``` ```json { "error" : "Authentication Failed" } ``` ```json { "error" : "Access Denied" } ``` -------------------------------- ### GET /episodes/{episode_id}/patient_diets Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the list of patient diets for an episode. ```APIDOC ## GET /episodes/{episode_id}/patient_diets ### Description Retrieves the list of patient diets for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/patient_diets ``` -------------------------------- ### GET /episodes/{episode_id}/ur Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves utilization reviews for an episode. ```APIDOC ## GET /episodes/{episode_id}/ur ### Description Retrieves utilization reviews for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/ur ``` -------------------------------- ### Locations (GET) Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves a list of available locations. ```APIDOC ## GET /locations ### Description Retrieves a list of available locations. ### Method GET ### Endpoint /locations ``` -------------------------------- ### GET /episodes/{episode_id}/glucose_logs Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the list of glucose logs for a specific episode. ```APIDOC ## GET /episodes/{episode_id}/glucose_logs ### Description Retrieves the list of glucose logs for a specific episode. ### Method GET ### Endpoint /episodes/{episode_id}/glucose_logs ``` -------------------------------- ### GET /episodes/{episode_id}/program_history Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the program history for an episode. ```APIDOC ## GET /episodes/{episode_id}/program_history ### Description Retrieves the program history for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/program_history ``` -------------------------------- ### GET /episodes/{episode_id}/group_sessions/{id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves a specific group session for an episode. ```APIDOC ## GET /episodes/{episode_id}/group_sessions/{id} ### Description Retrieves a specific group session for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/group_sessions/{id} ``` -------------------------------- ### GET /episodes/{episode_id}/orthostatic_vital_signs Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the list of orthostatic vital signs for an episode. ```APIDOC ## GET /episodes/{episode_id}/orthostatic_vital_signs ### Description Retrieves the list of orthostatic vital signs for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/orthostatic_vital_signs ``` -------------------------------- ### Care Level (GET) Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the care level information. ```APIDOC ## GET /care_level ### Description Retrieves the care level information. ### Method GET ### Endpoint /care_level ``` -------------------------------- ### GET /episodes/{episode_id}/vital_signs Source: https://kipuapi.kipuworks.com/api-docs/index.html List all vital signs scoped to an episode. ```APIDOC ## GET /episodes/{episode_id}/vital_signs ### Description List all vital signs scoped to an episode. ### Method GET ### Endpoint /episodes/{episode_id}/vital_signs ### Parameters #### Path Parameters - **episode_id** (string) - Required - The ID of the episode. ``` -------------------------------- ### Patient Admissions (GET) Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves a list of patient admissions with optional pagination and detailed attributes. ```APIDOC ## GET /patient_admissions ### Description Retrieves a list of patient admissions. ### Method GET ### Endpoint /patient_admissions ### Parameters #### Query Parameters - **page** (integer) - Optional - Specify page number of current result list - **per** (integer) - Optional - Number of results to return per page - **app_id** (string) - Optional - Also referred to as recipient_id ``` -------------------------------- ### GET /episodes/{episode_id}/group_sessions Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the list of group sessions for a specific episode. ```APIDOC ## GET /episodes/{episode_id}/group_sessions ### Description Retrieves the list of group sessions for a specific episode. ### Method GET ### Endpoint /episodes/{episode_id}/group_sessions ``` -------------------------------- ### GET /episodes/{episode_id}/patient_evaluations Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves the list of patient evaluations for an episode. ```APIDOC ## GET /episodes/{episode_id}/patient_evaluations ### Description Retrieves the list of patient evaluations for an episode. ### Method GET ### Endpoint /episodes/{episode_id}/patient_evaluations ``` -------------------------------- ### GET /episodes/{episode_id}/insurances/{id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Retrieves insurance details for a specific episode. ```APIDOC ## GET /episodes/{episode_id}/insurances/{id} ### Description Retrieves insurance details for a specific episode. ### Method GET ### Endpoint /episodes/{episode_id}/insurances/{id} ``` -------------------------------- ### POST /episodes Source: https://kipuapi.kipuworks.com/api-docs/index.html Create a new episode. ```APIDOC ## POST /episodes ### Description Create a new episode. ### Method POST ### Endpoint /episodes ``` -------------------------------- ### POST /episodes Source: https://kipuapi.kipuworks.com/api-docs/index.html Creates a new episode record. ```APIDOC ## POST /episodes ### Description Creates a new episode record. ### Method POST ### Endpoint /episodes ``` -------------------------------- ### POST /contacts Source: https://kipuapi.kipuworks.com/api-docs/index.html Create a new contact. ```APIDOC ## POST /contacts ### Description Create a new contact. ### Method POST ### Endpoint /contacts ``` -------------------------------- ### API Version and Specification Source: https://kipuapi.kipuworks.com/api-docs/index.html Identifiers for the active API version and documentation format. ```text V4 ``` ```text OAS3 ``` -------------------------------- ### POST /episodes/{episode_id}/patient_evaluations Source: https://kipuapi.kipuworks.com/api-docs/index.html Posts a new patient evaluation for an episode. ```APIDOC ## POST /episodes/{episode_id}/patient_evaluations ### Description Posts a new patient evaluation for an episode. ### Method POST ### Endpoint /episodes/{episode_id}/patient_evaluations ``` -------------------------------- ### Patient Create (POST) Source: https://kipuapi.kipuworks.com/api-docs/index.html Creates a new patient record with various demographic and identification attributes. ```APIDOC ## POST /patients ### Description Creates a new patient record. ### Method POST ### Endpoint /patients ### Parameters #### Request Body - **gender_identity_short** (string) - Optional - Gender identity options including non-binary, no answer, or not sure - **attachment_patient_process_id** (integer) - Optional - Specify a process tab to use for a generic attachment - **subscriber_middle_name** (string) - Optional - Subscriber middle name - **location_id** (integer) - Optional - Location ID - **bed_name** (string) - Optional - Bed name ``` -------------------------------- ### Authentication and Request Headers Source: https://kipuapi.kipuworks.com/api-docs/index.html Details on how to authenticate requests to the Kipu API using HMAC SHA-256 signatures and required HTTP headers. ```APIDOC ## Authentication ### Description All requests to the Kipu API require an encoded signature generated using HMAC SHA-256. The signature is passed in the Authorization header. ### Authorization Header Format `APIAuth-HMAC-SHA256 {access_id}:{Base64 Encoded SHA256 HMAC Signature}` ### Required Headers - **Accept**: `application/vnd.kipusystems+json; version=4` - **Date**: Current date/time in RFC 1123 format (e.g., `Wed, 06 Nov 2019 15:38:34 GMT`) - **Authorization**: The generated HMAC signature - **Content-Type** (POST only): `application/json` or `multipart/form-data` - **Content-MD5** (POST only): Base64 encoded MD5 digest of the request body ### Signature Calculation 1. Build a canonical string: - POST: `Content-Type,Content-MD5,request_uri,Date` - GET: `,,request_uri,Date` 2. Create an HMAC SHA256 hash of the canonical string using your `secret_key`. 3. Perform a strict Base64 encoding of the hash. ``` -------------------------------- ### POST /api/patients Source: https://kipuapi.kipuworks.com/api-docs/index.html Creates a new patient record with optional file attachments using a multipart/form-data request. ```APIDOC ## POST /api/patients ### Description Creates a new patient record. When including attachments, the request must be sent as a multipart/form-data request. ### Method POST ### Endpoint /api/patients ### Request Body - **attachments_attributes** (array) - Optional - List of attachment objects containing metadata and file data. - **data** (object) - Required - Flattened patient data fields (e.g., data[first_name]=John). ### Notes - Supported attachment types: PDF and JPEG. - Request body fields must be www-form-url-encoded and flattened (e.g., {data:{name:"test"}} becomes data[name]=test). - The canonical string for authentication is built from Content-Type, Content-MD5, URI, and Date. ``` -------------------------------- ### PATCH /episodes/{episode_id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Update an episode. ```APIDOC ## PATCH /episodes/{episode_id} ### Description Update an episode. ### Method PATCH ### Endpoint /episodes/{episode_id} ### Parameters #### Path Parameters - **episode_id** (string) - Required - The unique identifier of the episode. ``` -------------------------------- ### POST /episodes/{episode_id}/vital_signs Source: https://kipuapi.kipuworks.com/api-docs/index.html Create a new vital sign for an episode. ```APIDOC ## POST /episodes/{episode_id}/vital_signs ### Description Create a new vital sign for an episode. ### Method POST ### Endpoint /episodes/{episode_id}/vital_signs ### Parameters #### Path Parameters - **episode_id** (string) - Required - The ID of the episode. ``` -------------------------------- ### PATCH /episodes/{episode_id}/ext_id_mappings/{id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Updates an external ID mapping for a specific episode. ```APIDOC ## PATCH /episodes/{episode_id}/ext_id_mappings/{id} ### Description Updates an external ID mapping for a specific episode. ### Method PATCH ### Endpoint /episodes/{episode_id}/ext_id_mappings/{id} ``` -------------------------------- ### Perform Base64 Encoding Source: https://kipuapi.kipuworks.com/api-docs/index.html Encodes the generated HMAC hash into a Base64 string using the CryptoJS library. ```JavaScript signature=CryptoJS.enc.Base64.stringify(hmac) ``` -------------------------------- ### Generate HMAC SHA256 Hash Source: https://kipuapi.kipuworks.com/api-docs/index.html Creates an HMAC encrypted hash using the CryptoJS library for request authentication. ```JavaScript hmac=CryptoJS.HmacSHA256(canonical_string, secret_key) ``` -------------------------------- ### PATCH /contacts/{contact_id} Source: https://kipuapi.kipuworks.com/api-docs/index.html Update a contact. ```APIDOC ## PATCH /contacts/{contact_id} ### Description Update a contact. ### Method PATCH ### Endpoint /contacts/{contact_id} ### Parameters #### Path Parameters - **contact_id** (string) - Required - The unique identifier of the contact. ``` -------------------------------- ### Patient Update (PATCH) Source: https://kipuapi.kipuworks.com/api-docs/index.html Updates an existing patient record. ```APIDOC ## PATCH /patients/:id ### Description Updates an existing patient record. ### Method PATCH ### Endpoint /patients/:id ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the patient to update #### Request Body - **gender_identity_short** (string) - Optional - Gender identity options including non-binary, no answer, or not sure ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.