Heala AI is an advanced health assessment tool powered by Heala, that uses natural language processing (NLP) and machine learning models to provide potential diagnoses, and triage patients to appropriate care pathways, including self-care guidance, teleconsultation with GPs, specialist referrals, or urgent ambulance services. It supports structured input for assessments, allowing interaction through a series of questions that guide the user to provide the necessary data for accurate health assessment.
\nThe Heala AI API base URL is:
\nhttps://ai.heala.io/api\n\nAll requests to the API require an authentication key. The API key should be included in the request headers as follows:
\nx-api-key: \n\nReplace with your actual API key. This key is necessary for accessing the API and ensuring that only authorized users can make requests.
\nCommon error responses include:
\n400 Bad Request
\n404 Not Found
\n500 Internal Server Error
\nIf you have questions, or would like to report an issue, please contact our support at tech@heala.ng. Our team is eager to help you.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13901355","collectionId":"a98ecd7d-5218-4dc1-8196-472380ec815a","publishedId":"2sAXxPBZ2j","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-29T15:22:52.000Z"},"item":[{"name":"Sessions","item":[{"name":"Initialise Session","id":"f9d54b4f-854b-4cb1-b938-d0a03c9d6e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"ABC12345\", //required\n \"email\": \"email@example.com\", //required\n \"phone\": \"08012345678\",\n \"firstName\": \"Jane\", //required\n \"lastName\": \"Doe\", //required\n \"dob\": \"1992-10-20\", //required\n \"sex\": \"female\", //required\n \"assessment_for\": \"self\", // \"dependant\" or \"self\"\n //\"dependant\": \"dependant_1728374352370_570\", // required is assessment_for is dependant\n \"language\":\"English\",\n \"userTimezone\":\"+1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ai.heala.io/api/symptoms/init","description":"This endpoint initializes a new symptom assessment session. It collects necessary information about the patient (or dependent) to begin the symptom assessment process. After initializing the session, the response includes a follow_up_message field where the AI first sends a welcome message. The next_step field is set to symptoms/collect , indicating that the user should use the /collect endpoint to send responses to the AI.
This endpoint collects the patient's responses (symptoms or additional data) during the assessment session. It is used to respond to the initial follow_up_message from the /init endpoint and subsequent messages from the /collect endpoint. Each response must reference the session_id and message_id to ensure continuity in the assessment process. Once the AI gathers enough information, the completion_flag is set to true, and the next_step field updates to /symptoms/end, indicating the session should be finalized using the /end endpoint.
This endpoint finalizes the session and returns a summary of the assessment, including suggested conditions, probabilities, and any relevant notes. This marks the end of the assessment process and ensures that all gathered data is compiled for the user's review. Users cannot end a session if the completion_flag is false.
This endpoint retrieves all previous sessions for a specific user. The response includes details of each session, such as session ID, date of assessment, and a summary of findings.
\nURL Parameters:
\nuser_id: The unique identifier for the user.Query Parameters:
\npage: The page number for pagination (default is 1).
limit: The number of results per page (default is 10).
createdAt: The sort order of the sessions based on the createdAt field. If createdAt is 1, it will sort in ascending order; if -1, it will sort in descending order (default is -1).
status: The status to filter sessions by accordingly.
search: A search term to filter sessions based on specific criteria.
acceptable values are \"ongoing\" or \"completed\"
\n","type":"text/plain"},"key":"status","value":"string"},{"key":"search","value":"string"}],"variable":[{"description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"user_id","key":"user_id"}]}},"response":[{"id":"f3c0f7f8-f71b-4e08-9936-ef79175545a8","name":"Get All User Sessions","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/sessions/user/:user_id?page=1&limit=10&createdAt=-1&status=completed&search=Pains","host":["https://ai.heala.io"],"path":["api","sessions","user",":user_id"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"},{"key":"createdAt","value":"-1"},{"key":"status","value":"completed"},{"key":"search","value":"Pains","type":"text"}],"variable":[{"key":"user_id","value":"user_id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" { \n \"currentPage\": 1,\n \"totalPages\": 1,\n \"totalSessions\": 1,\n \"sessions\": [\n {\n \"principal\": {\n \"user_id\": \"ABC1234\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"_id\": \"67055d244cbacb36deb94a20\",\n \"session_id\": \"session_1728404772076\",\n \"assessment_for\": \"self\",\n \"language\": \"English\",\n \"userTimezone\": \"+1\",\n \"discomfortLevel\": 8,\n \"description\": \"Experiencing sharp, constant pain in the left leg since noon today, especially when sitting for a long time.\",\n \"firstNotice\": \"today\",\n \"messages\": [\n {\n \"message\": \"Hello Jane! I'm Heala AI, here to assist you. Can you tell me more about the symptoms you're experiencing?\",\n \"answer\": \"I am feeling sharp pains in my left leg when I sit sdown for long in a spot\",\n \"message_type\": \"welcome\",\n \"createdAt\": \"2024-10-08T17:26:12.823Z\",\n \"updatedAt\": \"2024-10-08T17:29:21.401Z\",\n \"_id\": \"67055d244cbacb36deb94a27\"\n },\n {\n \"message\": \"On a scale of 1 to 10, how would you rate the discomfort level from the sharp pains in your left leg? When did you first notice these symptoms?\",\n \"answer\": \"8\",\n \"message_type\": \"discomfortLevel\",\n \"createdAt\": \"2024-10-08T17:29:22.240Z\",\n \"updatedAt\": \"2024-10-08T17:30:05.208Z\",\n \"_id\": \"67055de268564bf817c90ace\"\n },\n {\n \"message\": \"Got it, Jane. Along with the sharp pains in your left leg, are you experiencing any other symptoms? It's essential to understand the full picture to provide you with the best guidance.\",\n \"answer\": \"No, that is the only symptm that I am experiencing at the moment\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:30:06.041Z\",\n \"updatedAt\": \"2024-10-08T17:30:43.656Z\",\n \"_id\": \"67055e0e68564bf817c90ad2\"\n },\n {\n \"message\": \"Thank you for sharing that. How long have you been experiencing these sharp pains in your left leg?\",\n \"answer\": \"For today, since noon, but I notice it happens when I have sat downfor so long\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:30:44.261Z\",\n \"updatedAt\": \"2024-10-08T17:31:22.917Z\",\n \"_id\": \"67055e3468564bf817c90ad5\"\n },\n {\n \"message\": \"Thank you for the additional information. Considering the sharp pains in your left leg that you've been experiencing today, could you describe the pain as constant or intermittent?\",\n \"answer\": \"It is a constant pain\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:31:23.649Z\",\n \"updatedAt\": \"2024-10-08T17:31:45.927Z\",\n \"_id\": \"67055e5b68564bf817c90ad8\"\n },\n {\n \"message\": \"Thank you for sharing that, Jane. To summarize, you've been experiencing sharp, constant pain in your left leg since noon today, especially when sitting for a long time. This discomfort level of 8 out of 10. If there is anything else you would like to add or ask, feel free to let me know.\",\n \"answer\": \"You summed it up perfectly\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:31:46.968Z\",\n \"updatedAt\": \"2024-10-08T17:32:13.057Z\",\n \"_id\": \"67055e7268564bf817c90adb\"\n },\n {\n \"message\": \"Based on our conversation, I have the following information: Discomfort level: 8 out of 10, Symptoms noticed since: noon today, Symptoms: Sharp, constant pain in left leg when sitting for long. Thank you for providing this information. Please click the button below to view your full report.\",\n \"answer\": \"\",\n \"message_type\": \"closing\",\n \"createdAt\": \"2024-10-08T17:32:14.359Z\",\n \"updatedAt\": \"2024-10-08T17:32:14.359Z\",\n \"_id\": \"67055e8e68564bf817c90ade\"\n }\n ],\n \"completion_flag\": true,\n \"triage_level\": \"teleconsultation with GP\",\n \"status\": \"completed\",\n \"symptoms\": [\n {\n \"name\": \"Sharp pain in left leg\"\n }\n ],\n \"suggested_conditions\": [],\n \"createdAt\": \"2024-10-08T17:26:12.080Z\",\n \"updatedAt\": \"2024-10-08T17:33:21.220Z\",\n \"__v\": 7\n}"}],"_postman_id":"f5c551cf-0a0e-4115-8d49-84888755996b"},{"name":"Get Single Session","id":"5f57e03d-ffd6-43bf-89f1-d628b89a599d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://ai.heala.io/api/sessions/:session_id","description":"Retrieves details of a single assessment session. The response includes details of each session, such as session ID, date of assessment, and a summary of findings.
\n","urlObject":{"path":["api","sessions",":session_id"],"host":["https://ai.heala.io"],"query":[],"variable":[{"description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"session_id","key":"session_id"}]}},"response":[{"id":"e233b86b-27c5-414c-847e-e97568dbd5f8","name":"Get Single Session","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/sessions/:session_id","host":["https://ai.heala.io"],"path":["api","sessions",":session_id"],"variable":[{"key":"session_id","value":"session_id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"principal\": {\n \"user_id\": \"ABC1234\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"_id\": \"67055d244cbacb36deb94a20\",\n \"session_id\": \"session_1728404772076\",\n \"assessment_for\": \"self\",\n \"language\": \"English\",\n \"userTimezone\": \"+1\",\n \"discomfortLevel\": 8,\n \"description\": \"Experiencing sharp, constant pain in the left leg since noon today, especially when sitting for a long time.\",\n \"firstNotice\": \"today\",\n \"messages\": [\n {\n \"message\": \"Hello Jane! I'm Heala AI, here to assist you. Can you tell me more about the symptoms you're experiencing?\",\n \"answer\": \"I am feeling sharp pains in my left leg when I sit sdown for long in a spot\",\n \"message_type\": \"welcome\",\n \"createdAt\": \"2024-10-08T17:26:12.823Z\",\n \"updatedAt\": \"2024-10-08T17:29:21.401Z\",\n \"_id\": \"67055d244cbacb36deb94a27\"\n },\n {\n \"message\": \"On a scale of 1 to 10, how would you rate the discomfort level from the sharp pains in your left leg? When did you first notice these symptoms?\",\n \"answer\": \"8\",\n \"message_type\": \"discomfortLevel\",\n \"createdAt\": \"2024-10-08T17:29:22.240Z\",\n \"updatedAt\": \"2024-10-08T17:30:05.208Z\",\n \"_id\": \"67055de268564bf817c90ace\"\n },\n {\n \"message\": \"Got it, Jane. Along with the sharp pains in your left leg, are you experiencing any other symptoms? It's essential to understand the full picture to provide you with the best guidance.\",\n \"answer\": \"No, that is the only symptm that I am experiencing at the moment\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:30:06.041Z\",\n \"updatedAt\": \"2024-10-08T17:30:43.656Z\",\n \"_id\": \"67055e0e68564bf817c90ad2\"\n },\n {\n \"message\": \"Thank you for sharing that. How long have you been experiencing these sharp pains in your left leg?\",\n \"answer\": \"For today, since noon, but I notice it happens when I have sat downfor so long\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:30:44.261Z\",\n \"updatedAt\": \"2024-10-08T17:31:22.917Z\",\n \"_id\": \"67055e3468564bf817c90ad5\"\n },\n {\n \"message\": \"Jane, thank you for the additional information. Considering the sharp pains in your left leg that you've been experiencing today, could you describe the pain as constant or intermittent?\",\n \"answer\": \"It is a constant pain\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:31:23.649Z\",\n \"updatedAt\": \"2024-10-08T17:31:45.927Z\",\n \"_id\": \"67055e5b68564bf817c90ad8\"\n },\n {\n \"message\": \"Thank you for sharing that, jane. To summarize, you've been experiencing sharp, constant pain in your left leg since noon today, especially when sitting for a long time. This discomfort level of 8 out of 10. If there is anything else you would like to add or ask, feel free to let me know.\",\n \"answer\": \"You summed it up perfectly\",\n \"message_type\": \"general\",\n \"createdAt\": \"2024-10-08T17:31:46.968Z\",\n \"updatedAt\": \"2024-10-08T17:32:13.057Z\",\n \"_id\": \"67055e7268564bf817c90adb\"\n },\n {\n \"message\": \"Jane, based on our conversation, I have the following information: Discomfort level: 8 out of 10, Symptoms noticed since: noon today, Symptoms: Sharp, constant pain in left bum when sitting for long. Thank you for providing this information. Please click the button below to view your full report.\",\n \"answer\": \"\",\n \"message_type\": \"closing\",\n \"createdAt\": \"2024-10-08T17:32:14.359Z\",\n \"updatedAt\": \"2024-10-08T17:32:14.359Z\",\n \"_id\": \"67055e8e68564bf817c90ade\"\n }\n ],\n \"completion_flag\": true,\n \"triage_level\": \"teleconsultation with GP\",\n \"symptoms\": [\n {\n \"name\": \"Sharp pain in left bum\"\n }\n ],\n \"suggested_conditions\": [],\n \"createdAt\": \"2024-10-08T17:26:12.080Z\",\n \"updatedAt\": \"2024-10-08T17:33:21.220Z\",\n \"__v\": 7\n}"}],"_postman_id":"5f57e03d-ffd6-43bf-89f1-d628b89a599d"}],"id":"021bd1ef-beb7-4adb-8461-10759c69f02e","description":"Sessions refer to individual instances of health assessments initiated by a user or their dependant. Each session encompasses the complete interaction between the patient and the symptom assessment API (Heala AI), capturing all responses, follow-up questions, and gathered data throughout the assessment process.
\n","_postman_id":"021bd1ef-beb7-4adb-8461-10759c69f02e"},{"name":"Patients","item":[{"name":"Principal","item":[{"name":"Create Principal","id":"ad235f0b-42d2-46b6-915c-a4f1151ed580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"string\", // required\n \"email\": \"string\", // required\n \"phone\": \"string\",\n \"firstName\": \"string\", // required\n \"lastName\": \"string\", // required\n \"dob\": \"date\", // required: YYYY-MM-DD\n \"sex\": \"string\" // required: \"male\" or \"female\"\n }","options":{"raw":{"language":"json"}}},"url":"https://ai.heala.io/api/user","description":"This endpoint creates a new principal (a parent or user who is responsible for dependants).
\n","urlObject":{"path":["api","user"],"host":["https://ai.heala.io"],"query":[],"variable":[]}},"response":[{"id":"e88405e6-15f6-4a13-8e1e-ca2c0ae54d90","name":"Create Principal","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"XYZ1234\", \n \"email\": \"example@mail.com\", \n \"phone\": \"123-456-2222\",\n \"firstName\": \"Sammy\", \n \"lastName\": \"White\", \n \"dob\": \"1980-08-30\",\n \"sex\": \"male\"\n }","options":{"raw":{"language":"json"}}},"url":"https://ai.heala.io/api/user"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"XYZ1234\",\n \"email\": \"example@mail.com\",\n \"phone\": \"123-456-2222\",\n \"firstName\": \"Sammy\",\n \"lastName\": \"White\",\n \"dob\": \"1980-08-30T00:00:00.000Z\",\n \"sex\": \"male\",\n \"_id\": \"6705c4999ea03b5a35746dba\",\n \"createdAt\": \"2024-10-09T00:47:37.940Z\",\n \"updatedAt\": \"2024-10-09T00:47:37.941Z\",\n \"__v\": 0\n}"}],"_postman_id":"ad235f0b-42d2-46b6-915c-a4f1151ed580"},{"name":"Get Single Principal","id":"cde543c5-8117-439d-a39a-510a1ef30f6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://ai.heala.io/api/user/:principal_id","description":"This endpoint retrieves details of a single principal.
\n","urlObject":{"path":["api","user",":principal_id"],"host":["https://ai.heala.io"],"query":[],"variable":[{"type":"any","value":"user_id","key":"principal_id"}]}},"response":[{"id":"dc63b80c-c70d-42df-8074-773a87b6ddb3","name":"Get Single Principal","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/user/:principal_id","host":["https://ai.heala.io"],"path":["api","user",":principal_id"],"variable":[{"key":"principal_id","value":"user_id","description":"required"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"670568a443699e4846cdddb4\",\n \"user_id\": \"ABC1234\",\n \"email\": \"email@example.com\",\n \"phone\": \"08012345678\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"dob\": \"1980-01-01T00:00:00.000Z\",\n \"sex\": \"female\",\n \"createdAt\": \"2024-10-08T18:15:16.958Z\",\n \"updatedAt\": \"2024-10-08T19:53:36.544Z\",\n \"__v\": 0\n}"}],"_postman_id":"cde543c5-8117-439d-a39a-510a1ef30f6f"}],"id":"13712a03-2216-43c0-848d-7f49bd1a8410","description":"Principal refers to the primary user of the Heala AI platform, typically an adult responsible for managing health assessments.
\n","_postman_id":"13712a03-2216-43c0-848d-7f49bd1a8410"},{"name":"Dependants","item":[{"name":"Create Dependant","id":"a296a6fc-59ac-4ef1-8bc0-22aef50edc1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\", // required\n \"lastName\": \"string\", // required\n \"relationship\": \"string\", // required: could be 'Child', 'Spouse', 'Parent', 'Sibling', 'Other'\n \"dob\": \"date\", // required: YYYY-MM-DD \n \"sex\": \"string\", // required: \"male\" or \"female\"\n \"principal\": {\n \"user_id\": \"string\", // required\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"dob\": \"string\",\n \"sex\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ai.heala.io/api/dependants","description":"This endpoint allows a principal to add a dependant to their account.
\n","urlObject":{"path":["api","dependants"],"host":["https://ai.heala.io"],"query":[],"variable":[]}},"response":[{"id":"d5bcc44d-8f41-4704-a5e4-e6117838367b","name":"Create Dependant","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Jame\",\n \"lastName\": \"Doe\",\n \"relationship\": \"Child\",\n \"dob\": \"2022-12-03\", \n \"sex\": \"male\",\n \"principal\": {\n \"user_id\": \"ABC12345\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ai.heala.io/api/dependants"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Dependant created successfully.\",\n \"dependant\": {\n \"user_id\": \"dependant_1728424299118_2\",\n \"principal\": \"ABC1234\",\n \"firstName\": \"James\",\n \"lastName\": \"Doe\",\n \"relationship\": \"Child\",\n \"dob\": \"2022-12-03T00:00:00.000Z\",\n \"sex\": \"male\",\n \"createdAt\": \"2024-10-08T21:51:39.138Z\",\n \"updatedAt\": \"2024-10-08T21:51:39.138Z\"\n }\n}"}],"_postman_id":"a296a6fc-59ac-4ef1-8bc0-22aef50edc1b"},{"name":"Get Single Dependant","id":"9af23ad0-a8e2-425d-a9c6-4908d63c8dc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://ai.heala.io/api/dependants/:dependant_id","description":"This endpoint retrieves details of a specific dependant.
\n","urlObject":{"path":["api","dependants",":dependant_id"],"host":["https://ai.heala.io"],"query":[],"variable":[{"type":"any","value":"user_id","key":"dependant_id"}]}},"response":[{"id":"7c77ac30-4e47-4ff2-bc3c-69253ab6239b","name":"Get Single Dependant","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/dependants/:dependant_id","host":["https://ai.heala.io"],"path":["api","dependants",":dependant_id"],"variable":[{"key":"dependant_id","value":"user_id","description":"required"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"670568a543699e4846cdddb7\",\n \"user_id\": \"dependant_1728407717207_355\",\n \"principal\": \"ABC1234\",\n \"firstName\": \"James\",\n \"lastName\": \"Doe\",\n \"relationship\": \"Child\",\n \"dob\": \"2022-12-03T00:00:00.000Z\",\n \"sex\": \"male\",\n \"createdAt\": \"2024-10-08T17:15:17.209Z\",\n \"updatedAt\": \"2024-10-08T17:15:17.209Z\",\n \"__v\": 0\n}"}],"_postman_id":"9af23ad0-a8e2-425d-a9c6-4908d63c8dc8"},{"name":"Get Dependants of Principal","id":"80d8996b-3103-4ce2-8975-cbe704a7483a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"https://ai.heala.io/api/dependants/user/:principal_id","description":"This endpoint retrieves all dependants linked to a specific principal.
\n","urlObject":{"path":["api","dependants","user",":principal_id"],"host":["https://ai.heala.io"],"query":[],"variable":[{"description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"user_id","key":"principal_id"}]}},"response":[{"id":"c18c0125-2e4c-4fa5-9f84-283ca221fcf3","name":"Get Dependants of Principal","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/dependants/user/:principal_id","host":["https://ai.heala.io"],"path":["api","dependants","user",":principal_id"],"variable":[{"key":"principal_id","value":"user_id"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"principal\": {\n \"user_id\": \"ABC1234\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"dependants\": [\n {\n \"user_id\": \"dependant_1728407717207_355\",\n \"firstName\": \"James\",\n \"lastName\": \"Doe\",\n \"relationship\": \"Child\",\n \"dob\": \"2022-12-03T00:00:00.000Z\",\n \"sex\": \"male\"\n },\n {\n \"user_id\": \"dependant_1728424299118_2\",\n \"firstName\": \"June\",\n \"lastName\": \"Doe\",\n \"relationship\": \"Child\",\n \"dob\": \"2022-12-03T00:00:00.000Z\",\n \"sex\": \"female\"\n }\n ]\n}"}],"_postman_id":"80d8996b-3103-4ce2-8975-cbe704a7483a"}],"id":"c5cc4ec7-4eca-46e0-88ca-9d00358a0a5c","description":"Dependants are individuals under the care of a principal, typically children or individuals requiring assistance with their health assessments.
\n","_postman_id":"c5cc4ec7-4eca-46e0-88ca-9d00358a0a5c"}],"id":"6e12746b-6b97-4078-8757-84bb50e4b696","description":"Patients are individuals using the Heala AI platform for health assessments. Each patient profile includes essential information such as name, date of birth (DOB), sex, and a user ID for tracking assessments. It specifies if the assessment is for the patient or a dependant, with dependants also having their own name, DOB, sex, and optional unique identifier.
\n","_postman_id":"6e12746b-6b97-4078-8757-84bb50e4b696"},{"name":"Conditions","item":[{"name":"Get Condition","id":"026c456d-5a71-4acc-897d-4394411167a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"/api/conditions/:condition_id?name=Tension headache","description":"This endpoint retrieves detailed information about a specific condition, including sections like overview, risks, symptoms, diagnosis, treatment, prevention, and prognosis.
\n","urlObject":{"path":["api","conditions",":condition_id"],"host":[""],"query":[{"description":{"content":"required
\n","type":"text/plain"},"key":"name","value":"Tension headache"}],"variable":[{"description":{"content":"required
\n","type":"text/plain"},"type":"any","value":"con-001","key":"condition_id"}]}},"response":[{"id":"31203147-d5ba-4583-9417-2502791a7cb1","name":"Get Condition","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://ai.heala.io/api/conditions/:condition_id?name=name_of_condition","host":["https://ai.heala.io"],"path":["api","conditions",":condition_id"],"query":[{"key":"name","value":"name_of_condition","description":"required"}],"variable":[{"key":"condition_id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"condition_id\": \"con-a8d12a4e-c472-4e7f-ac75-f19fddeb8882\",\n \"name\": \"Tension headache\",\n \"overview\": \"Tension headaches are the most common type of headache and are characterized by mild to moderate pain that feels like a band tightening around the head. These headaches are typically caused by muscle tension in the head and neck region, often due to stress, poor posture, or eye strain. Symptoms include a dull ache or pressure in the forehead, temples, or back of the head, as well as sensitivity to light and sound. Treatment often involves over-the-counter pain relievers, stress management techniques, and lifestyle changes to reduce triggers. Proper hydration, regular exercise, and relaxation techniques can also help prevent tension headaches.\",\n \"risks\": \"While tension headaches are typically considered to be mild and temporary, they can cause significant discomfort and interfere with daily activities. There is a risk of developing chronic tension headaches, which can last for extended periods of time and may be more difficult to treat. Prolonged tension headaches can also impact mental health, leading to increased stress, anxiety, and difficulty concentrating. In severe cases, tension headaches can cause nausea, vomiting, and sensitivity to light and sound. Additionally, overuse of pain medications to manage tension headaches can result in medication-overuse headaches, leading to a cycle of increased headache frequency and intensity.\",\n \"symptoms\": \"Tension headaches are the most common type of headache and typically cause dull or pressure-like pain that affects both sides of the head. The pain is often described as a constant ache that may feel like a tight band around the head or a sensation of pressure on the temples or back of the head. Other symptoms may include tenderness in the scalp, neck, or shoulder muscles, as well as mild sensitivity to light or sound. Tension headaches can last from a few hours to several days and are usually not severe enough to prevent daily activities, but can still be uncomfortable and bothersome.\",\n \"diagnosis\": \"Tension headache is a common type of headache characterized by a dull, aching pain, usually felt on both sides of the head or neck. It is often described as a tight band or pressure around the head. Tension headaches are typically triggered by stress, poor posture, jaw clenching, or muscle tension in the neck and shoulders. Other common symptoms may include sensitivity to light or sound, fatigue, and difficulty concentrating. Treatment usually involves managing stress, practicing relaxation techniques, improving posture, and over-the-counter pain medications. In severe cases, prescription medications or physical therapy may be recommended.\",\n \"treatment\": \"Tension headaches are usually mild to moderate in severity and can be treated with over-the-counter pain relievers such as acetaminophen or ibuprofen. Relaxation techniques such as deep breathing exercises, meditation, and gentle neck stretches can also help alleviate tension headache symptoms. Applying a warm compress to the forehead or neck and getting adequate rest and hydration can also be beneficial. In some cases, prescription medications may be necessary to manage chronic or severe tension headaches. It is important to consult with a healthcare professional for an accurate diagnosis and personalized treatment plan.\",\n \"prevention\": \"To prevent tension headaches, it is important to manage stress through relaxation techniques such as deep breathing exercises, progressive muscle relaxation, and mindfulness meditation. Regular physical exercise can also help reduce muscle tension and improve overall well-being. Maintaining good posture, taking frequent breaks from staring at screens, staying hydrated, and getting an adequate amount of sleep are also important preventative measures. Additionally, avoiding triggering foods, such as caffeine, alcohol, and processed foods, along with practicing good stress management techniques, can help reduce the frequency and severity of tension headaches.\",\n \"prognosis\": \"Tension headaches are typically episodic and last for a few hours to a few days. They do not usually cause serious health problems and can often be managed with over-the-counter pain medications, relaxation techniques, and stress management strategies. However, if tension headaches are frequent or severe, it may be necessary to seek medical advice to rule out other underlying causes such as migraine or medication overuse. With appropriate treatment and management, most people can effectively control their tension headaches and improve their quality of life.\",\n \"citations\": [\n {\n \"source\": \"Mayo Clinic\",\n \"url\": \"https://www.mayoclinic.org/search/search-results?q=Tension%20headache\",\n \"_id\": \"6929d09d1b5e954c080c6498\"\n },\n {\n \"source\": \"MedlinePlus\",\n \"url\": \"https://vsearch.nlm.nih.gov/vivisimo/cgi-bin/query-meta?v%3Aproject=medlineplus&v%3Asources=medlineplus-bundle&query=Tension%2Bheadache\",\n \"_id\": \"6929d09d1b5e954c080c6499\"\n }\n ],\n \"_id\": \"6929d09d1b5e954c080c6497\",\n \"createdAt\": \"2025-11-28T17:41:01.078Z\",\n \"updatedAt\": \"2025-11-28T17:41:01.083Z\",\n \"__v\": 0\n}"}],"_postman_id":"026c456d-5a71-4acc-897d-4394411167a8"}],"id":"adc60299-2786-4e1a-a475-c929968d1cfc","description":"Conditions represent the medical diagnoses or health issues identified through the symptom assessment process, derived from the patient's reported symptoms and responses during their session. Each suggested condition is accompanied by comprehensive sections that provide essential information.
\n","_postman_id":"adc60299-2786-4e1a-a475-c929968d1cfc"},{"name":"Triage","item":[],"id":"bf92c273-e320-42b8-985b-f6457f8783e7","description":"Triage (Coming Soon) refers to the process of connecting patients with healthcare professionals or emergency services based on the triage level determined from completed assessment sessions in real-time. By evaluating the severity of a patient's condition, Heala will facilitate immediate consultations and link patients to a network of verified GPs, specialists, hospitals, or emergency/ambulance services, in real-time.
\n","_postman_id":"bf92c273-e320-42b8-985b-f6457f8783e7"}],"event":[{"listen":"prerequest","script":{"id":"58d880c0-96f3-484f-ae50-896d800f92be","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"50dd7f9c-8ca5-4db1-8ffd-ad26a94e9ff4","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"apiUrl","value":"https://ai.heala.io"},{"key":"apiKey","value":""},{"key":"apiUrlDev","value":""}]}