![\"Overall](\"https://lh3.googleusercontent.com/d/1Cy40OuEYiMrBYys1LSGuronJqKTH49eZ=w1600\")
Connect your website, patient portal, EMR, or internal tools to CrelioHealth LIMS β register patients, create orders, track samples, and receive results automatically.
\nπ New here? Open the [π Start Here] folder first. It walks you from zero to your first successful API call in about 10 minutes, with a glossary and troubleshooting guide written for lab professionals.
\nWhat's inside
\nHTTP methods used
\nContact: info@creliohealth.com
\nChange log
\nWelcome! π
\nThis collection documents everything you can do with the CrelioHealth API β written for lab professionals, not just programmers.
\nThree ways to integrate:
\nAPIs β your system calls CrelioHealth (register patients, create bills, fetch results).
\nWebhooks β CrelioHealth calls you when events happen (report signed, sample received).
\nHL7 β for EMRs/EHRs that speak the HL7 v2 standard.
\n\n\nHow to read this collection
\nEvery endpoint starts with What this does and When to use it in plain English.
\nOrange callouts and tables list the fields; {{LIKE_THIS}} means a Postman variable you set once.
Example data uses a fictional US patient (Sarah Mitchell, Columbia MD) β replace with real data when you go live.
\nStart with Quick Start in this folder β you'll make your first successful call in about 10 minutes.
\nQuestions? info@creliohealth.com
\n","urlObject":{"path":[""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"093ae785-1ed6-495f-b190-4d70a492cac0"},{"name":"2. Quick Start β your first call","id":"d6aa0c2e-d1ca-4fcd-95b9-9f0585767c7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HOST}}/","description":"Your first successful API call in 4 steps
\nSet your environment variables. In Postman, create an Environment with:
\nHOST = the base URL CrelioHealth gave you
TOKEN = your API token
Fetch your test menu. Run Data Fetch API β Vendor Test & Profile API. Save the testID and dictionaryId of a test β you'll need them next.
Register a test patient. Open Patient Registration API β Patient Registration & Billing API, put the IDs from step 2 into testList, and hit Send. A successful response returns a billId.
Check the order. Run Result Fetch API β Get Order Status with that billId. You should see your test listed as pending.
That's the whole loop: menu β register & bill β track. Everything else in this collection is a variation on it.
\n\n\n","urlObject":{"path":[""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6aa0c2e-d1ca-4fcd-95b9-9f0585767c7b"},{"name":"3. Authentication & Security","id":"769a0c12-d5e9-489c-bd3b-d4f74c1bbdbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HOST}}/","description":"β οΈ Always test against your staging/demo account first β these calls create real records.
\n
Authentication β how CrelioHealth knows it's you
\nEvery API call carries your token in the URL path or as a query parameter β like a key card that opens your lab's data and only yours.
\nYour token is issued by CrelioHealth during onboarding. Treat it like a password: don't email it, don't put it in client-side website code, don't commit it to shared documents.
\nIn this collection the token is the {{TOKEN}} variable β set it once in your Postman Environment and every request uses it automatically.
All activity under your token is logged, so you can audit what your integration did and when.
\nIf a token is exposed, contact CrelioHealth support to rotate it.
\nCommon auth errors
\n","urlObject":{"path":[""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"769a0c12-d5e9-489c-bd3b-d4f74c1bbdbd"},{"name":"4. Which API do I need?","id":"90091255-2c62-4132-b6cb-e37477174a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HOST}}/","description":"\"Which API do I need?\" β quick decision guide
\nRule of thumb: APIs are for things you do; Webhooks are for things you want to be told about.
\n","urlObject":{"path":[""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"90091255-2c62-4132-b6cb-e37477174a12"},{"name":"5. Glossary of IDs & Terms","id":"847200ad-97c4-4307-83d3-e618309a6320","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HOST}}/","description":"Glossary β IDs you'll see everywhere
\nThink of these like the accession numbers and requisition IDs on your bench β every record has one, and APIs use them to point at the right record.
\n","urlObject":{"path":[""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"847200ad-97c4-4307-83d3-e618309a6320"},{"name":"6. Common Errors & Troubleshooting","id":"3db31ce5-0c62-4ecb-9a0b-2e8f229c93b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{HOST}}/","description":"Common errors & troubleshooting
\nField gotchas we see most often
\ndob beats age β if both are sent, date of birth wins.
testList IDs must come from your account's test menu (Vendor Test & Profile API) β IDs differ between accounts.
Amounts are plain numbers in your account's currency β no $ symbols or commas.
Timestamps include a timezone offset (e.g., 2026-06-12T09:41:00-05:00).
aadharNumber / panNumber are India-specific identity fields β US labs should leave them blank.
New to the CrelioHealth API? Read these five pages first β about 15 minutes total.
\n","_postman_id":"b85df4f3-d03f-4727-94dc-baabd0b9bb09"},{"name":"API's","item":[{"name":"Patient Registration API","item":[{"name":"Patient Registration & Billing API","id":"ccbb211a-6285-412a-88e8-55b9340c90cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\":\"1\",\n \"mobile\": \"4435550123\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Anne Mitchell\",\n \"firstName\":\"Sarah\",\n \"middleName\":\"Anne\",\n \"lastName\":\"Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"C03005988\",\n \"panNumber\": \"\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"areaOfResidence\":\"Columbia\",\n \"state\":\"Maryland\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billConcession\":\"50\",\n \"additionalAmount\":\"100\",\n \"billDate\": \" 2019-11-04T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"10\",\n \"organizationIdLH\": {{ORGANIZATION_ID}},\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": {{TEST_CODE}},\n \"integrationCode\": {{INTEGRATION_CODE}},\n \"dictionaryId\": {{DICTIONARY_ID}},\n \"sampleId\": \"\"\n },\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": {{TEST_CODE}},\n \"integrationCode\": {{INTEGRATION_CODE}},\n \"dictionaryId\": {{DICTIONARY_ID}},\n \"sampleId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/","description":"What this does: Registers a new patient and creates their bill with the ordered tests β all in one call. This is the most common starting point for any integration.
\nWhen to use it: Use this when a patient walks in (or orders online) and you want to create the patient, the order, and the bill together. The response gives you the billId you'll need for every later step.
This API provides functionality to the registration and billing of a new patient.
\nParameters
\nResponse Parameters
\nStatus Codes
\nβ’ 200: Success
\nβ’ 403: Patient/Organization data missing
\nβ’ 406: Test details missing/wrong
\nβ’ 500: Wrong API URL/Token mismatched/Wrong JSON request.
\n","urlObject":{"path":["LHRegisterBillAPI","{{TOKEN}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"78eae797-cdb3-46bd-b8b8-63305f29be54","name":"403 Forbidden/Orgnization/Test ID/ Patinet Details Missing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"mobile\": \"4435550123\",\r\n \"email\": \"sarah.mitchell@example.com\",\r\n \"designation\": \"Ms.\",\r\n \"fullName\": \"Sarah Mitchell\",\r\n \"age\": 25,\r\n \"gender\": \"Female\",\r\n \"area\": \"Oakland Mills\",\r\n \"city\": \"Columbia\",\r\n \"patientType\": \"IP\",\r\n \"labPatientId\": \"Lab1234\",\r\n \"pincode\": \"21044\",\r\n \"patientId\": \"\",\r\n \"dob\": \"1996-11-29\",\r\n \"passportNo\": \"C03005988\",\r\n \"panNumber\": \"\",\r\n \"aadharNumber\": \"\",\r\n \"insuranceNo\": \"I98989\",\r\n \"nationality\": \"American\",\r\n \"ethnicity\": \"Not Hispanic or Latino\",\r\n \"nationalIdentityNumber\": \"\",\r\n \"workerCode\": \"WC2345\",\r\n \"doctorCode\": \"Dccccc\",\r\n \"billDetails\": {\r\n \"emergencyFlag\": \"0\",\r\n \"totalAmount\": \"700\",\r\n \"advance\": \"593\",\r\n \"billDate\": \" 2019-11-04T06:41:42Z-05:00\",\r\n \"paymentType\": \"Cash\",\r\n \"referralName\": \"Dr. Emily Carter\",\r\n \"otherReferral\": \"Dr. James Brooks\",\r\n \"sampleId\": \"OP12345\",\r\n \"orderNumber\": \"Order1234\",\r\n \"referralIdLH\": {{REFERRAL_ID}},\r\n \"organisationName\": \"\",\r\n \"additionalAmount\": \"100\",\r\n \"organizationIdLH\": \"\",\r\n \"comments\": \"New Patient Registration\",\r\n \"testList\": [\r\n {\r\n \"testID\": {{TEST_ID}},\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n },\r\n {\r\n \"testID\": {{TEST_ID}},\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n }\r\n ],\r\n \"paymentList\": [\r\n {\r\n \"paymentType\": \"Cash\",\r\n \"paymentAmount\": \"100\",\r\n \"issueBank\": \"\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Message\": \"Please check patient data.\",\r\n \"code\": 403\r\n}"},{"id":"80bc5fb1-a4dd-470b-9427-501c16f7e10b","name":"406 Not Acceptable/Test Details Missing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"mobile\": \"4435550123\",\r\n \"email\": \"sarah.mitchell@example.com\",\r\n \"designation\": \"Ms.\",\r\n \"fullName\": \"Sarah Mitchell\",\r\n \"age\": 25,\r\n \"gender\": \"Female\",\r\n \"area\": \"Oakland Mills\",\r\n \"city\": \"Columbia\",\r\n \"patientType\": \"IP\",\r\n \"labPatientId\": \"Lab1234\",\r\n \"pincode\": \"21044\",\r\n \"patientId\": \"\",\r\n \"dob\": \"1996-11-29\",\r\n \"passportNo\": \"C03005988\",\r\n \"panNumber\": \"\",\r\n \"aadharNumber\": \"\",\r\n \"insuranceNo\": \"I98989\",\r\n \"nationality\": \"American\",\r\n \"ethnicity\": \"Not Hispanic or Latino\",\r\n \"nationalIdentityNumber\": \"\",\r\n \"workerCode\": \"WC2345\",\r\n \"doctorCode\": \"Dccccc\",\r\n \"billDetails\": {\r\n \"emergencyFlag\": \"0\",\r\n \"totalAmount\": \"700\",\r\n \"advance\": \"593\",\r\n \"billDate\": \" 2019-11-04T06:41:42Z-05:00\",\r\n \"paymentType\": \"Cash\",\r\n \"referralName\": \"Dr. Emily Carter\",\r\n \"otherReferral\": \"Dr. James Brooks\",\r\n \"sampleId\": \"OP12345\",\r\n \"orderNumber\": \"Order1234\",\r\n \"referralIdLH\": {{REFERRAL_ID}},\r\n \"organisationName\": \"Sunrise Medical Group\",\r\n \"additionalAmount\": \"100\",\r\n \"organizationIdLH\": {{ORGANIZATION_ID}},\r\n \"comments\": \"New Patient Registration\",\r\n \"testList\": [\r\n {\r\n \"testID\": \"\",\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n },\r\n {\r\n \"testID\": \"\",\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n }\r\n ],\r\n \"paymentList\": [\r\n {\r\n \"paymentType\": \"Cash\",\r\n \"paymentAmount\": \"100\",\r\n \"issueBank\": \"\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"UnmappedTest\": [\r\n {\r\n \"sampleId\": \"\",\r\n \"testCode\": \"\",\r\n \"testID\": \"\",\r\n \"integerationCode\": \"\",\r\n \"dictionaryId\": \"\"\r\n },\r\n {\r\n \"sampleId\": \"\",\r\n \"testCode\": \"\",\r\n \"testID\": \"\",\r\n \"integerationCode\": \"\",\r\n \"dictionaryId\": \"\"\r\n }\r\n ],\r\n \"Message\": \"Does not found mapping test in LH. Please check and confirm.\",\r\n \"code\": 406\r\n}"},{"id":"dacc5df2-a37f-4f78-8a16-073b49f61567","name":" 500 Wrong API URL/Token mismatched/Wrong JSON request.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"mobile\": \"4435550123\",\r\n \"email\": \"sarah.mitchell@example.com\",\r\n \"designation\": \"Ms.\",\r\n \"fullName\": \"Sarah Mitchell\",\r\n \"age\": 25,\r\n \"gender\": \"Female\",\r\n \"area\": \"Oakland Mills\",\r\n \"city\": \"Columbia\",\r\n \"patientType\": \"IP\",\r\n \"labPatientId\": \"Lab1234\",\r\n \"pincode\": \"21044\",\r\n \"patientId\": \"\",\r\n \"dob\": \"1996-11-29\",\r\n \"passportNo\": \"C03005988\",\r\n \"panNumber\": \"\",\r\n \"aadharNumber\": \"\",\r\n \"insuranceNo\": \"I98989\",\r\n \"nationality\": \"American\",\r\n \"ethnicity\": \"Not Hispanic or Latino\",\r\n \"nationalIdentityNumber\": \"\",\r\n \"workerCode\": \"WC2345\",\r\n \"doctorCode\": \"Dccccc\",\r\n \"billDetails\": {\r\n \"emergencyFlag\": \"0\",\r\n \"totalAmount\": \"700\",\r\n \"advance\": \"593\",\r\n \"billDate\": \" 2019-11-04T06:41:42Z-05:00\",\r\n \"paymentType\": \"Cash\",\r\n \"referralName\": \"Dr. Emily Carter\",\r\n \"otherReferral\": \"Dr. James Brooks\",\r\n \"sampleId\": \"OP12345\",\r\n \"orderNumber\": \"Order1234\",\r\n \"referralIdLH\": {{REFERRAL_ID}},\r\n \"organisationName\": \"Sunrise Medical Group\",\r\n \"additionalAmount\": \"100\",\r\n \"organizationIdLH\": {{ORGANIZATION_ID}},\r\n \"comments\": \"New Patient Registration\",\r\n \"testList\": [\r\n {\r\n \"testID\": {{TEST_ID}},\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n },\r\n {\r\n \"testID\": {{TEST_ID}},\r\n \"testCode\": \"\",\r\n \"integrationCode\": \"\",\r\n \"dictionaryId\": \"\",\r\n \"sampleId\": \"\"\r\n }\r\n ],\r\n \"paymentList\": [\r\n {\r\n \"paymentType\": \"Cash\",\r\n \"paymentAmount\": \"100\",\r\n \"issueBank\": \"\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/badToken/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Message\": \"Please check data.\",\r\n \"code\": 500\r\n}"},{"id":"94903698-22fd-41ff-a9c8-0de191a55ee0","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"4435550123\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"C03005988\",\n \"panNumber\": \"\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2019-11-04T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": {{ORGANIZATION_ID}},\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\",\n \"sampleId\": \"\"\n },\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\",\n \"sampleId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Mar 2020 06:26:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"380"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Cookie, Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"age\": \"24 years\",\n \"code\": 200,\n \"reportDetails\": [\n {\n \"testAmount\": \"105\",\n \"testCode\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 971,\n \"testID\": 220119,\n \"CentreReportId\": 66082018,\n \"integrationCode\": null,\n \"testName\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\"\n },\n {\n \"testAmount\": \"109\",\n \"testCode\": \"TSH (THYROID STIMULATING HORMONE), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 970,\n \"testID\": 220120,\n \"CentreReportId\": 66082019,\n \"integrationCode\": null,\n \"testName\": \"TSH (THYROID STIMULATING HORMONE), SERUM\"\n }\n ],\n \"gender\": \"Female\",\n \"Message\": \"Success\",\n \"unMappedTestsUnderProfile\": [],\n \"moreThanOneDictMappedTests\": [],\n \"patientId\": 20185,\n \"billId\": 17894\n}"}],"_postman_id":"ccbb211a-6285-412a-88e8-55b9340c90cb"},{"name":"Update Patient Details API","id":"9eab01d4-9308-458e-a3ff-4dcad129a99f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": \"25\",\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"labPatientId\": \"\",\n \"dob\": \"1986-10-22T00:00:00.000Z\",\n \"alternateContact\": \"\",\n \"passportNo\": \"L12345\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/patientRegister/{{TOKEN}}/","description":"What this does: Updates an existing patient's demographics β name, contact info, address, etc.
\nWhen to use it: Use this when a patient's information changes after registration (e.g., a corrected date of birth or new phone number).
\nThi API provides functionality to update patient details for the registered patients lab.
\nParameters
\nResponse Paramters
\nStatus Codes
β’ 200: Success
β’ 500: PatientId/labPatientId is missing
\n","urlObject":{"path":["patientRegister","{{TOKEN}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"8ddbdd55-1b54-4ae9-8f09-a7e55b3f0f0b","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": \"25\",\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"pincode\": \"21044\",\n \"patientId\": \"20185\",\n \"labPatientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"alternateContact\": \"\",\n \"passportNo\": \"L12345\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHPatientRegisterAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Apr 2020 09:22:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Cookie"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"patientId\": 20185\n}"},{"id":"a49f152e-c413-42f9-a042-98978862112e","name":"500 β patientId/labPatientId is missing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": \"25\",\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"labPatientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"alternateContact\": \"\",\n \"passportNo\": \"L12345\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHPatientRegisterAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 16 Apr 2020 09:23:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Cookie"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Please check data.\",\n \"code\": 500\n}"}],"_postman_id":"9eab01d4-9308-458e-a3ff-4dcad129a99f"},{"name":"Patient Registration","id":"62e584a8-e8ba-4c14-a9b9-f1e6f9fb5d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"countryCode\":\"1\",\n \"mobile\": \"4435550123\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Anne Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29T00:00:00.000Z\",\n \"passportNo\": \"C03005988\",\n \"panNumber\": \"\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"areaOfResidence\":\"Columbia\",\n \"state\":\"Maryland\"\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/patientRegister/{{TOKEN}}/","description":"What this does: Registers a patient without creating a bill.
\nWhen to use it: Use this when you only need the patient record now and will create the order/bill later (e.g., pre-registration before a visit).
\nThis API provides functionality to register the new Patient.
\nParameters
\nβ’ 200: Success
\nβ’ 500: Wrong API URL/Token mismatched/Wrong JSON request.
\nResponse Parameters
\n","urlObject":{"path":["patientRegister","{{TOKEN}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62e584a8-e8ba-4c14-a9b9-f1e6f9fb5d93"}],"id":"8129fb4c-2210-4679-9210-b538da9ad2bd","description":"Create and maintain patient records. The combined Registration & Billing endpoint is the workhorse β one call creates the patient, the order, and the bill.
\nWhat this does: Books an appointment for a patient and creates the bill at the same time.
\nWhen to use it: Use this for scheduled visits β online booking portals, call-center bookings, or physician-office scheduling.
\nThis API provides functionality to create an appointment along with new patient registration and billing.
\nRequired fields to generate appoitment is isAppointmentRequest,startDate,endDate.
\nParameters
\nResponse Parameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 403: Patient/Organization data missing
\nβ’ 406: Test details missing/wrong
\nβ’ 500: Wrong API URL/Token mismatched/Wrong JSON request.
\n","urlObject":{"path":["LHRegisterBillAPI","{{TOKEN}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"983f9a41-bd5d-4943-90e2-1c82703d4e40","name":"200 - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"L123456\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"isAppointmentRequest\": 1,\n \"startDate\": \"2020-05-04T08:30:00Z\",\n \"endDate\": \"2020-05-04T09:30:00Z\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2020-04-12T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": \"232323\",\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": \"37647\",\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": \"220119\",\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n },\n {\n \"testID\": \"220120\",\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://livehealth.solutions/LHRegisterBillAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 Apr 2020 11:09:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"377"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Cookie, Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"age\": \"24 years\",\n \"code\": 200,\n \"appointmentId\": 35611,\n \"gender\": \"Female\",\n \"Message\": \"Success\",\n \"moreThanOneDictMappedTests\": [],\n \"patientId\": 20185,\n \"billId\": 19714,\n \"reportDetails\": [\n {\n \"testAmount\": \"105\",\n \"testCode\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 971,\n \"testID\": 220119,\n \"CentreReportId\": 66549168,\n \"integrationCode\": null,\n \"testName\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\"\n },\n {\n \"testAmount\": \"109\",\n \"testCode\": \"TSH (THYROID STIMULATING HORMONE), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 970,\n \"testID\": 220120,\n \"CentreReportId\": 66549169,\n \"integrationCode\": null,\n \"testName\": \"TSH (THYROID STIMULATING HORMONE), SERUM\"\n }\n ]\n}"},{"id":"3dcee87d-ba57-4049-8592-a4ad76d29015","name":"500 β Wrong API URL/Token mismatched/Wrong JSON request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"L123456\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"isAppointmentRequest\": 1,\n \"startDate\": \"2020-05-04T08:30:00Z\",\n \"endDate\": \"2020-05-04T09:30:00Z\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2020-04-12T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": {{ORGANIZATION_ID}},\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n },\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/badToken/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 Apr 2020 11:13:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Cookie"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Please check data.\",\n \"code\": 500\n}"},{"id":"15885ef8-0f92-4d65-8662-b7766c867fa0","name":"403 β Patient/Organization data missing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"L123456\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"isAppointmentRequest\": 1,\n \"startDate\": \"2020-05-04T08:30:00Z\",\n \"endDate\": \"2020-05-04T09:30:00Z\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2020-04-12T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": \"\",\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n },\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Message\": \"Please check patient data.\",\r\n \"code\": 403\r\n}"},{"id":"20d69237-2f9a-4c0b-83e2-435a10a92be2","name":"406 β Test details missing/wrong","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"L123456\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"isAppointmentRequest\": 1,\n \"startDate\": \"2020-05-04T08:30:00Z\",\n \"endDate\": \"2020-05-04T09:30:00Z\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2020-04-12T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": {{ORGANIZATION_ID}},\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": \"1234567898\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 Apr 2020 11:12:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Cookie"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"UnmappedTest\": [\n {\n \"testID\": \"1234567898\"\n }\n ],\n \"Message\": \"Does not found mapping test in LH. Please check and confirm.\",\n \"code\": 406\n}"}],"_postman_id":"5a9e758c-75d1-4bb2-87f0-e00171563ada"},{"name":"Appointment Confirm API","id":"53f84b09-5e1c-425c-b3e6-1d74f8d44669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"billId\": \"\",\n \"appointmentId\": {{APPOINTMENT_ID}}\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/appointmentConfirmAPI/{{TOKEN}}/","description":"What this does: Marks a booked appointment as confirmed.
\nWhen to use it: Use this after the patient confirms (e.g., taps a link in an SMS/email reminder).
\nThis API provides functionality to confirm raised appointment Using appointmentId or billId\n
Parameters
\nResponse Parameters
\nStatus Codes
\nβ’ 200: Success
\nβ’ 303: Both billId/AppointmentId is blank.
\nβ’ 500: billId/AppointmentId not found in LH/Request token is not valid
What this does: Moves an existing appointment to a new date/time.
\nWhen to use it: Use this when the patient or lab needs to change the appointment slot.
\nThis API provides functionality to reschedule raised appointment Using appointmentId or billId
\nParameters
\nResponse Parameters
Status Codes
\nβ’ 200: Success
\nβ’ 400: Both billId and appointment is blank
\nβ’ 405: Appointment reschedule date is greater than 60 days/past appointment reschedule date/token ID is wrong
\nβ’ 406: Either billId or appointment ID not found, Wrong Date format
What this does: Cancels an appointment.
\nWhen to use it: Use this for no-shows or patient cancellations. The related bill can be cancelled separately with the Bill Cancel API.
\nThis API provides functionality to dismiss/cancel raised appointment Using billId
\nParameters
\nResponse Parameters
\nStatus Codes
\nβ’ 200: Success
\nβ’ 500: billId/AppointmentId not found in LH/Request token is not valid
Book, confirm, reschedule, and cancel appointments. A booking can carry billing details so the bill is created at the same time.
\n\n\nπΌοΈ Diagram: upload the matching PNG from the
\ndiagramsfolder to your CDN/website and replace the URL below.
![\"Appointment](\"https://YOUR-CDN-URL/03-appointment-lifecycle.png\")
What this does: Books an at-home sample collection visit and creates the bill.
\nWhen to use it: Use this when a phlebotomist will travel to the patient (mobile phlebotomy / concierge draws).
\nThis API provides fuctionality to raise a sample home collection request along with the new patinet regsitration and biling.
\nParameters
\nResponse Parameters
\nStatus codes
β’ 200: Success
β’ 403: Patient/Organization data missing
\nβ’ 406: Test details missing/wrong
\nβ’ 500: Wrong API URL/Token mismatched/Wrong JSON request.
\n","urlObject":{"path":["LHRegisterBillAPI","{{TOKEN}}",""],"host":["{{HOST}}"],"query":[],"variable":[]}},"response":[{"id":"9bdd23c4-affd-4403-b8f4-c4798f22771b","name":"200 - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"mobile\": \"\",\n \"email\": \"sarah.mitchell@example.com\",\n \"designation\": \"Ms.\",\n \"fullName\": \"Sarah Mitchell\",\n \"age\": 25,\n \"gender\": \"Female\",\n \"area\": \"Oakland Mills\",\n \"city\": \"Columbia\",\n \"patientType\": \"IP\",\n \"labPatientId\": \"Lab1234\",\n \"pincode\": \"21044\",\n \"patientId\": \"\",\n \"dob\": \"1996-11-29\",\n \"passportNo\": \"L123456\",\n \"panNumber\": \"PPPPP1234P\",\n \"aadharNumber\": \"\",\n \"insuranceNo\": \"I98989\",\n \"nationality\": \"American\",\n \"ethnicity\": \"Not Hispanic or Latino\",\n \"nationalIdentityNumber\": \"\",\n \"workerCode\": \"WC2345\",\n \"doctorCode\": \"Dccccc\",\n \"isHomecollection\": 1,\n \"homeCollectionDateTime\": \"2020-05-05T11:30:00Z\",\n \"location\": \"22.6001177, 88.411294\",\n \"address\": \"BF 79, Sector 1, Salt Lake\",\n \"billDetails\": {\n \"emergencyFlag\": \"0\",\n \"totalAmount\": \"700\",\n \"advance\": \"593\",\n \"billDate\": \" 2020-04-12T06:41:42Z-05:00\",\n \"paymentType\": \"Cash\",\n \"referralName\": \"Dr. Emily Carter\",\n \"otherReferral\": \"Dr. James Brooks\",\n \"sampleId\": \"OP12345\",\n \"orderNumber\": \"Order1234\",\n \"referralIdLH\": {{REFERRAL_ID}},\n \"organisationName\": \"Sunrise Medical Group\",\n \"additionalAmount\": \"100\",\n \"organizationIdLH\": {{ORGANIZATION_ID}},\n \"comments\": \"New Patient Registration\",\n \"testList\": [\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n },\n {\n \"testID\": {{TEST_ID}},\n \"testCode\": \"\",\n \"integrationCode\": \"\",\n \"dictionaryId\": \"\"\n }\n ],\n \"paymentList\": [\n {\n \"paymentType\": \"Cash\",\n \"paymentAmount\": \"100\",\n \"issueBank\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHRegisterBillAPI/{{TOKEN}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 Apr 2020 11:29:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"381"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Vary","value":"Cookie, Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"age\": \"24 years\",\n \"code\": 200,\n \"reportDetails\": [\n {\n \"testAmount\": \"105\",\n \"testCode\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 971,\n \"testID\": 220119,\n \"CentreReportId\": 66549388,\n \"integrationCode\": null,\n \"testName\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\"\n },\n {\n \"testAmount\": \"109\",\n \"testCode\": \"TSH (THYROID STIMULATING HORMONE), SERUM\",\n \"testCategory\": \"Biochemistry\",\n \"departmentName\": \"Pathology\",\n \"sampleId\": \"OP12345MR\",\n \"dictionaryId\": 970,\n \"testID\": 220120,\n \"CentreReportId\": 66549389,\n \"integrationCode\": null,\n \"testName\": \"TSH (THYROID STIMULATING HORMONE), SERUM\"\n }\n ],\n \"gender\": \"Female\",\n \"Message\": \"Success\",\n \"unMappedTestsUnderProfile\": [],\n \"moreThanOneDictMappedTests\": [],\n \"patientId\": 20185,\n \"billId\": 19718\n}"}],"_postman_id":"2c9bbad9-7956-4f89-a395-aebb7254f280"},{"name":"Home Collection Reschedule","id":"6a0272fe-f7f5-47c9-bf0f-d89d8dd68c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"token","value":"{{TOKEN}}","type":"text"},{"key":"homeCollectionId","value":"{{HOMECOLLECTION_ID}}","type":"text"},{"key":"startDate","value":"2022-05-01T09:12:12Z","type":"text"},{"key":"endDate","value":"2022-05-01T10:12:12Z","type":"text"},{"key":"confirmFlag","value":"1","type":"text"}]},"url":"{{HOST}}/rescheduleOrCancelHC/","description":"What this does: Changes the date/time of a home-collection visit.
\nWhen to use it: Use this when the patient or phlebotomist needs a different slot.
\nThis API provides functionality to reschedule the Homecollection request using homeCollectionId
\nParameters
\nStatus Codes
β’ 200: Success
β’ 500: homeCollectionId not found in LH/Request token is not valid
Manage at-home sample collection visits (mobile phlebotomy) β booking with billing, and rescheduling.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d299b99a-be0b-4429-ae6b-aa20871d0a66"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"48d1f3a6-addf-4f38-86dd-fb6f8612cd46"}}],"_postman_id":"42e22985-d4ca-493e-b562-e1d67992e072"},{"name":"Billing API","item":[{"name":"Add Test to Bill API","id":"483ff8fa-7d43-4062-9b6f-8d369e836f61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"billTotalAmount\": \"0\",\r\n \"billAdvance\": 0,\r\n \"orderNumber\": \"Test123\",\r\n \"billId\": {{BILL_ID}},\r\n \"testList\": [\r\n {\r\n \"testCode\": {{TEST_CODE}},\r\n \"sampleId\": \"\",\r\n \"dictionaryId\": {{DICTIONARY_ID}},\r\n \"testID\": {{TEST_ID}},\r\n \"integrationCode\": {{INTEGRATION_CODE}}\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/LHAddTestToBillAPI/{{TOKEN}}/","description":"What this does: Adds one or more tests to a bill that already exists.
\nWhen to use it: Use this for add-on orders β e.g., the physician calls back and adds a test to this morning's draw.
\nThis API provide fuctionality to add test/tests to exsting bill based on the billId\n
Parameters
Response Parameters
\nStatus Code
\nβ’ 200: Success
\nβ’ 400: Test details mismatched/Bill ID not found
\nβ’ 500: Bad request, check token
What this does: Marks a bill as complete/finalized.
\nWhen to use it: Use this when no further changes will be made to the order.
\nThis API provides fuctionality to change the status of bill as complete
\nParameters
Status Codes
\nβ’ 200: Success
\nβ’ 401: Invalid token
\nβ’ 301: Invalid Bill ID
\nβ’ 500: Bill ID missing
What this does: Records a payment against a bill (cash, card, etc.).
\nWhen to use it: Use this when you collect payment in your own system and need CrelioHealth's balance to match.
\nThis API provides fuctionality to add/update bill payments\n
Parameters
Status Codes
\nβ’ 200: Success
\nβ’ 401: Invalid token
\nβ’ 301: Invalid Bill ID
\nβ’ 500: Bill ID missing
What this does: Updates details on an existing bill (referral, amounts, comments, etc.).
\nWhen to use it: Use this to correct billing details after the bill was created.
\nThis API provides functionality to update bill/order details reference to bill ID.
\nParameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 401: Bad request/Wrong token
\nβ’ 403: Bill ID not found
What this does: Cancels an entire bill and all tests on it.
\nWhen to use it: Use this when the whole order is void β duplicate entry, patient cancelled, wrong patient.
\nThis API provides functionality to Cancel complete bill/order details reference to bill ID.
\nParameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 401: Bad request/Invalid token
\nβ’ 500: Bill id not found
What this does: Cancels one specific test on a bill while keeping the rest of the order intact.
\nWhen to use it: Use this when a single test was ordered in error or the physician removes it.
\nThis API provides functionality to Cancel single or multiple tests from existing bill/order details reference to bill ID.\n
Parameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 401: Wrong token
\nβ’ 403: Blank bill ID
\nβ’ 404: Test details not found
\nβ’ 500: Test details missing
Everything you can do to a bill after it exists: add tests, record payments, update details, cancel a test or the whole bill, and mark it complete.
\nWhat this does: Returns the list of referring physicians configured in your CrelioHealth account.
\nWhen to use it: Use this to populate a 'Referring Doctor' dropdown in your portal, or to look up the referralIdLH value other APIs need.
This API Provides functionality to fetch all referral doctor details present in the lab and can be fetch based on the update time.\n
Parameter
\nForm data β
\n
\nKey β tokenObj
Value -{
\n \"token\": \" XXXX-XXXXX-XXXXX-XXX\",
\n \"lastUpdatedTime\": \"2020-02-12T12:00:00Z\"
\n }
Response
Status codes
\nβ’ 200: Success
\nβ’ 500: Invalid token/Invalid key name
What this does: Returns the organizations (client accounts / facilities) configured in your account.
\nWhen to use it: Use this to look up organizationIdLH values, or to sync your client list.
This API Provides functionality to fetch all organization/client details present in the lab and can be fetch based on the update time.\n
Parameter
\nForm data β
\nKey β tokenObj
Value - {
\n \"token\": \" XXXX-XXXXX-XXXXX-XXX\",
\n \"lastUpdatedTime\": \"2020-02-12T12:00:00Z\"
\n }
Response
\nStatus codes
\nβ’ 200: Success
\nβ’ 500: Invalid token
What this does: Returns your full test menu β every test and profile (panel) with its IDs and prices.
\nWhen to use it: Run this first during setup: you'll need the testID / dictionaryId values from here in almost every other API call.
This API Provides functionality to fetch test and profile/package details present in the lab.
\nParameter
\nparams data β\nKey β token
\nValue - XXX-XXX-XXX-XXX
Response
Status codes
\nβ’ 200: Success
\nβ’ 401: Wrong request type
\nβ’ 404: Invalid token/Bad request
What this does: Returns full details for one referring physician by ID.
\nWhen to use it: Use this when you have a referralIdLH and need the doctor's complete record.
This API Provides functionality to fetch individual referral doctors' details present in the lab reference to doctor ID.
\nParameter\n
\nparams data β
Key β token
\nValue - XXX-XXX-XXX-XXX
Key β docId
\nValue β 90133
Response
Status codes
\nβ’ 200: Success
\nβ’ 400: Wrong Token/Wrong Doc ID
What this does: Returns full details for one organization by ID.
\nWhen to use it: Use this when you have an organizationIdLH and need the facility's complete record.
This API Provides functionality to fetch individual organization/client doctors' details present in the lab reference to organization ID.\n
Paramter
\nparams data β
\nKey β token
\nValue - XXX-XXX-XXX-XXX
\n
\nKey β orgId
\nValue β 17758
Response
Status Code
\nβ’ 200: Success
\nβ’ 404: Bad request
\nβ’ 500: Invalid token
Lookup endpoints. Use these during setup and for dropdowns: your test menu (with the testIDs every other call needs), referring physicians, and client organizations.
What this does: Returns the current status of every test on a bill β pending, in progress, or reported β as structured data.
\nWhen to use it: Use this to show order tracking in your portal ('Where is my result?').
\nThis API Provides functionality to fetch bill details along with the patient data and submitted report details in both structured and PDF format with reference to Bill ID.
\nparams data β
Key β token
\nValue - XXX-XXX-XXX-XXX
Key β billId
\nValue β 17758
Parameters
\nResponse Parameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 404: Bad request/Invalid token
What this does: Returns the finished report as a PDF download link.
\nWhen to use it: Use this when you want the formatted, signed report document rather than raw values.
\nThis API Provides functionality to fetch the details of the report in PDF format with reference to bill ID.
\nIt gives a successful response when all the reports from the particular bill are in the ready state.
\nParamteter
\nparams data β
Key β token
\nValue - XXX-XXX-XXX-XXX
Key β billId
\nValue β 17758
Key β isHeaderFooter
\nValue β 0/1
Response
Status codes\n
\nβ’ 200: Success
\nβ’ 404: Invalid token
Pull results out of CrelioHealth on demand: structured order status, or the finished report as a PDF. (For push-style delivery, see Webhooks instead.)
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5aa96f9d-7201-4463-8d42-b2ba47138d80"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"483cb221-310b-4454-a2e3-59bf583c6dc0"}}],"_postman_id":"2cf8c8cb-8431-4c1d-a4f6-bc162b8edde1"},{"name":"Sample Operations","item":[{"name":"Sample Receive","id":"f1da6fa3-936e-419f-86bb-0827698380ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"authKey","type":"text","value":"{{TOKEN}}"},{"key":"billId","type":"text","value":"{{BILL_ID}}"},{"key":"accession_no","type":"text","value":"2006041001MR"}]},"url":"{{HOST}}/api/receive_sample/","description":"What this does: Marks samples as received (accessioned) at the lab.
\nWhen to use it: Use this when specimens physically arrive β e.g., scanning barcodes at the receiving bench from your own courier app.
\nThis API Provides functionality to receive patient sample for the already raised bill from the particular lab.
\nparams data β
Key β authKey
\nValue - XXX-XXX-XXX-XXX
Key β billId
\nValue β 17758
Key β accession_no
\nValue β OP12345MR
Parameters
\nStatus codes
\nβ’ 200: Success
\nβ’ 400: Bill Sample Not Found/Token is Invalid
\nβ’ 401: Sample not found
\nβ’ 404: Invalid Request/Check API Url, API type
What this does: Marks samples as collected from the patient.
\nWhen to use it: Use this at the draw station or during a home-collection visit to timestamp collection.
\nThis API Provides functionality to colect patient sample for the already raised bill from the particular lab.\n
\n
Form data β
Key β accession_no
\nValue - 12345
Key β update_date
\nValue β 2020-06-02T17:47:00Z
Key β billId
\nValue β 3456
Key β isSampleCollect
\nValue β 1/0
Parameters
\n Status codes
\nβ’ 200: Success
\nβ’ 400: sample not fount/Wrong Date Format/Bill ID not found
Track specimens: mark samples collected from the patient and received at the lab.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f6bd9b13-b660-4e2d-aec0-05131082c30d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3ced5e2a-48a4-479e-83a6-a9897c2f8c71"}}],"_postman_id":"31ed2b0b-f91b-4010-9c7e-070f09fb9bd7"}],"id":"4be6d74e-8047-4dc3-9bfc-ba58885557d6","description":"APIs β actions you trigger. Call these endpoints from your system to create patients, book appointments, manage bills, and fetch results. Every call needs your {{TOKEN}} (see Start Here β Authentication).
This webhook is triggered once a bill is generated for the token generated lab or any bills generated from the organization for which integration is configured.
\nParameters
This webhook is triggered once a bill is updated for the token generated lab or any bills updated from particular organization for which integration is configured.\n
Parameters
This webhook is triggered once a bill is canceled for the token generated lab or any bills canceled from particular organization for which integration is configured.\n
Parameters
This webhook is triggered once a bill is reset for the token generated lab or any bills reset from particular organization for which integration is configured.\n
Parameters
\n
This webhook is triggered once a bill is refunded for the token generated lab or any bills refunded from particular organization for which integration is configured.\n
Parameters
\n
This webhook is triggered once a bill is settled for the token generated lab or any bills settled from particular organization for which integration is configured.\n
Parameters
\n
This webhook is triggered once a new test is added in the existing bill of a token generated lab.\n
Parameters
\n
Fired on billing events: creation, updates, cancellation, refunds, settlements, and add-on tests.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f3975603-0568-4504-95c1-be2eec18bd10"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5d22e951-ac76-4550-bf42-3bb24669f569"}}],"_postman_id":"0593c578-5620-4128-b50f-0b15069870dd"},{"name":"Report Webhooks","item":[{"name":"Report Save (Without result parameters) - Notification","id":"67930648-113d-43ff-849d-8279d46d8965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"Order1234\",\n \"Patient Name\": \"Sarah Mitchell\",\n \"labPatientId\": \"Lab1234\",\n \"Test Name\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"CentreReportId\": 64766048,\n \"integrationCode\": null,\n \"billReferral\": \"Dr. Emily Carter\",\n \"labId\": 437,\n \"Sample Date\": \"2020-03-10T06:08:16Z\",\n \"billId\": 17758,\n \"dictionaryId\": 971,\n \"Report Id\": 220119,\n \"Report Date\": \"2020-03-10T06:17:46.366971Z\",\n \"status\": \"Report Saved (With Values)\",\n \"testCode\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"Gender\": \"Male\",\n \"Age\": \"24 years\",\n \"Accession Date\": \"2020-03-10T06:12:57Z\",\n \"isSigned\": 0,\n \"webhookId\": 10,\n \"Patient Id\": 20185,\n \"labReportId\": 64766048,\n \"reportDate\": \"2020-03-10T06:17:46Z\",\n \"alternateEmail\": null,\n \"Approval Date\": null,\n \"Contact No\": \"94xxxxxxxx\",\n \"testID\": 220119\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once a patient report saved from the token generated lab or patient report saved from the organization for which integration is configured
\nThis will act as a notification for report sign activity happened in lab.\n
Parameters
\n
This webhook is triggered once a patient report saved from the token generated lab or patient report saved from the organization for which integration is configured
\nThis webhook will contain the patinet report structured data.\n
Parameters
This webhook is triggered once a patient report signed from the token generated lab or patient report signed from the organization for which integration is configured
\nParameters
\n
This webhook is triggered once a patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured\n
Parameters
\n
This webhook is triggered once a patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nThis webhook will contains the patient reports data in structure format.
\nParameters
\n","urlObject":{"host":["{{ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"bfffd4ea-034b-40ef-8ca1-c884af657590","name":"Example payload β Report Submit (With result parameters) (US sample data)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Signing Doctor\": [\n {\n \"Signing Doctor 1\": \"Dr. Emily Carter, MD\"\n }\n ],\n \"orderNumber\": \"ORD-2026-00184\",\n \"Patient Name\": \"Sarah Mitchell\",\n \"fileInputReport\": 0,\n \"labPatientId\": \"Lab1234\",\n \"Test Name\": \"TSH, Serum\",\n \"CentreReportId\": 64766048,\n \"billReferral\": \"Dr. Emily Carter\",\n \"labId\": 437,\n \"Sample Date\": \"2026-06-12T09:55:00-05:00\",\n \"billId\": 20641,\n \"dictionaryId\": 980,\n \"Report Id\": 220119,\n \"reportFormatAndValues\": [\n {\n \"reportName\": \"TSH\",\n \"value\": \"2.18\",\n \"unit\": \"uIU/mL\",\n \"referenceRange\": \"0.45 - 4.50\",\n \"isAbnormal\": 0\n }\n ]\n}"},"url":"https://your-endpoint.example.com/creliohealth/webhook","description":"Sample payload CrelioHealth will POST to your endpoint."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"received\"\n}"}],"_postman_id":"20ea751e-e665-4e0c-9782-95d7757efd1a"},{"name":"Report Submit [Dispatched] (With Attachment)","id":"16bd3709-49e5-444e-a57d-cd773a8a2c70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"file","file":{"src":""}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once a patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nIn this configuration, email will be triggered to configured email address with patient report as attachament.\n
Email Response
\n
This webhook is triggered once a patient report dismissed from the token generated lab or patient report dismissed from the organization for which integration is configured
\nParameters
\n
This webhook is triggered once a patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nThis webhook contain the patiet report data in PDF format, which will be BASE64 encoded data.\n
Parameters
\n
This webhook is triggered once all patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nThis webhook contain the patiet report data for the all the billed tests in PDF format, which will be BASE64 encoded data.\n
Parameters
\n
This webhook is triggered once all patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nThis webhook contain the patient report data in structured format and will triggered separately for individual test and packages.
\nParameters
\n","urlObject":{"host":["{{ENDPOINT}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d825c610-fdc6-4210-a18c-840f06955650"},{"name":"Consolidated Report β Structured Data","id":"ac479354-ddb2-41ec-9780-0d73c7e7f853","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"Consolidated all report submit webhook (Structured data)\",\n \"alternateEmail\": null,\n \"Gender\": \"Male\",\n \"Age\": \"24\",\n \"Contact No\": \"94xxxxxxxx\",\n \"Patient Name\": \"Sarah Mitchell\",\n \"billId\": 17758,\n \"orderNumber\": \"Order1234\",\n \"alternateContact\": \"\",\n \"labPatientId\": \"Lab1234\",\n \"webhookId\": 35,\n \"Patient Id\": 20185,\n \"reportDetails\": [\n {\n \"Signing Doctor\": [\n {\n \"Signing Doctor 1\": \"Dr. Emily Carter, MD\"\n }\n ],\n \"billReferral\": \"Dr. Emily Carter\",\n \"isProfile\": 0,\n \"Approval Date\": \"2020-03-10T06:25:06Z\",\n \"Sample Date\": \"2020-03-10T06:08:16Z\",\n \"Accession Date\": \"2020-03-10T06:12:57Z\",\n \"fileInputReport\": 0,\n \"fileAttachments\": [],\n \"Test Name\": \"THYROID PANEL-II , FREE (FT3, FT4, TSH), SERUM\",\n \"Report Date\": \"2020-03-10T06:25:06Z\",\n \"Report Id\": 220119,\n \"integrationCode\": null,\n \"dictionaryId\": 971,\n \"reportFormatAndValues\": [\n {\n \"value\": \"3.1\",\n \"reportFormat\": {\n \"isImage\": 0,\n \"lowerBoundFemale\": \"2.5\",\n \"criticalUpperFemale\": \"-\",\n \"descriptionFlag\": 0,\n \"lowerBoundMale\": \"2.5\",\n \"listField\": 0,\n \"otherFemale\": \"-\",\n \"criticalLowerMale\": \"-\",\n \"otherFlag\": 0,\n \"highlightFlag\": 0,\n \"upperBoundFemale\": \"3.9\",\n \"testName\": \"FREE T3\",\n \"dictionaryId\": 625,\n \"otherMale\": \"-\",\n \"upperBoundMale\": \"3.9\",\n \"testUnit\": \"pg/mL\",\n \"fileInput\": 0,\n \"integrationCode\": \"\",\n \"criticalUpperMale\": \"-\",\n \"method\": \"\",\n \"criticalLowerFemale\": \"-\"\n }\n },\n {\n \"highlight\": 0,\n \"value\": \"Note :\",\n \"reportFormat\": [\n {\n \"Test Name\": \"Remarks\"\n }\n ]\n }\n ],\n \"labReportId\": 64766048\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once all patient report submitted from the token generated lab or patient report submitted from the organization for which integration is configured
\nThis webhook contain the patiet report data for the all the billed tests in structured format.\n
Parameters
\n
This webhook is triggered once a patient Smart report submitted from the lab
\nThis webhook will contain the patient smart report link.
\nParameters:
\n","urlObject":{"host":["{{ENDPOINT}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8248ca5-564f-4e80-95b5-009314387fb8"}],"id":"24076a29-b452-4977-9875-1531ce299fce","description":"Fired as reports move through the lab: saved β signed β submitted. Choose the variant that matches what you want delivered β a notification only, structured result values, or the report PDF. Most integrations use 'Report Submit (With result parameters)' or 'Report Submit - PDF'.
\n","_postman_id":"24076a29-b452-4977-9875-1531ce299fce"},{"name":"Sample Webhooks","item":[{"name":"Sample Received (Accessed)","id":"1dff983e-0d44-4d9c-87ec-ad776148be56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Status\": \"Sample Received\",\n \"webhookId\": 6,\n \"APIKEY\": \"test123\",\n \"APIUSER\": \"user123\",\n \"orderNumber\": \"Order1234\",\n \"labUserId\": 20185,\n \"labId\": 437,\n \"sampleId\": \"OP12345MR\",\n \"billId\": 17758,\n \"dictionaryId\": [\n 971,\n 314\n ],\n \"batchId\": \"None\",\n \"labPatientId\": \"Lab1234\",\n \"testID\": [\n 220119,\n 708075\n ],\n \"CentreReportId\": [\n 64763796,\n 64765080\n ],\n \"integrationCode\": [\n \"Q123\",\n \"N123\"\n ],\n \"accessionDate\": \"2020-03-10T06:05:29Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once a sample is received for the token generated lab or any sample received from the organization for which integration is configured.\n
Parameters
This webhook is triggered once a sample gets rejected for the token generated lab or any sample gets rejected from the organization for which integration is configured.
\nReject mostly done from sample batch management\n
Parameters
This webhook is triggered once a sample gets dismissed for the token generated lab or any sample gets dismissed from the organization for which integration is configured.\n
Parameters
\n
This webhook is triggered once a sample redrawned for the token generated lab or any sample redrawned from the organization for which integration is configured.\n
Parameters
What this does: Marks samples as collected from the patient.
\nWhen to use it: Use this at the draw station or during a home-collection visit to timestamp collection.
\nThis webhook is triggered once a sample collected for the token generated lab or any sample collected from the organization for which integration is configured.\n
Parameters
This webhook is triggered once a sample Un-collected for the token generated lab or any sample Un-collected from the organization for which integration is configured.\n
Parameters
Fired on specimen events: collected, received, rejected, redrawn, dismissed, or uncollected.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2f1c06e6-fd23-42ff-a7ac-63127dff3b03"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d4a3efdd-a34d-481b-bcce-a982646de41e"}}],"_postman_id":"9cd4c6c1-52f2-4349-80db-86a12c17c10a"},{"name":"Appointment Webhooks","item":[{"name":"Appointment Confirmed","id":"88ef8dba-01f0-4192-ad02-dd47f7e3554f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"comment\": \"-\",\n \"startDate\": \"2020-03-12T03:00:00Z\",\n \"apiKey\": \"test123\",\n \"endDate\": \"2020-03-12T04:00:00Z\",\n \"appointmentId\": 34247,\n \"apiUser\": \"user123\",\n \"dob\": \"11/29/1995\",\n \"gender\": \"Female\",\n \"latlng\": \"\",\n \"patient Name\": \"Sarah Mitchell\",\n \"billId\": 17759,\n \"Status\": \"Appointment Confirmed\",\n \"isHomeCollection\": 0,\n \"address\": \"\",\n \"webhookId\": 32,\n \"bookingDate\": \"2020-03-10T14:13:30Z\",\n \"Patient Age\": \"25 years\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once a raised appointment is confirmed from the token generated lab or raised appointment is confirmed from the organization for which integration is configured.\n
Parameters
This webhook is triggered once a raised appointment is rescheduled from the token generated lab or raised appointment is rescheduled from the organization for which integration is configured.\n
Parameters
This webhook is triggered once a raised appointment is canceled from the token generated lab or raised appointment is canceled from the organization for which integration is configured.\n
Parameters
\n
Fired when appointments are confirmed, rescheduled, or dismissed.
\n","_postman_id":"e65bb6ec-6555-4956-9206-5d3146752589"},{"name":"Home Collection Webhooks","item":[{"name":"Home Collection Rescheduled","id":"77b47178-1393-47f8-aba7-c08eaac00d33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDate\": \"2020-06-09 14:00:00-05:00\",\n \"endDate\": \"2020-06-09 18:00:00-05:00\",\n \"orderNumber\": \"-\",\n \"billTime\": \"2020-06-06 11:54:28-05:00\",\n \"pincode\": \"21044\",\n \"labPatientId\": \"0\",\n \"billId\": 20640,\n \"homeCollectionid\": 91343,\n \"city\": \"Columbia\",\n \"comments\": \"Testing Home collection\",\n \"alternateContact\": \"7620239728\",\n \"location\": \"39.2037,-76.8610\",\n \"email\": \"\",\n \"status\": \"Home Collection request rescheduled\",\n \"phleboId\": \"Not assigned\",\n \"docId\": 75386,\n \"phleboName\": \"Livehealth\",\n \"labUserId\": 937,\n \"webhookId\": 38,\n \"address\": \"Oakland Mills Road, Someshwarwadi, Pashan, Columbia, Maryland, India\",\n \"fullName\": \"Sarah Mitchell\",\n \"alternateEmail\": null,\n \"gender\": \"Female\",\n \"age\": \"27 years\",\n \"flagType\": 0,\n \"labId_id\": 437,\n \"mobile\": \"2345678912\",\n \"orgId\": 37647,\n \"dob\": \"1991-06-29\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","description":"This webhook is triggered once a raised home collection request is rescheduled from the token generated lab or raised appointment is rescheduled from the organization for which integration is configured.
\nParameters
This webhook is triggered once a raised home collection request is cancelled from the token generated lab or raised appointment is cancelled from the organization for which integration is configured.
\nParameters
This webhook is triggered once a phlebotomist assigned for home collection request from the token generated lab.
\nParameters
Fired on home-collection events, including phlebotomist assignment.
\n","_postman_id":"c2a7e164-5717-4965-a049-21dd6c8818d6"},{"name":"Patient Information Webhooks","item":[{"name":"New Patient Registerd","id":"5590b95d-1627-4f9b-a0ca-a313a249796d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nationalIdentityNumber\": \"\",\n \"patient_merge\": 0,\n \"Patient middleName\": \"\",\n \"optionCode\": \"\",\n \"Patient Name\": \"Dummy Patient 12\",\n \"country code\": \"44\",\n \"wardNo\": \"Angola\",\n \"ethnicity\": \"Hispanic or Latino\",\n \"Patient Contact\": \"\",\n \"Patient City\": \"Columbia\",\n \"Patient Designation\": \"Mr.\",\n \"labId\": 1336,\n \"zipcode\": \"123432\",\n \"Patient email\": \"Test@gmail.com\",\n \"Patient Alternate Contact\": \"1234554321\",\n \"ssnNumber\": \"\",\n \"race\": \"\",\n \"referral_id\": \"1665687\",\n \"Patient Address\": \"\",\n \"Patient Dob\": \"2024-01-01\",\n \"status\": \"New Patient Registered\",\n \"Mobile Number\": \"1234554321\",\n \"Patient firstName\": \"\",\n \"Insurance Details\": [],\n \"Patient gender\": \"Male\",\n \"workerCode\": \"\",\n \"Patient Type\": \"I\",\n \"Patient lastName\": \"\",\n \"state\": \"Maryland\",\n \"Patient Age\": \"2 months\",\n \"Patient Id\": 18178,\n \"nationality\": \"American\",\n \"insuranceNo\": \"\",\n \"Patient Area\": \"Oakland Mills, Columbia, Maryland, India\",\n \"old_patient_id\": 0,\n \"old_user_det_id\": 0,\n \"Guarantor Details\": {},\n \"org_id\": \"179510\",\n \"mrn\": \"\",\n \"passportNumber\": \"\",\n \"Patient MRN\": \"1234MRN\",\n \"landmark\": \"\",\n \"areaOfResidance\": \"Columbia\",\n \"webhookId\": 57\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","urlObject":{"host":["{{ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"18879c61-a9a8-408e-a39f-81206bd0342f","name":"Example payload β New Patient Registerd (US sample data)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"patientId\": 884512,\n \"fullName\": \"Sarah Anne Mitchell\",\n \"designation\": \"Ms.\",\n \"gender\": \"Female\",\n \"dob\": \"1996-11-29\",\n \"age\": 29,\n \"mobile\": \"4435550123\",\n \"email\": \"sarah.mitchell@example.com\",\n \"city\": \"Columbia\",\n \"state\": \"Maryland\",\n \"pincode\": \"21044\",\n \"labPatientId\": \"Lab1234\",\n \"registeredAt\": \"2026-06-12T09:41:00-05:00\"\n}"},"url":"https://your-endpoint.example.com/creliohealth/webhook","description":"Sample payload CrelioHealth will POST to your endpoint."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"received\"\n}"}],"_postman_id":"5590b95d-1627-4f9b-a0ca-a313a249796d"},{"name":"Patient Information Updated","id":"1da27536-117e-4bce-9434-bc3beb67ecbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nationalIdentityNumber\": \"\",\n \"patient_merge\": 0,\n \"Patient middleName\": \"\",\n \"optionCode\": \"\",\n \"Patient Name\": \"Dummy Patient 12\",\n \"country code\": \"44\",\n \"wardNo\": \"Angola\",\n \"ethnicity\": \"Hispanic or Latino\",\n \"Patient Contact\": \"\",\n \"Patient City\": \"Columbia\",\n \"Patient Designation\": \"Mr.\",\n \"labId\": 1336,\n \"zipcode\": \"123432\",\n \"Patient email\": \"Test@gmail.com\",\n \"Patient Alternate Contact\": \"1234554321\",\n \"ssnNumber\": \"\",\n \"race\": \"\",\n \"referral_id\": \"1665687\",\n \"Patient Address\": \"\",\n \"Patient Dob\": \"2022-01-01\",\n \"status\": \"Patient Information Update\",\n \"Mobile Number\": \"1234554321\",\n \"Patient firstName\": \"Dummy\",\n \"Insurance Details\": [],\n \"Patient gender\": \"Male\",\n \"workerCode\": \"\",\n \"Patient Type\": \"I\",\n \"Patient lastName\": \"Patient\",\n \"state\": \"Maryland\",\n \"Patient Age\": \"2 years\",\n \"Patient Id\": 18178,\n \"nationality\": \"American\",\n \"insuranceNo\": \"\",\n \"Patient Area\": \"Oakland Mills, Columbia, Maryland, India\",\n \"old_patient_id\": 0,\n \"old_user_det_id\": 0,\n \"Guarantor Details\": {},\n \"org_id\": \"179510\",\n \"mrn\": \"\",\n \"passportNumber\": \"\",\n \"Patient MRN\": \"11234MRN\",\n \"landmark\": \"\",\n \"areaOfResidance\": \"Columbia\",\n \"webhookId\": 58\n}","options":{"raw":{"language":"json"}}},"url":"{{ENDPOINT}}","urlObject":{"host":["{{ENDPOINT}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1da27536-117e-4bce-9434-bc3beb67ecbb"}],"id":"36199327-fb8c-40dd-b9a8-bafb33071fc6","description":"Fired when a patient is registered or their demographics are updated.
\n","_postman_id":"36199327-fb8c-40dd-b9a8-bafb33071fc6"}],"id":"67947b8b-518f-4201-83e1-5c756431e024","description":"Webhooks β events CrelioHealth pushes to you. When something happens in the lab (bill created, sample received, report signed), CrelioHealth sends a JSON POST to a URL you provide. No polling needed.
\nSetup: share your endpoint URL with the CrelioHealth team for each event type you want. Your endpoint should respond with HTTP 200 quickly and process the payload asynchronously.
\nCrelioHealth support for multiple connection protocols like SFTP, VPN, TCP/IP, FTP, and more is a significant feature that enhances its interoperability and data exchange capabilities in the healthcare domain. These various connection methods cater to different security, performance, and data transfer needs, allowing healthcare organizations to choose the most suitable option for their specific requirements.
\nBy supporting a range of connection protocols, Crelio offers healthcare organizations the flexibility to choose the most appropriate method based on their security needs, network infrastructure, and technical capabilities. This versatility ensures that data exchange between healthcare systems is efficient, secure, and compliant with industry standards.
\nWhat is SFTP ?
\nSFTP stands for Secure File Transfer Protocol. It is a network protocol that provides a secure way to transfer files between computers over a reliable and encrypted data stream. SFTP is an extension of the SSH (Secure Shell) protocol, and it is often used as a secure alternative to FTP (File Transfer Protocol).
\nKey features of SFTP include:
\nSecurity: SFTP encrypts both the data being transmitted and the commands used to perform file and directory operations. This ensures a secure transfer of sensitive information over a potentially untrusted network.
\nAuthentication: SFTP uses SSH for authentication, providing a secure method for verifying the identities of the communicating parties. This can involve username and password authentication, public key authentication, or other authentication methods supported by SSH.
\nData Integrity: SFTP includes features to ensure the integrity of the transferred data. It can detect and handle errors that may occur during file transfers, helping to maintain the accuracy of the data being transferred.
\nPortability: SFTP is platform-independent, meaning it can be used on various operating systems, including Unix, Linux, Windows, and others. This makes it a versatile solution for secure file transfers in heterogeneous environments.
\nRemote File Management: SFTP supports various file and directory operations, allowing users to upload, download, delete, rename, and manage files on remote servers securely.
\nUsually, Crelio uses SFTP hosted by clients and configures it accordingly. However, Crelio can also host its own SFTP server if required.
\nWhat is TCP/IP :
\nTCP/IP, which stands for Transmission Control Protocol/Internet Protocol, is a suite of communication protocols that form the foundation of the internet and many private networks. It is a set of rules and conventions that enable computers to communicate with each other over a network. The TCP/IP protocol suite is named after its two main protocols: Transmission Control Protocol (TCP) and Internet Protocol (IP).
\nHere's a brief overview of the key components of the TCP/IP protocol suite:
\nInternet Protocol (IP): IP is responsible for addressing and routing packets of data so that they can travel across networks and arrive at the correct destination. There are two main versions of IP in use today: IPv4 (Internet Protocol version 4) and IPv6 (Internet Protocol version 6). IPv6 was introduced to address the limitations of IPv4, particularly the limited number of available IP addresses.
\nTransmission Control Protocol (TCP): TCP is a connection-oriented protocol that ensures the reliable and ordered delivery of data between devices on a network. It breaks down large messages into smaller packets, sends them to the destination, and then reassembles them in the correct order. TCP also includes mechanisms for error checking and recovery.
\nUser Datagram Protocol (UDP): UDP is a connectionless protocol that provides a simpler, faster way to transmit data but does not guarantee the reliable delivery of packets. It is often used for applications where a small amount of data loss is acceptable, such as in real-time streaming or online gaming.
\nInternet Control Message Protocol (ICMP): ICMP is used for sending error messages and operational information about network conditions. It is often used for diagnostics, including the famous \"ping\" command, which checks the reachability of a host on an IP network.
\nInternet Assigned Numbers Authority (IANA): IANA is responsible for managing the global IP address space and the allocation of IP addresses to regional Internet registries.
\nDomain Name System (DNS): While not technically part of the TCP/IP protocol suite, DNS is an essential service that translates human-readable domain names into IP addresses, allowing users to access websites using easy-to-remember names instead of numerical IP addresses.
\nREST API :
\nCrelio provides a RESTful API that allows users to seamlessly integrate Health Level Seven (HL7) messages into their applications. This API supports secure communication over HTTPS, ensuring the confidentiality and integrity of the transmitted healthcare data.
\nAuthentication to the API is achieved using API keys. To obtain an API key, please contact Crelio support.
\n","_postman_id":"cff15912-027b-49d9-9099-83bf3e35a3fd"},{"name":"CrelioHealth ORM Specifications","item":[],"id":"c903cc5f-91b4-4e7f-b730-c23777b70bfb","description":"CrelioHealth supports the ORM (Order Message) HL7 message type for lab orders.
The ORM message can be received by Crelio to create lab orders within LIS. Alternatively, Crelio can also send out ORM messages to other systems as required by the specific use case.
Transaction Structure :
\nThe following table outlines the transaction structure section of the HL7 message.
\nFor EMR/EHR integrations that speak HL7 v2 (ORM orders in, ORU results out) rather than REST. Covers supported connection methods (SFTP, VPN, TCP/IP MLLP) and CrelioHealth's ORM message specifications.
\n","_postman_id":"29338ff6-7451-4e6f-b2f9-028b4b32b285"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9c431de3-e6d6-4325-b62f-70617e80e76a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"db12b387-c7d8-486f-b904-11ef90845aca"}}]}![\"Registration](\"https://lh3.googleusercontent.com/d/1Te44DjP8FK-yrD-u3LDfx-o9JHR2D1YS=w1600\")
![\"Billing](\"https://lh3.googleusercontent.com/d/1672B_XkMUnvkTG2Uu6dmpNc--i-sW3z2=w1600\")
![\"Webhook](\"https://lh3.googleusercontent.com/d/1KAyN_flNZQ3Igb3Wvxmwsbxu1BoHEZ8E=w1600\")