{
"data": {},
"error": {
"code": "UNAUTHORIZED_ENTITY",
"message": "You are not authorized to view requisted resource Doctor"
}
}
{
"data": {},
"error": {
"code": "INVALID_DATA",
"message": "Doctor id entered is incorrect"
}
}
Doctor and clinic API
Get Doctor profile
Overview
This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Eka Developer Platform APIs","colors":{"primary":"#6B5CE0","light":"#6B5CE0","dark":"#6B5CE0"},"logo":{"light":"https://cdn.eka.care/vagus/clzwrv3o600260ti3bg9q1det.png","dark":"https://cdn.eka.care/vagus/clzws1tfc00270ti3eiwn5jo5.png"},"favicon":"https://mintcdn.com/ekacare/uZX0UtACdJOcX7uJ/favicon.svg?fit=max\u0026auto=format\u0026n=uZX0UtACdJOcX7uJ\u0026q=85\u0026s=9ecadef0a25715531f08b66c68c31915","navbar":{"links":[{"href":"https://discord.gg/THgd5S22EK","label":"Support"},{"icon":"discord","href":"https://discord.gg/THgd5S22EK","label":"Developer Discord"}],"primary":{"type":"button","label":"Get Started","href":"https://console.eka.care"}},"footer":{"socials":{"x":"https://x.com/ekacarehq","github":"https://github.com/eka-care","linkedin":"https://www.linkedin.com/company/ekacare"}},"icons":{"library":"fontawesome"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ekacare","hasAudioNarration":false,"actualSubdomain":"ekacare","customDomains":["developer.eka.care"],"gitSource":{"type":"github","owner":"eka-care","repo":"eka-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb11cf1a579503f229065b","collectionId":"d32e9135-cda5-42f5-ae8c-cc3c6702d699","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb11cf1a579503f229065b"},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb11cf1a579503f229065b","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Documentation","count":617},{"language":"default","tag":"API Reference","count":503},{"language":"default","tag":"Doctor Tool","count":212},{"language":"default","tag":"ABDM Connect","count":159},{"language":"default","tag":"IPD API","count":127},{"language":"default","tag":"Admission Lifecycle","count":66},{"language":"default","tag":"Milestone 1","count":49},{"language":"default","tag":"Webhooks","count":44},{"language":"default","tag":"EkaScribe","count":36},{"language":"default","tag":"Milestone 2","count":34}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".eka-card-wrapper{border-radius:14px;transition:transform .15s ease}.eka-card-wrapper:hover{transform:translateY(-3px)}.eka-card-wrapper:hover>*{box-shadow:0 12px 28px rgba(80,66,189,.22);border-color:#5042bd}.eka-divider{border:0;border-top:1px solid rgba(80,66,189,.25);margin:48px 0}.eka-tags{display:inline;margin-left:6px;white-space:normal}.eka-postman-link code,.eka-tag{white-space:nowrap;border-radius:6px}.eka-tag{display:inline-block;font-size:11px;font-weight:500;line-height:1;padding:3px 7px;margin:0 0 2px 4px;vertical-align:middle;color:#6b7280;background:rgba(107,114,128,.1)}.dark .eka-tag{color:#9ca3af;background:rgba(156,163,175,.14)}.eka-postman{border:1px solid rgba(17,24,39,.1);border-radius:14px;padding:20px 24px;margin:16px 0 24px}.eka-postman-text{font-size:15px;line-height:1.6;color:#4b5563}.eka-postman-actions{display:flex;flex-wrap:wrap;gap:12px;margin:16px 0}.eka-postman-btn{display:inline-flex;align-items:center;gap:8px;padding:8px 16px;border:1px solid #6b5ce0;border-radius:8px;font-size:15px;font-weight:500;color:#5042bd;background:0 0;text-decoration:none;transition:background .15s ease}.eka-postman-btn:hover{background:rgba(107,92,224,.08)}.eka-postman-btn-primary{color:#fff;background:#6b5ce0}.eka-postman-btn-primary:hover{background:#5042bd}.eka-postman-link{display:flex;align-items:center;gap:12px;padding:10px 12px;border:1px solid rgba(17,24,39,.1);border-radius:10px;background:rgba(17,24,39,.03)}.eka-postman-link code{flex:1;min-width:0;overflow:hidden;text-overflow:ellipsis;font-size:13px;padding:6px 8px;background:rgba(17,24,39,.05)}.eka-postman-link button{flex-shrink:0;display:inline-flex;padding:4px;font-size:13px;color:#6b7280;background:0 0;border:0;cursor:pointer}.eka-postman-link button:hover{color:#5042bd}.eka-postman-note{margin-top:12px;font-size:14px;color:#6b7280}.eka-postman-error{margin:-4px 0 12px;font-size:14px;color:#b42318}.dark .eka-postman-error{color:#f97066}.dark .eka-postman{border-color:rgba(255,255,255,.12)}.dark .eka-postman-text{color:#d1d5db}.dark .eka-postman-btn{color:#a79cf5;border-color:#8a7cf0}.dark .eka-postman-btn:hover{background:rgba(138,124,240,.12)}.dark .eka-postman-btn-primary{color:#fff;background:#6b5ce0;border-color:#6b5ce0}.dark .eka-postman-btn-primary:hover{background:#5042bd}.dark .eka-postman-link{border-color:rgba(255,255,255,.12);background:rgba(255,255,255,.04)}.dark .eka-postman-link code{color:#e5e7eb;background:rgba(255,255,255,.06)}.dark .eka-postman-link button,.dark .eka-postman-note{color:#9ca3af}"}],"page":{"pagePath":"api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile","slug":"/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile","pageMetadata":{"openapi":"get /dr/v1/doctor/{doctor_id}","title":"Get Doctor profile","description":"\n### Overview\nThis API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.\n### Request Parameters\n\n| Parameter | Type | Description | Required |\n| --- | --- | --- | --- |\n| doctor_id | string | Unique identifier for the doctor | Yes |\n\n### Response Parameters\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier for the doctor in Eka |\n| created_at | datetime | Timestamp when the doctor profile was created |\n| profile | object | Doctor's profile details |\n| profile.personal | object | Personal details of the doctor |\n| profile.personal.salutation | string | Salutation (e.g., Dr.) |\n| profile.personal.first_name | string | First name of the doctor |\n| profile.personal.middle_name | string | Middle name of the doctor |\n| profile.personal.last_name | string | Last name of the doctor |\n| profile.personal.email | string | Email address of the doctor |\n| profile.personal.gender | string | Gender of the doctor |\n| profile.personal.dob | date | Date of birth of the doctor |\n| profile.professional | object | Professional details of the doctor |\n| profile.professional.username | string | Username of the Doctor|\n| profile.professional.active | boolean | Flag indicating if the profile is active |\n| profile.professional.about | string | About section describing the doctor |\n| profile.professional.language | array | Languages spoken by the doctor |\n| profile.professional.language\\[\\].language | string | Language name (e.g., English) |\n| profile.professional.clinics | array | Clinics associated with the doctor |\n| profile.professional.clinics\\[\\] | object | Clinic details |\n| profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic |\n| profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located |\n| profile.professional.clinics\\[\\].name | string | Name of the clinic |\n| profile.professional.clinics\\[\\].email | string | Email address of the clinic |\n| profile.professional.clinics\\[\\].about | string | About section of the clinic |\n| profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic |\n| profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic |\n| profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) |\n| profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number |\n| profile.professional.clinics\\[\\].address | object | Address details of the clinic |\n| profile.professional.clinics\\[\\].address.line1 | string | Address line 1 |\n| profile.professional.clinics\\[\\].address.line2 | string | Address line 2 |\n| profile.professional.clinics\\[\\].address.city | string | City of the clinic |\n| profile.professional.clinics\\[\\].address.state | string | State of the clinic |\n| profile.professional.clinics\\[\\].address.country | string | Country of the clinic |\n| profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic |\n| profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic |\n| profile.professional.default_clinic | string | Default clinic ID |\n| profile.professional.all_registrations | array | Registrations of the doctor |\n| profile.professional.all_registrations\\[\\].id | number | Registration ID |\n| profile.professional.all_registrations\\[\\].council | string | Medical council name |\n| profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number |\n| profile.professional.all_registrations\\[\\].year | string | Year of registration |\n| profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration |\n| profile.professional.degree | array | Degrees earned by the doctor |\n| profile.professional.degree\\[\\].id | number | Degree ID |\n| profile.professional.degree\\[\\].name | string | Name of the degree |\n| profile.professional.degree\\[\\].branch_name | string | Branch name |\n| profile.professional.degree\\[\\].college_name | string | College name |\n| profile.professional.degree\\[\\].display_status | string | Display status of the degree |\n| profile.professional.degree\\[\\].start_year | string | Start year of the degree |\n| profile.professional.degree\\[\\].end_year | string | End year of the degree |\n| profile.professional.major_speciality | object | Major speciality of the doctor |\n| profile.professional.major_speciality.name | string | Name of the major speciality |\n| profile.professional.speciality | array | Specialities of the doctor |\n| profile.professional.speciality\\[\\].name | string | Name of the speciality |\n| **Status Codes** | | |\n\n• 200: Success\n\n• 403: Doctor data missing\n\n• 500: Wrong API URL/Token mismatched/Wrong JSON request.","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n h3: \"h3\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h3, {\n children: \"Overview\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Request Parameters\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Parameter\"\n }), _jsx(_components.th, {\n children: \"Type\"\n }), _jsx(_components.th, {\n children: \"Description\"\n }), _jsx(_components.th, {\n children: \"Required\"\n })]\n })\n }), _jsx(_components.tbody, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"doctor_id\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Unique identifier for the doctor\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n })]\n })\n })]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Response Parameters\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Parameter\"\n }), _jsx(_components.th, {\n children: \"Type\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"id\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Unique identifier for the doctor in Eka\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"created_at\"\n }), _jsx(_components.td, {\n children: \"datetime\"\n }), _jsx(_components.td, {\n children: \"Timestamp when the doctor profile was created\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Doctor’s profile details\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Personal details of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.salutation\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Salutation (e.g., Dr.)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.first_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"First name of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.middle_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Middle name of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.last_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Last name of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.email\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Email address of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.gender\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Gender of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.personal.dob\"\n }), _jsx(_components.td, {\n children: \"date\"\n }), _jsx(_components.td, {\n children: \"Date of birth of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Professional details of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.username\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Username of the Doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.active\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"Flag indicating if the profile is active\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.about\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"About section describing the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.language\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Languages spoken by the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.language[].language\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Language name (e.g., English)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Clinics associated with the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[]\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Clinic details\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[]..id\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Unique identifier for the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].city_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"City name where the clinic is located\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Name of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].email\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Email address of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].about\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"About section of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].speciality\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Specialities offered at the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].number\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Contact numbers for the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].number[].name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Type of contact number (e.g., Phone, Mobile)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].number[].n\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Contact number\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Address details of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.line1\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Address line 1\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.line2\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Address line 2\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.city\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"City of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.state\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"State of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.country\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Country of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].address.pincode\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Pincode of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.clinics[].location\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Location coordinates of the clinic\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.default_clinic\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Default clinic ID\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Registrations of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations[].id\"\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsx(_components.td, {\n children: \"Registration ID\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations[].council\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Medical council name\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations[].medical_id\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Medical ID number\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations[].year\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Year of registration\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.all_registrations[].default\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"Flag indicating if it is the default registration\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Degrees earned by the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].id\"\n }), _jsx(_components.td, {\n children: \"number\"\n }), _jsx(_components.td, {\n children: \"Degree ID\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Name of the degree\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].branch_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Branch name\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].college_name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"College name\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].display_status\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Display status of the degree\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].start_year\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Start year of the degree\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.degree[].end_year\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"End year of the degree\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.major_speciality\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Major speciality of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.major_speciality.name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Name of the major speciality\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.speciality\"\n }), _jsx(_components.td, {\n children: \"array\"\n }), _jsx(_components.td, {\n children: \"Specialities of the doctor\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"profile.professional.speciality[].name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Name of the speciality\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.strong, {\n children: \"Status Codes\"\n })\n }), _jsx(_components.td, {}), _jsx(_components.td, {})]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: \"• 200: Success\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"• 403: Doctor data missing\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"• 500: Wrong API URL/Token mismatched/Wrong JSON request.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /dr/v1/doctor/{doctor_id}","title":"Get Doctor profile","description":"\n### Overview\nThis API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.\n### Request Parameters\n\n| Parameter | Type | Description | Required |\n| --- | --- | --- | --- |\n| doctor_id | string | Unique identifier for the doctor | Yes |\n\n### Response Parameters\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier for the doctor in Eka |\n| created_at | datetime | Timestamp when the doctor profile was created |\n| profile | object | Doctor's profile details |\n| profile.personal | object | Personal details of the doctor |\n| profile.personal.salutation | string | Salutation (e.g., Dr.) |\n| profile.personal.first_name | string | First name of the doctor |\n| profile.personal.middle_name | string | Middle name of the doctor |\n| profile.personal.last_name | string | Last name of the doctor |\n| profile.personal.email | string | Email address of the doctor |\n| profile.personal.gender | string | Gender of the doctor |\n| profile.personal.dob | date | Date of birth of the doctor |\n| profile.professional | object | Professional details of the doctor |\n| profile.professional.username | string | Username of the Doctor|\n| profile.professional.active | boolean | Flag indicating if the profile is active |\n| profile.professional.about | string | About section describing the doctor |\n| profile.professional.language | array | Languages spoken by the doctor |\n| profile.professional.language\\[\\].language | string | Language name (e.g., English) |\n| profile.professional.clinics | array | Clinics associated with the doctor |\n| profile.professional.clinics\\[\\] | object | Clinic details |\n| profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic |\n| profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located |\n| profile.professional.clinics\\[\\].name | string | Name of the clinic |\n| profile.professional.clinics\\[\\].email | string | Email address of the clinic |\n| profile.professional.clinics\\[\\].about | string | About section of the clinic |\n| profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic |\n| profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic |\n| profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) |\n| profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number |\n| profile.professional.clinics\\[\\].address | object | Address details of the clinic |\n| profile.professional.clinics\\[\\].address.line1 | string | Address line 1 |\n| profile.professional.clinics\\[\\].address.line2 | string | Address line 2 |\n| profile.professional.clinics\\[\\].address.city | string | City of the clinic |\n| profile.professional.clinics\\[\\].address.state | string | State of the clinic |\n| profile.professional.clinics\\[\\].address.country | string | Country of the clinic |\n| profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic |\n| profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic |\n| profile.professional.default_clinic | string | Default clinic ID |\n| profile.professional.all_registrations | array | Registrations of the doctor |\n| profile.professional.all_registrations\\[\\].id | number | Registration ID |\n| profile.professional.all_registrations\\[\\].council | string | Medical council name |\n| profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number |\n| profile.professional.all_registrations\\[\\].year | string | Year of registration |\n| profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration |\n| profile.professional.degree | array | Degrees earned by the doctor |\n| profile.professional.degree\\[\\].id | number | Degree ID |\n| profile.professional.degree\\[\\].name | string | Name of the degree |\n| profile.professional.degree\\[\\].branch_name | string | Branch name |\n| profile.professional.degree\\[\\].college_name | string | College name |\n| profile.professional.degree\\[\\].display_status | string | Display status of the degree |\n| profile.professional.degree\\[\\].start_year | string | Start year of the degree |\n| profile.professional.degree\\[\\].end_year | string | End year of the degree |\n| profile.professional.major_speciality | object | Major speciality of the doctor |\n| profile.professional.major_speciality.name | string | Name of the major speciality |\n| profile.professional.speciality | array | Specialities of the doctor |\n| profile.professional.speciality\\[\\].name | string | Name of the speciality |\n| **Status Codes** | | |\n\n• 200: Success\n\n• 403: Doctor data missing\n\n• 500: Wrong API URL/Token mismatched/Wrong JSON request.","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Doctor and clinic API"],"summary":"Get Doctor profile","description":"\n### Overview\nThis API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.\n### Request Parameters\n\n| Parameter | Type | Description | Required |\n| --- | --- | --- | --- |\n| doctor_id | string | Unique identifier for the doctor | Yes |\n\n### Response Parameters\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| id | string | Unique identifier for the doctor in Eka |\n| created_at | datetime | Timestamp when the doctor profile was created |\n| profile | object | Doctor's profile details |\n| profile.personal | object | Personal details of the doctor |\n| profile.personal.salutation | string | Salutation (e.g., Dr.) |\n| profile.personal.first_name | string | First name of the doctor |\n| profile.personal.middle_name | string | Middle name of the doctor |\n| profile.personal.last_name | string | Last name of the doctor |\n| profile.personal.email | string | Email address of the doctor |\n| profile.personal.gender | string | Gender of the doctor |\n| profile.personal.dob | date | Date of birth of the doctor |\n| profile.professional | object | Professional details of the doctor |\n| profile.professional.username | string | Username of the Doctor|\n| profile.professional.active | boolean | Flag indicating if the profile is active |\n| profile.professional.about | string | About section describing the doctor |\n| profile.professional.language | array | Languages spoken by the doctor |\n| profile.professional.language\\[\\].language | string | Language name (e.g., English) |\n| profile.professional.clinics | array | Clinics associated with the doctor |\n| profile.professional.clinics\\[\\] | object | Clinic details |\n| profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic |\n| profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located |\n| profile.professional.clinics\\[\\].name | string | Name of the clinic |\n| profile.professional.clinics\\[\\].email | string | Email address of the clinic |\n| profile.professional.clinics\\[\\].about | string | About section of the clinic |\n| profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic |\n| profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic |\n| profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) |\n| profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number |\n| profile.professional.clinics\\[\\].address | object | Address details of the clinic |\n| profile.professional.clinics\\[\\].address.line1 | string | Address line 1 |\n| profile.professional.clinics\\[\\].address.line2 | string | Address line 2 |\n| profile.professional.clinics\\[\\].address.city | string | City of the clinic |\n| profile.professional.clinics\\[\\].address.state | string | State of the clinic |\n| profile.professional.clinics\\[\\].address.country | string | Country of the clinic |\n| profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic |\n| profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic |\n| profile.professional.default_clinic | string | Default clinic ID |\n| profile.professional.all_registrations | array | Registrations of the doctor |\n| profile.professional.all_registrations\\[\\].id | number | Registration ID |\n| profile.professional.all_registrations\\[\\].council | string | Medical council name |\n| profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number |\n| profile.professional.all_registrations\\[\\].year | string | Year of registration |\n| profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration |\n| profile.professional.degree | array | Degrees earned by the doctor |\n| profile.professional.degree\\[\\].id | number | Degree ID |\n| profile.professional.degree\\[\\].name | string | Name of the degree |\n| profile.professional.degree\\[\\].branch_name | string | Branch name |\n| profile.professional.degree\\[\\].college_name | string | College name |\n| profile.professional.degree\\[\\].display_status | string | Display status of the degree |\n| profile.professional.degree\\[\\].start_year | string | Start year of the degree |\n| profile.professional.degree\\[\\].end_year | string | End year of the degree |\n| profile.professional.major_speciality | object | Major speciality of the doctor |\n| profile.professional.major_speciality.name | string | Name of the major speciality |\n| profile.professional.speciality | array | Specialities of the doctor |\n| profile.professional.speciality\\[\\].name | string | Name of the speciality |\n| **Status Codes** | | |\n\n• 200: Success\n\n• 403: Doctor data missing\n\n• 500: Wrong API URL/Token mismatched/Wrong JSON request.","operationId":"GetDoctorprofile","parameters":["e4d8302f-d330-438f-94b6-48a5ea189ae8","9f929b2c-7f3c-453d-bfb4-af1ff535890d"],"responses":{"200":"0be486c7-1395-4e9e-b230-036929c26706","403":"e7a86da9-31f1-4a6e-9c9b-744305cc3847","500":"29500ac6-5060-4ec4-860a-ad5f372b44c8"},"deprecated":false,"method":"get","type":"path","servers":["3d38dc56-edc1-44c2-8262-1763e33f454d","8168b535-1c5c-4958-a520-99ba623ff091"],"security":[],"path":"/dr/v1/doctor/{doctor_id}","baseUrlOptions":["https://api.eka.care","https://api.dev.eka.care"],"title":"Get Doctor profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e4d8302f-d330-438f-94b6-48a5ea189ae8":{"name":"auth","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","example":"auth","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"9f929b2c-7f3c-453d-bfb4-af1ff535890d":{"name":"doctor_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"0be486c7-1395-4e9e-b230-036929c26706":{"description":"OK","headers":{"Date":{"content":{"text/plain":{"schema":{"type":"string"},"example":"Tue, 24 Mar 2020 06:26:06 GMT"}}},"Content-Length":{"content":{"text/plain":{"schema":{"type":"string"},"example":"380"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string"},"example":"keep-alive"}}},"Server":{"content":{"text/plain":{"schema":{"type":"string"},"example":"nginx/1.10.3 (Ubuntu)"}}},"Vary":{"content":{"text/plain":{"schema":{"type":"string"},"example":"Cookie, Accept-Encoding"}}},"Content-Encoding":{"content":{"text/plain":{"schema":{"type":"string"},"example":"gzip"}}},"Strict-Transport-Security":{"content":{"text/plain":{"schema":{"type":"string"},"example":"max-age=15768000"}}}},"content":{"application/json":{"schema":{"type":"object","title":"200OK4","required":["id","profile"],"example":{"id":"1234567890","profile":{"personal":{"salutation":"Dr.","first_name":"Rahul","middle_name":"","last_name":"Kumar","dob":"1970-01-01","gender":"M","pic":"https://a.eka.care/doctor-avatar/170062845263102"},"professional":{"active":true,"username":"dr-rahul-kumar-cardiologist","about":"Dr. Rahul Kumar is a Cardiologist with 43 years of experience.","language":[{"code":"en","language":"English"}],"degree":[{"name":"MBBS,MD","branch_name":"","college_name":"","start_year":"","end_year":""}],"major_speciality":{"name":"Cardiologist","code":"CA"},"speciality":[{"name":"General Physician"},{"name":"Diabetologist"},{"name":"Allergy Specialist"}],"clinics":[{"id":"1234567899876","name":"Vagus Hospital \u0026 Health Services","contacts":[{"name":"Phone","number":"+91999999999"}],"address":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"}}],"default_clinic":"1234567899876"}}},"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"profile":{"title":"Profile1","required":["personal","professional"],"type":"object","properties":{"personal":{"title":"Personal","required":["salutation","first_name","middle_name","last_name","dob","gender"],"type":"object","properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"profile.personal.first_name","typeLabel":"string"},"middle_name":{"type":"string","isRequired":true,"uniqueKey":"profile.personal.middle_name","typeLabel":"string"},"last_name":{"type":"string","isRequired":true,"uniqueKey":"profile.personal.last_name","typeLabel":"string"},"dob":{"type":"string","isRequired":true,"uniqueKey":"profile.personal.dob","typeLabel":"string"},"gender":{"type":"string","isRequired":true,"uniqueKey":"profile.personal.gender","typeLabel":"string"}},"example":{"first_name":"doctor","middle_name":"","last_name":"doctor","dob":"","gender":"M"},"isRequired":true,"uniqueKey":"profile.personal","typeLabel":"Personal · object"},"professional":{"title":"Professional","required":["active","about","language","degree","major_speciality","speciality","clinics","default_clinic"],"type":"object","properties":{"active":{"type":"boolean","isRequired":true,"uniqueKey":"profile.professional.active","typeLabel":"boolean"},"about":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.about","typeLabel":"string"},"language":{"type":"array","items":{"title":"Language","required":["code","language"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.language.items.[INDEX].code","typeLabel":"string"},"language":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.language.items.[INDEX].language","typeLabel":"string"}},"example":{"code":"en","language":"English"},"uniqueKey":"profile.professional.language.items.[INDEX]","typeLabel":"Language · object"},"description":"","isRequired":true,"uniqueKey":"profile.professional.language","typeLabel":"Language · object[]"},"degree":{"type":"array","items":{"title":"Degree","required":["name","branch_name","college_name","start_year","end_year"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.degree.items.[INDEX].name","typeLabel":"string"},"branch_name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.degree.items.[INDEX].branch_name","typeLabel":"string"},"college_name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.degree.items.[INDEX].college_name","typeLabel":"string"},"start_year":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.degree.items.[INDEX].start_year","typeLabel":"string"},"end_year":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.degree.items.[INDEX].end_year","typeLabel":"string"}},"example":{"name":"MD","branch_name":"","college_name":"","start_year":"","end_year":""},"uniqueKey":"profile.professional.degree.items.[INDEX]","typeLabel":"Degree · object"},"description":"","isRequired":true,"uniqueKey":"profile.professional.degree","typeLabel":"Degree · object[]"},"major_speciality":{"title":"MajorSpeciality","required":["name","code"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.major_speciality.name","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.major_speciality.code","typeLabel":"string"}},"example":{"name":"Cardiologist","code":"CA"},"isRequired":true,"uniqueKey":"profile.professional.major_speciality","typeLabel":"MajorSpeciality · object"},"speciality":{"type":"array","items":{"title":"Speciality","required":["name"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.speciality.items.[INDEX].name","typeLabel":"string"}},"example":{"name":"General Physician"},"uniqueKey":"profile.professional.speciality.items.[INDEX]","typeLabel":"Speciality · object"},"description":"","isRequired":true,"uniqueKey":"profile.professional.speciality","typeLabel":"Speciality · object[]"},"clinics":{"type":"array","items":{"title":"Clinic","required":["id","name","contacts","address"],"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].name","typeLabel":"string"},"contacts":{"type":"array","items":{"title":"Contact","required":["name","number"],"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].contacts.items.[INDEX].name","typeLabel":"string"},"number":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].contacts.items.[INDEX].number","typeLabel":"string"}},"example":{"name":"Phone","number":"+91999999999"},"uniqueKey":"profile.professional.clinics.items.[INDEX].contacts.items.[INDEX]","typeLabel":"Contact · object"},"description":"","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].contacts","typeLabel":"Contact · object[]"},"address":{"title":"Address2","required":["line1","city","country","state","pin"],"type":"object","properties":{"line1":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address.line1","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address.city","typeLabel":"string"},"country":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address.country","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address.state","typeLabel":"string"},"pin":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address.pin","typeLabel":"string"}},"example":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"},"isRequired":true,"uniqueKey":"profile.professional.clinics.items.[INDEX].address","typeLabel":"Address2 · object"}},"example":{"id":"1234567899876","name":"Vagus Hospital \u0026 Health Services","contacts":[{"name":"Phone","number":"+91999999999"}],"address":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"}},"uniqueKey":"profile.professional.clinics.items.[INDEX]","typeLabel":"Clinic · object"},"description":"","isRequired":true,"uniqueKey":"profile.professional.clinics","typeLabel":"Clinic · object[]"},"default_clinic":{"type":"string","isRequired":true,"uniqueKey":"profile.professional.default_clinic","typeLabel":"string"}},"example":{"active":true,"about":"doctor doctor is a Cardiologist with 43 years of experience.","language":[{"code":"en","language":"English"}],"degree":[{"name":"MD","branch_name":"","college_name":"","start_year":"","end_year":""}],"major_speciality":{"name":"Cardiologist","code":"CA"},"speciality":[{"name":"General Physician"},{"name":"Diabetologist"},{"name":"Allergy Specialist"}],"clinics":[{"id":"1234567899876","name":"Vagus Hospital \u0026 Health Services","contacts":[{"name":"Phone","number":"+91999999999"}],"address":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"}}],"default_clinic":"1234567899876"},"isRequired":true,"uniqueKey":"profile.professional","typeLabel":"Professional · object"}},"example":{"personal":{"salutation":"Dr.","first_name":"doctor","middle_name":"","last_name":"doctor","dob":"","gender":"M"},"professional":{"active":true,"about":"doctor doctor is a Cardiologist with 43 years of experience.","language":[{"code":"en","language":"English"}],"degree":[{"name":"MD","branch_name":"","college_name":"","start_year":"","end_year":""}],"major_speciality":{"name":"Cardiologist","code":"CA"},"speciality":[{"name":"General Physician"},{"name":"Diabetologist"},{"name":"Allergy Specialist"}],"clinics":[{"id":"1234567899876","name":"Vagus Hospital \u0026 Health Services","contacts":[{"name":"Phone","number":"+91999999999"}],"address":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"}}],"default_clinic":"1234567899876"}},"isRequired":true,"uniqueKey":"profile","typeLabel":"Profile1 · object"}},"uniqueKey":"","typeLabel":"200OK4 · object"},"examples":{"Example":{"title":"Example","value":{"id":"1234567890","profile":{"personal":{"salutation":"Dr.","first_name":"Rahul","middle_name":"","last_name":"Kumar","dob":"1970-01-01","gender":"M","pic":"https://a.eka.care/doctor-avatar/170062845263102"},"professional":{"active":true,"username":"dr-rahul-kumar-cardiologist","about":"Dr. Rahul Kumar is a Cardiologist with 43 years of experience.","language":[{"code":"en","language":"English"}],"degree":[{"name":"MBBS,MD","branch_name":"","college_name":"","start_year":"","end_year":""}],"major_speciality":{"name":"Cardiologist","code":"CA"},"speciality":[{"name":"General Physician"},{"name":"Diabetologist"},{"name":"Allergy Specialist"}],"clinics":[{"id":"1234567899876","name":"Vagus Hospital \u0026 Health Services","contacts":[{"name":"Phone","number":"+91999999999"}],"address":{"line1":"H No -122/a,, Pocket 2 back side of Yamaha 2 wheeler showroom., Pocket 2, Gate No :-2, nearest to Homeopathy clinic.","city":"Delhi","country":"India","state":"Delhi","pin":"110085"}}],"default_clinic":"1234567899876"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7a86da9-31f1-4a6e-9c9b-744305cc3847":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","title":"403ForbiddenBusinessPatientDetailsMissing1","required":["data","error"],"example":{"data":{},"error":{"code":"UNAUTHORIZED_ENTITY","message":"You are not authorized to view requisted resource Doctor"}},"properties":{"data":{"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"error":{"title":"Error","required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"example":{"code":"NOT_ALLOWED","message":"You are not allowed to add resource"},"isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"uniqueKey":"","typeLabel":"403ForbiddenBusinessPatientDetailsMissing1 · object"},"example":{"data":{},"error":{"code":"UNAUTHORIZED_ENTITY","message":"You are not authorized to view requisted resource Doctor"}},"examples":{"Example":{"title":"Example","value":{"data":{},"error":{"code":"UNAUTHORIZED_ENTITY","message":"You are not authorized to view requisted resource Doctor"}}}},"exampleType":"examples"}},"exampleType":"examples"},"29500ac6-5060-4ec4-860a-ad5f372b44c8":{"description":"Internal Server Error","headers":{},"content":{"application/json":{"schema":{"type":"object","title":"500WrongAPIURLTokenmismatchedWrongJSONrequest.1","required":["data","error"],"example":{"data":{},"error":{"code":"INVALID_DATA","message":"Doctor id entered is incorrect"}},"properties":{"data":{"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"error":{"title":"Error","required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"example":{"code":"NOT_ALLOWED","message":"You are not allowed to add resource"},"isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"uniqueKey":"","typeLabel":"500WrongAPIURLTokenmismatchedWrongJSONrequest.1 · object"},"example":{"data":{},"error":{"code":"INVALID_DATA","message":"Doctor id entered is incorrect"}},"examples":{"Example":{"title":"Example","value":{"data":{},"error":{"code":"INVALID_DATA","message":"Doctor id entered is incorrect"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"3d38dc56-edc1-44c2-8262-1763e33f454d":{"description":"Production","url":"https://api.eka.care"},"8168b535-1c5c-4958-a520-99ba623ff091":{"description":"Stage/Sandbox","url":"https://api.dev.eka.care"}}},"originalFileLocation":"api-reference/doc-tool/doc-tool.yaml"},"subdomain":"ekacare","siteName":"Eka Developer Platform APIs","title":"Get Doctor profile - Eka Developer Platform APIs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-23T14:07:53.813Z","originalFileLocation":"api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"### Overview This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics. ### Request Parameters | Parameter | Type | Description | Required | | --- | --- | --- | --- | | doctor_id | string | Unique identifier for the doctor | Yes | ### Response Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the doctor in Eka | | created_at | datetime | Timestamp when the doctor profile was created | | profile | object | Doctor\u0026#x27;s profile details | | profile.personal | object | Personal details of the doctor | | profile.personal.salutation | string | Salutation (e.g., Dr.) | | profile.personal.first_name | string | First name of the doctor | | profile.personal.middle_name | string | Middle name of the doctor | | profile.personal.last_name | string | Last name of the doctor | | profile.personal.email | string | Email address of the doctor | | profile.personal.gender | string | Gender of the doctor | | profile.personal.dob | date | Date of birth of the doctor | | profile.professional | object | Professional details of the doctor | | profile.professional.username | string | Username of the Doctor| | profile.professional.active | boolean | Flag indicating if the profile is active | | profile.professional.about | string | About section describing the doctor | | profile.professional.language | array | Languages spoken by the doctor | | profile.professional.language\\[\\].language | string | Language name (e.g., English) | | profile.professional.clinics | array | Clinics associated with the doctor | | profile.professional.clinics\\[\\] | object | Clinic details | | profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic | | profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located | | profile.professional.clinics\\[\\].name | string | Name of the clinic | | profile.professional.clinics\\[\\].email | string | Email address of the clinic | | profile.professional.clinics\\[\\].about | string | About section of the clinic | | profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic | | profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic | | profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) | | profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number | | profile.professional.clinics\\[\\].address | object | Address details of the clinic | | profile.professional.clinics\\[\\].address.line1 | string | Address line 1 | | profile.professional.clinics\\[\\].address.line2 | string | Address line 2 | | profile.professional.clinics\\[\\].address.city | string | City of the clinic | | profile.professional.clinics\\[\\].address.state | string | State of the clinic | | profile.professional.clinics\\[\\].address.country | string | Country of the clinic | | profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic | | profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic | | profile.professional.default_clinic | string | Default clinic ID | | profile.professional.all_registrations | array | Registrations of the doctor | | profile.professional.all_registrations\\[\\].id | number | Registration ID | | profile.professional.all_registrations\\[\\].council | string | Medical council name | | profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number | | profile.professional.all_registrations\\[\\].year | string | Year of registration | | profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration | | profile.professional.degree | array | Degrees earned by the doctor | | profile.professional.degree\\[\\].id | number | Degree ID | | profile.professional.degree\\[\\].name | string | Name of the degree | | profile.professional.degree\\[\\].branch_name | string | Branch name | | profile.professional.degree\\[\\].college_name | string | College name | | profile.professional.degree\\[\\].display_status | string | Display status of the degree | | profile.professional.degree\\[\\].start_year | string | Start year of the degree | | profile.professional.degree\\[\\].end_year | string | End year of the degree | | profile.professional.major_speciality | object | Major speciality of the doctor | | profile.professional.major_speciality.name | string | Name of the major speciality | | profile.professional.speciality | array | Specialities of the doctor | | profile.professional.speciality\\[\\].name | string | Name of the speciality | | Status Codes | | | • 200: Success • 403: Doctor data missing • 500: Wrong API URL/Token mismatched/Wrong JSON request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Eka Developer Platform APIs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Doctor profile - Eka Developer Platform APIs\">\u003cmeta data-mint-head property=\"og:description\" content=\"### Overview This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics. ### Request Parameters | Parameter | Type | Description | Required | | --- | --- | --- | --- | | doctor_id | string | Unique identifier for the doctor | Yes | ### Response Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the doctor in Eka | | created_at | datetime | Timestamp when the doctor profile was created | | profile | object | Doctor\u0026#x27;s profile details | | profile.personal | object | Personal details of the doctor | | profile.personal.salutation | string | Salutation (e.g., Dr.) | | profile.personal.first_name | string | First name of the doctor | | profile.personal.middle_name | string | Middle name of the doctor | | profile.personal.last_name | string | Last name of the doctor | | profile.personal.email | string | Email address of the doctor | | profile.personal.gender | string | Gender of the doctor | | profile.personal.dob | date | Date of birth of the doctor | | profile.professional | object | Professional details of the doctor | | profile.professional.username | string | Username of the Doctor| | profile.professional.active | boolean | Flag indicating if the profile is active | | profile.professional.about | string | About section describing the doctor | | profile.professional.language | array | Languages spoken by the doctor | | profile.professional.language\\[\\].language | string | Language name (e.g., English) | | profile.professional.clinics | array | Clinics associated with the doctor | | profile.professional.clinics\\[\\] | object | Clinic details | | profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic | | profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located | | profile.professional.clinics\\[\\].name | string | Name of the clinic | | profile.professional.clinics\\[\\].email | string | Email address of the clinic | | profile.professional.clinics\\[\\].about | string | About section of the clinic | | profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic | | profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic | | profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) | | profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number | | profile.professional.clinics\\[\\].address | object | Address details of the clinic | | profile.professional.clinics\\[\\].address.line1 | string | Address line 1 | | profile.professional.clinics\\[\\].address.line2 | string | Address line 2 | | profile.professional.clinics\\[\\].address.city | string | City of the clinic | | profile.professional.clinics\\[\\].address.state | string | State of the clinic | | profile.professional.clinics\\[\\].address.country | string | Country of the clinic | | profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic | | profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic | | profile.professional.default_clinic | string | Default clinic ID | | profile.professional.all_registrations | array | Registrations of the doctor | | profile.professional.all_registrations\\[\\].id | number | Registration ID | | profile.professional.all_registrations\\[\\].council | string | Medical council name | | profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number | | profile.professional.all_registrations\\[\\].year | string | Year of registration | | profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration | | profile.professional.degree | array | Degrees earned by the doctor | | profile.professional.degree\\[\\].id | number | Degree ID | | profile.professional.degree\\[\\].name | string | Name of the degree | | profile.professional.degree\\[\\].branch_name | string | Branch name | | profile.professional.degree\\[\\].college_name | string | College name | | profile.professional.degree\\[\\].display_status | string | Display status of the degree | | profile.professional.degree\\[\\].start_year | string | Start year of the degree | | profile.professional.degree\\[\\].end_year | string | End year of the degree | | profile.professional.major_speciality | object | Major speciality of the doctor | | profile.professional.major_speciality.name | string | Name of the major speciality | | profile.professional.speciality | array | Specialities of the doctor | | profile.professional.speciality\\[\\].name | string | Name of the speciality | | Status Codes | | | • 200: Success • 403: Doctor data missing • 500: Wrong API URL/Token mismatched/Wrong JSON request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Eka Developer Platform APIs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ekacare.mintlify.app/_mintlify/api/og/v2?division=Doctor+and+clinic+API\u0026amp;title=Get+Doctor+profile\u0026amp;description=%0A%23%23%23+Overview%0AThis+API+endpoint+is+used+to+retrieve+detailed+information+about+a+specific+doctor+using+their+unique+identifier.+The+response+includes+comprehens\u0026amp;theme=a9803bbd0b15db322b010df8\u0026amp;signature=c880fb08f2da09ec8da4f35765c4dc08380b8e96ad73a43f9215514c1a46d2ba\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Doctor profile - Eka Developer Platform APIs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"### Overview This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics. ### Request Parameters | Parameter | Type | Description | Required | | --- | --- | --- | --- | | doctor_id | string | Unique identifier for the doctor | Yes | ### Response Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the doctor in Eka | | created_at | datetime | Timestamp when the doctor profile was created | | profile | object | Doctor\u0026#x27;s profile details | | profile.personal | object | Personal details of the doctor | | profile.personal.salutation | string | Salutation (e.g., Dr.) | | profile.personal.first_name | string | First name of the doctor | | profile.personal.middle_name | string | Middle name of the doctor | | profile.personal.last_name | string | Last name of the doctor | | profile.personal.email | string | Email address of the doctor | | profile.personal.gender | string | Gender of the doctor | | profile.personal.dob | date | Date of birth of the doctor | | profile.professional | object | Professional details of the doctor | | profile.professional.username | string | Username of the Doctor| | profile.professional.active | boolean | Flag indicating if the profile is active | | profile.professional.about | string | About section describing the doctor | | profile.professional.language | array | Languages spoken by the doctor | | profile.professional.language\\[\\].language | string | Language name (e.g., English) | | profile.professional.clinics | array | Clinics associated with the doctor | | profile.professional.clinics\\[\\] | object | Clinic details | | profile.professional.clinics\\[\\]..id | string | Unique identifier for the clinic | | profile.professional.clinics\\[\\].city_name | string | City name where the clinic is located | | profile.professional.clinics\\[\\].name | string | Name of the clinic | | profile.professional.clinics\\[\\].email | string | Email address of the clinic | | profile.professional.clinics\\[\\].about | string | About section of the clinic | | profile.professional.clinics\\[\\].speciality | array | Specialities offered at the clinic | | profile.professional.clinics\\[\\].number | array | Contact numbers for the clinic | | profile.professional.clinics\\[\\].number\\[\\].name | string | Type of contact number (e.g., Phone, Mobile) | | profile.professional.clinics\\[\\].number\\[\\].n | string | Contact number | | profile.professional.clinics\\[\\].address | object | Address details of the clinic | | profile.professional.clinics\\[\\].address.line1 | string | Address line 1 | | profile.professional.clinics\\[\\].address.line2 | string | Address line 2 | | profile.professional.clinics\\[\\].address.city | string | City of the clinic | | profile.professional.clinics\\[\\].address.state | string | State of the clinic | | profile.professional.clinics\\[\\].address.country | string | Country of the clinic | | profile.professional.clinics\\[\\].address.pincode | string | Pincode of the clinic | | profile.professional.clinics\\[\\].location | array | Location coordinates of the clinic | | profile.professional.default_clinic | string | Default clinic ID | | profile.professional.all_registrations | array | Registrations of the doctor | | profile.professional.all_registrations\\[\\].id | number | Registration ID | | profile.professional.all_registrations\\[\\].council | string | Medical council name | | profile.professional.all_registrations\\[\\].medical_id | string | Medical ID number | | profile.professional.all_registrations\\[\\].year | string | Year of registration | | profile.professional.all_registrations\\[\\].default | boolean | Flag indicating if it is the default registration | | profile.professional.degree | array | Degrees earned by the doctor | | profile.professional.degree\\[\\].id | number | Degree ID | | profile.professional.degree\\[\\].name | string | Name of the degree | | profile.professional.degree\\[\\].branch_name | string | Branch name | | profile.professional.degree\\[\\].college_name | string | College name | | profile.professional.degree\\[\\].display_status | string | Display status of the degree | | profile.professional.degree\\[\\].start_year | string | Start year of the degree | | profile.professional.degree\\[\\].end_year | string | End year of the degree | | profile.professional.major_speciality | object | Major speciality of the doctor | | profile.professional.major_speciality.name | string | Name of the major speciality | | profile.professional.speciality | array | Specialities of the doctor | | profile.professional.speciality\\[\\].name | string | Name of the speciality | | Status Codes | | | • 200: Success • 403: Doctor data missing • 500: Wrong API URL/Token mismatched/Wrong JSON request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ekacare.mintlify.app/_mintlify/api/og/v2?division=Doctor+and+clinic+API\u0026amp;title=Get+Doctor+profile\u0026amp;description=%0A%23%23%23+Overview%0AThis+API+endpoint+is+used+to+retrieve+detailed+information+about+a+specific+doctor+using+their+unique+identifier.+The+response+includes+comprehens\u0026amp;theme=a9803bbd0b15db322b010df8\u0026amp;signature=c880fb08f2da09ec8da4f35765c4dc08380b8e96ad73a43f9215514c1a46d2ba\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ekacare/I5vwrJDJkiTYS8E3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Eka Developer Platform APIs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6B5CE0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.eka.care/#organization\",\"name\":\"Eka Developer Platform APIs\",\"url\":\"https://developer.eka.care\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://cdn.eka.care/vagus/clzwrv3o600260ti3bg9q1det.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.eka.care#website\",\"name\":\"Eka Developer Platform APIs\",\"url\":\"https://developer.eka.care\",\"publisher\":{\"@id\":\"https://developer.eka.care/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile#webpage\",\"url\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile\",\"name\":\"Get Doctor profile\",\"description\":\"### Overview This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics. ### Request Parameters | Parameter | Type | Description | Required | | --- | --- | --- | --- | | doctor_id | string | Unique identifier for the doctor | Yes | ### Response Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the doctor in Eka | | created_at | datetime | Timestamp when the doctor profile was created | | profile | object | Doctor's profile details | | profile.personal | object | Personal details of the doctor | | profile.personal.salutation | string | Salutation (e.g., Dr.) | | profile.personal.first_name | string | First name of the doctor | | profile.personal.middle_name | string | Middle name of the doctor | | profile.personal.last_name | string | Last name of the doctor | | profile.personal.email | string | Email address of the doctor | | profile.personal.gender | string | Gender of the doctor | | profile.personal.dob | date | Date of birth of the doctor | | profile.professional | object | Professional details of the doctor | | profile.professional.username | string | Username of the Doctor| | profile.professional.active | boolean | Flag indicating if the profile is active | | profile.professional.about | string | About section describing the doctor | | profile.professional.language | array | Languages spoken by the doctor | | profile.professional.language\\\\[\\\\].language | string | Language name (e.g., English) | | profile.professional.clinics | array | Clinics associated with the doctor | | profile.professional.clinics\\\\[\\\\] | object | Clinic details | | profile.professional.clinics\\\\[\\\\]..id | string | Unique identifier for the clinic | | profile.professional.clinics\\\\[\\\\].city_name | string | City name where the clinic is located | | profile.professional.clinics\\\\[\\\\].name | string | Name of the clinic | | profile.professional.clinics\\\\[\\\\].email | string | Email address of the clinic | | profile.professional.clinics\\\\[\\\\].about | string | About section of the clinic | | profile.professional.clinics\\\\[\\\\].speciality | array | Specialities offered at the clinic | | profile.professional.clinics\\\\[\\\\].number | array | Contact numbers for the clinic | | profile.professional.clinics\\\\[\\\\].number\\\\[\\\\].name | string | Type of contact number (e.g., Phone, Mobile) | | profile.professional.clinics\\\\[\\\\].number\\\\[\\\\].n | string | Contact number | | profile.professional.clinics\\\\[\\\\].address | object | Address details of the clinic | | profile.professional.clinics\\\\[\\\\].address.line1 | string | Address line 1 | | profile.professional.clinics\\\\[\\\\].address.line2 | string | Address line 2 | | profile.professional.clinics\\\\[\\\\].address.city | string | City of the clinic | | profile.professional.clinics\\\\[\\\\].address.state | string | State of the clinic | | profile.professional.clinics\\\\[\\\\].address.country | string | Country of the clinic | | profile.professional.clinics\\\\[\\\\].address.pincode | string | Pincode of the clinic | | profile.professional.clinics\\\\[\\\\].location | array | Location coordinates of the clinic | | profile.professional.default_clinic | string | Default clinic ID | | profile.professional.all_registrations | array | Registrations of the doctor | | profile.professional.all_registrations\\\\[\\\\].id | number | Registration ID | | profile.professional.all_registrations\\\\[\\\\].council | string | Medical council name | | profile.professional.all_registrations\\\\[\\\\].medical_id | string | Medical ID number | | profile.professional.all_registrations\\\\[\\\\].year | string | Year of registration | | profile.professional.all_registrations\\\\[\\\\].default | boolean | Flag indicating if it is the default registration | | profile.professional.degree | array | Degrees earned by the doctor | | profile.professional.degree\\\\[\\\\].id | number | Degree ID | | profile.professional.degree\\\\[\\\\].name | string | Name of the degree | | profile.professional.degree\\\\[\\\\].branch_name | string | Branch name | | profile.professional.degree\\\\[\\\\].college_name | string | College name | | profile.professional.degree\\\\[\\\\].display_status | string | Display status of the degree | | profile.professional.degree\\\\[\\\\].start_year | string | Start year of the degree | | profile.professional.degree\\\\[\\\\].end_year | string | End year of the degree | | profile.professional.major_speciality | object | Major speciality of the doctor | | profile.professional.major_speciality.name | string | Name of the major speciality | | profile.professional.speciality | array | Specialities of the doctor | | profile.professional.speciality\\\\[\\\\].name | string | Name of the speciality | | Status Codes | | | • 200: Success • 403: Doctor data missing • 500: Wrong API URL/Token mismatched/Wrong JSON request.\",\"dateModified\":\"2026-03-23T14:07:53.813Z\",\"isPartOf\":{\"@id\":\"https://developer.eka.care#website\"},\"breadcrumb\":{\"@id\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Doctor Tool\",\"item\":\"https://developer.eka.care/api-reference/doc-tool/Actors/actors\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Doctor and clinic API\",\"item\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/getting-started\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Doctor profile\",\"item\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile#apireference\",\"headline\":\"Get Doctor profile\",\"name\":\"Get Doctor profile\",\"description\":\"### Overview This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics. ### Request Parameters | Parameter | Type | Description | Required | | --- | --- | --- | --- | | doctor_id | string | Unique identifier for the doctor | Yes | ### Response Parameters | Parameter | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the doctor in Eka | | created_at | datetime | Timestamp when the doctor profile was created | | profile | object | Doctor's profile details | | profile.personal | object | Personal details of the doctor | | profile.personal.salutation | string | Salutation (e.g., Dr.) | | profile.personal.first_name | string | First name of the doctor | | profile.personal.middle_name | string | Middle name of the doctor | | profile.personal.last_name | string | Last name of the doctor | | profile.personal.email | string | Email address of the doctor | | profile.personal.gender | string | Gender of the doctor | | profile.personal.dob | date | Date of birth of the doctor | | profile.professional | object | Professional details of the doctor | | profile.professional.username | string | Username of the Doctor| | profile.professional.active | boolean | Flag indicating if the profile is active | | profile.professional.about | string | About section describing the doctor | | profile.professional.language | array | Languages spoken by the doctor | | profile.professional.language\\\\[\\\\].language | string | Language name (e.g., English) | | profile.professional.clinics | array | Clinics associated with the doctor | | profile.professional.clinics\\\\[\\\\] | object | Clinic details | | profile.professional.clinics\\\\[\\\\]..id | string | Unique identifier for the clinic | | profile.professional.clinics\\\\[\\\\].city_name | string | City name where the clinic is located | | profile.professional.clinics\\\\[\\\\].name | string | Name of the clinic | | profile.professional.clinics\\\\[\\\\].email | string | Email address of the clinic | | profile.professional.clinics\\\\[\\\\].about | string | About section of the clinic | | profile.professional.clinics\\\\[\\\\].speciality | array | Specialities offered at the clinic | | profile.professional.clinics\\\\[\\\\].number | array | Contact numbers for the clinic | | profile.professional.clinics\\\\[\\\\].number\\\\[\\\\].name | string | Type of contact number (e.g., Phone, Mobile) | | profile.professional.clinics\\\\[\\\\].number\\\\[\\\\].n | string | Contact number | | profile.professional.clinics\\\\[\\\\].address | object | Address details of the clinic | | profile.professional.clinics\\\\[\\\\].address.line1 | string | Address line 1 | | profile.professional.clinics\\\\[\\\\].address.line2 | string | Address line 2 | | profile.professional.clinics\\\\[\\\\].address.city | string | City of the clinic | | profile.professional.clinics\\\\[\\\\].address.state | string | State of the clinic | | profile.professional.clinics\\\\[\\\\].address.country | string | Country of the clinic | | profile.professional.clinics\\\\[\\\\].address.pincode | string | Pincode of the clinic | | profile.professional.clinics\\\\[\\\\].location | array | Location coordinates of the clinic | | profile.professional.default_clinic | string | Default clinic ID | | profile.professional.all_registrations | array | Registrations of the doctor | | profile.professional.all_registrations\\\\[\\\\].id | number | Registration ID | | profile.professional.all_registrations\\\\[\\\\].council | string | Medical council name | | profile.professional.all_registrations\\\\[\\\\].medical_id | string | Medical ID number | | profile.professional.all_registrations\\\\[\\\\].year | string | Year of registration | | profile.professional.all_registrations\\\\[\\\\].default | boolean | Flag indicating if it is the default registration | | profile.professional.degree | array | Degrees earned by the doctor | | profile.professional.degree\\\\[\\\\].id | number | Degree ID | | profile.professional.degree\\\\[\\\\].name | string | Name of the degree | | profile.professional.degree\\\\[\\\\].branch_name | string | Branch name | | profile.professional.degree\\\\[\\\\].college_name | string | College name | | profile.professional.degree\\\\[\\\\].display_status | string | Display status of the degree | | profile.professional.degree\\\\[\\\\].start_year | string | Start year of the degree | | profile.professional.degree\\\\[\\\\].end_year | string | End year of the degree | | profile.professional.major_speciality | object | Major speciality of the doctor | | profile.professional.major_speciality.name | string | Name of the major speciality | | profile.professional.speciality | array | Specialities of the doctor | | profile.professional.speciality\\\\[\\\\].name | string | Name of the speciality | | Status Codes | | | • 200: Success • 403: Doctor data missing • 500: Wrong API URL/Token mismatched/Wrong JSON request.\",\"url\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile\",\"mainEntityOfPage\":{\"@id\":\"https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile#webpage\"},\"dateModified\":\"2026-03-23T14:07:53.813Z\",\"publisher\":{\"@id\":\"https://developer.eka.care/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.eka.care#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Eka Developer Platform APIs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Eka Developer Platform APIs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/user-guides/get-started"}]},{"tab":"API Reference","groups":[{"group":"Authorization","icon":"lock","pages":[{"title":null,"href":"/api-reference/authorization/getting-started"},{"group":"APIs","pages":[{"group":"Core APIs","pages":[{"openapi":"post /connect-auth/v1/account/login","title":"Connect Login","href":"/api-reference/authorization/client-login"},{"openapi":"post /connect-auth/v1/account/refresh-token","title":"Connect Refresh","href":"/api-reference/authorization/refresh-token-v2"},{"openapi":"delete /privacy/v1/user","title":"Delete Account","href":"/api-reference/authorization/delete-account"}]},{"group":"Eka OIDC Provider","pages":[{"openapi":"get /oauth2/authorize","title":"Authorize User","href":"/api-reference/authorization/oauth2/authorize"},{"openapi":"post /oauth2/token","title":"Exchange Tokens","href":"/api-reference/authorization/oauth2/token"}]},{"group":"OIDC Partner APIs","pages":[{"openapi":"post /connect-auth/v1/oidc-client/{client_id}/verify","title":"Oidc Verify","href":"/api-reference/authorization/oidc-user-verify"},{"openapi":"post /connect-auth/v1/oidc-client/{client_id}/refresh","title":"Oidc Refresh","href":"/api-reference/authorization/oidc-user-refresh"}]}]},{"group":"SDKs","pages":[{"title":"Python SDK","href":"/api-reference/authorization/sdks/python-sdk"},{"title":"Go SDK","href":"/api-reference/authorization/sdks/go-sdk"},{"title":"Java SDK","href":"/api-reference/authorization/sdks/java-sdk"}]},{"title":null,"href":"/api-reference/authorization/invite-flow"},{"title":"Bring Your Own Auth (BYOA)","sidebarTitle":"BYOA","href":"/api-reference/authorization/byoa"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Getting Started","href":"/api-reference/connect/webhooks/getting-started"},{"title":"Webhook Signature","href":"/api-reference/connect/webhooks/webhook-signature"},{"group":"APIs","pages":[{"openapi":"post /notification/v1/connect/webhook/subscriptions","title":"Register Webhook","href":"/api-reference/connect/webhooks/register-webhook"},{"openapi":"get /notification/v1/connect/webhook/subscriptions","title":"Get Webhooks","href":"/api-reference/connect/webhooks/get-webhooks"},{"openapi":"delete /notification/v1/connect/webhook/subscriptions/{id}","title":"Delete a Webhook","href":"/api-reference/connect/webhooks/delete-webhook"}]},{"title":"Webhook Samples","href":"/api-reference/connect/webhooks/webhook-samples"}]},{"group":"Encryption","icon":"key","pages":[{"title":"Encrypted API Requests and Responses","href":"/api-reference/end-to-end-encryption/guide"}]},{"group":"HealthAI","pages":[{"title":"EkaScribe","icon":"microphone-lines","url":"/ekascribe/overview","href":"/api-reference/health-ai/ekascribe-link"},{"group":"MedAssist","icon":"mobile","pages":[{"title":"MedAssist Agent","href":"/api-reference/health-ai/medassist/overview"},{"group":"MedAssist APIs","icon":"mobile","pages":[{"title":"Create Session","openapi":"POST /med-assist/session","href":"/api-reference/health-ai/medassist/create-session"},{"title":"Get Session","openapi":"GET /med-assist/session/{session_id}","href":"/api-reference/health-ai/medassist/get-session"},{"title":"Refresh Session Token","openapi":"GET /med-assist/session/{session_id}/refresh","href":"/api-reference/health-ai/medassist/refresh-session"},{"title":"Get Conversation","api":"GET https://console.eka.care/conversations/","href":"/api-reference/health-ai/medassist/get-conversation"},{"title":"Get Messages","api":"GET https://console.eka.care/conversations/{conversation_id}/messages/","href":"/api-reference/health-ai/medassist/get-messages"},{"title":"WebSocket API","href":"/api-reference/health-ai/medassist/websocket"}]},{"group":"MedAssist Client SDKs","icon":"laptop-binary","pages":[{"title":"Overview","href":"/api-reference/health-ai/medassist/synapse/introduction"},{"title":"Choose your integration","href":"/api-reference/health-ai/medassist/synapse/choose-integration"},{"group":"Embed widget","icon":"code","pages":[{"title":"Quickstart","href":"/api-reference/health-ai/medassist/synapse/embed/quickstart"},{"title":"Customization \u0026 overrides","href":"/api-reference/health-ai/medassist/synapse/embed/customization"},{"title":"JavaScript API","href":"/api-reference/health-ai/medassist/synapse/embed/javascript-api"}]},{"group":"React SDK","icon":"react","pages":[{"title":"Installation \u0026 setup","href":"/api-reference/health-ai/medassist/synapse/react/installation"},{"title":"Configuration reference","href":"/api-reference/health-ai/medassist/synapse/react/configuration"},{"title":"Theming \u0026 design system","href":"/api-reference/health-ai/medassist/synapse/react/theming"}]},{"group":"Core SDK","icon":"cube","pages":[{"title":"Quickstart","href":"/api-reference/health-ai/medassist/synapse/core/quickstart"},{"title":"Events","href":"/api-reference/health-ai/medassist/synapse/core/events"},{"title":"Tool calls \u0026 elicitation","href":"/api-reference/health-ai/medassist/synapse/core/tool-calls"},{"title":"Voice \u0026 audio","href":"/api-reference/health-ai/medassist/synapse/core/voice"},{"title":"API reference","href":"/api-reference/health-ai/medassist/synapse/core/api-reference"}]}]}]},{"group":"Medical Document Parsing","icon":"book-open-cover","pages":[{"group":"APIs","icon":"network-wired","pages":[{"title":null,"href":"/api-reference/health-ai/medical-document-parsing/introduction"},{"title":"Upload Report","openapi":"POST /mr/api/v2/docs","href":"/api-reference/health-ai/medical-document-parsing/upload-report"},{"title":"Parsed Report Result","openapi":"get /mr/api/v1/docs/{document_id}/result","href":"/api-reference/health-ai/medical-document-parsing/parsed-report-result"},{"title":"Delete Document","openapi":"delete /mr/api/v1/docs/{id}","href":"/api-reference/health-ai/medical-document-parsing/delete-document"}]},{"group":"SDKs","icon":"box-open","pages":[{"title":"Python","href":"/SDKs/backend/report-parsing-sdk"},{"title":"Java","href":"/SDKs/backend/report-parsing-sdk-java"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":null,"href":"/api-reference/health-ai/medical-document-parsing/smart-report-webhook"},{"title":null,"href":"/api-reference/health-ai/medical-document-parsing/pii-webhook"},{"title":null,"href":"/api-reference/health-ai/medical-document-parsing/classification-webhook"}]}]},{"group":"Medical Entity Codification","icon":"tags","pages":[{"title":"Medical Entity Codification","href":"/api-reference/health-ai/medical-entity-codification/overview"},{"title":"List Registry","openapi":"GET /med-link/registry/","href":"/api-reference/health-ai/medical-entity-codification/registry"},{"title":"Link Entity","openapi":"POST /med-link/nel/link","href":"/api-reference/health-ai/medical-entity-codification/link-entity"},{"title":"Link Entities (Batch)","openapi":"POST /med-link/nel/link/batch","href":"/api-reference/health-ai/medical-entity-codification/link-entity-batch"}]}]},{"group":"ABDM Connect","icon":"connectdevelop","pages":[{"title":"Overview","icon":"compass","href":"/api-reference/user-app/abdm-connect/overview"},{"title":"Error Code Mapping","sidebarTitle":"Errors","icon":"circle-exclamation","href":"/api-reference/user-app/abdm-connect/errors"},{"group":"PHR App","icon":"mobile-screen-button","pages":[{"title":"Build a PHR App","href":"/api-reference/user-app/abdm-connect/phr/overview"},{"title":"1 · ABHA Onboarding","href":"/api-reference/user-app/abdm-connect/phr/abha-onboarding"},{"title":"2 · Profile Management","href":"/api-reference/user-app/abdm-connect/phr/profile"},{"title":"3 · Scan \u0026 Share","href":"/api-reference/user-app/abdm-connect/phr/scan-and-share"},{"title":"4 · Discover \u0026 Link Records","href":"/api-reference/user-app/abdm-connect/phr/discover-and-link"},{"title":"5 · Consents \u0026 Subscriptions","href":"/api-reference/user-app/abdm-connect/phr/consents"},{"title":"6 · Fetch \u0026 Display Records","href":"/api-reference/user-app/abdm-connect/phr/records"},{"title":"7 · PHR Webhooks","href":"/api-reference/user-app/abdm-connect/phr/webhooks"}]},{"group":"Milestone 1","icon":"user-plus","pages":[{"title":"Milestone 1","href":"/api-reference/user-app/abdm-connect/flows/m1"},{"group":"ABHA Creation and Login","icon":"user-plus","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/registration/intro"},{"group":"Create","icon":"plus","pages":[{"group":"Aadhaar","icon":"id-card","pages":[{"openapi":"post /abdm/na/v1/registration/aadhaar/init","title":"Generate OTP","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/initiate-registration"},{"openapi":"post /abdm/na/v1/registration/aadhaar/resend","title":"Resend OTP","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/aadhaar-resend-otp"},{"openapi":"post /abdm/na/v1/registration/aadhaar/verify","title":"Verify OTP","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/verify-otp"},{"openapi":"post /abdm/na/v1/registration/aadhaar/mobile/resend","title":"Mobile Resend OTP","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/mobile-resend-otp"},{"openapi":"post /abdm/na/v1/registration/aadhaar/mobile/verify","title":"Mobile Verify OTP","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/mobile-verify"},{"openapi":"post /abdm/na/v1/registration/aadhaar/create-phr","title":"Create","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/create-abha"},{"openapi":"post /abdm/na/v1/registration/aadhaar/auto-login","title":"Auto Login","href":"/api-reference/user-app/abdm-connect/enrollment/aadhaar/auto-login"}]},{"group":"Mobile","icon":"mobile","pages":[{"openapi":"post /abdm/na/v1/registration/mobile/init","title":"Generate OTP","href":"/api-reference/user-app/abdm-connect/enrollment/mobile/init"},{"openapi":"post /abdm/na/v1/registration/mobile/resend","title":"Resend OTP","href":"/api-reference/user-app/abdm-connect/enrollment/mobile/resend"},{"openapi":"post /abdm/na/v1/registration/mobile/verify","title":"Verify OTP","href":"/api-reference/user-app/abdm-connect/enrollment/mobile/verify"},{"openapi":"post /abdm/na/v1/registration/mobile/create-phr","title":"Create","href":"/api-reference/user-app/abdm-connect/enrollment/mobile/create"}]},{"group":"Face Auth","icon":"face-viewfinder","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/enrollment/face-auth/intro"},{"openapi":"post /abdm/na/v1/face-auth/init","title":"Face Auth Init","href":"/api-reference/user-app/abdm-connect/enrollment/face-auth/face-auth-init"},{"openapi":"post /abdm/na/v1/face-auth/capture","title":"Capture Face","href":"/api-reference/user-app/abdm-connect/enrollment/face-auth/face-auth-capture"},{"openapi":"post /abdm/na/v1/face-auth/verify","title":"Verify Face","href":"/api-reference/user-app/abdm-connect/enrollment/face-auth/face-auth-verify"}]}]},{"group":"Login","icon":"right-to-bracket","pages":[{"openapi":"post /abdm/na/v1/profile/login/methods","title":"Search Auth Methods","href":"/api-reference/user-app/abdm-connect/login/methods"},{"openapi":"post /abdm/na/v1/profile/login/init","title":"Generate OTP","href":"/api-reference/user-app/abdm-connect/login/init"},{"openapi":"post /abdm/na/v1/profile/login/verify","title":"Verify OTP","href":"/api-reference/user-app/abdm-connect/login/verify"},{"openapi":"post /abdm/na/v1/profile/login/phr","title":"Login","href":"/api-reference/user-app/abdm-connect/login/login"}]},{"group":"Commons","icon":"tape","pages":[{"openapi":"post /abdm/na/v1/registration/phr/check","title":"Does Abha Address Exist","href":"/api-reference/user-app/abdm-connect/commons/does-health-id-exist"},{"openapi":"get /abdm/v1/registration/pincode/{pincode}","title":null,"href":"/api-reference/user-app/abdm-connect/commons/pincode-details"},{"openapi":"get /abdm/na/v1/registration/suggest","title":"Suggest Abha Address","href":"/api-reference/user-app/abdm-connect/commons/suggest-abha-address"}]}]},{"group":"Profile Management","icon":"user","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/profile/getting-started"},{"openapi":"post /abdm/v1/profile/search","title":"Search ABHA","href":"/api-reference/user-app/abdm-connect/profile/search/search"},{"openapi":"get /abdm/v1/profile/asset/qr","title":"ABHA QR Code","href":"/api-reference/user-app/abdm-connect/profile/cards/qr-code"},{"openapi":"get /abdm/v1/profile/asset/card","title":"ABHA card","href":"/api-reference/user-app/abdm-connect/profile/cards/abha-card"},{"openapi":"get /abdm/v1/profile","title":"Profile Details","href":"/api-reference/user-app/abdm-connect/profile/details/profile-details"},{"openapi":"patch /abdm/v1/profile","title":"Update Profile","href":"/api-reference/user-app/abdm-connect/profile/details/update-profile"},{"openapi":"delete /abdm/v1/profile","title":"Delete Profile","href":"/api-reference/user-app/abdm-connect/profile/details/delete"},{"group":"KYC","pages":[{"openapi":"post /abdm/v1/profile/kyc/init","title":null,"href":"/api-reference/user-app/abdm-connect/profile/kyc/kyc-init"},{"openapi":"post /abdm/v1/profile/kyc/resend","title":null,"href":"/api-reference/user-app/abdm-connect/profile/kyc/kyc-resend"},{"openapi":"post /abdm/v1/profile/kyc/verify","title":null,"href":"/api-reference/user-app/abdm-connect/profile/kyc/kyc-verify"}]}]},{"group":"User Session","icon":"user-shield","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/session/getting-started"},{"openapi":"get /abdm/v1/session/status","title":null,"href":"/api-reference/user-app/abdm-connect/session/status"},{"openapi":"post /abdm/v1/session/init","title":null,"href":"/api-reference/user-app/abdm-connect/session/init"},{"openapi":"post /abdm/v1/session/verify","title":null,"href":"/api-reference/user-app/abdm-connect/session/verify"}]},{"group":"Scan \u0026 Share","icon":"qrcode","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/scan-and-share/getting-started"},{"group":"PHR","pages":[{"openapi":"post /abdm/v2/profile/share","title":"Request to generate token","href":"/api-reference/user-app/abdm-connect/scan-and-share/phr-scan-share"},{"openapi":"get /abdm/v2/profile/share/{request_id}","title":"Get appointment token","href":"/api-reference/user-app/abdm-connect/scan-and-share/phr-scan-share-token"}]},{"group":"HIP","pages":[{"openapi":"post /abdm/v1/hip/patient/profile/on-share","title":"On-Share","href":"/api-reference/user-app/abdm-connect/scan-and-share/scan-on-share"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"ABHA Address Created","href":"/api-reference/user-app/abdm-connect/webhooks/abha-created"},{"title":"Locker Created","href":"/api-reference/user-app/abdm-connect/webhooks/locker-created"}]},{"group":"SDKs","icon":"box-open","pages":[{"group":"M1 - ABHA","icon":"id-card","pages":[{"title":"Get Started","href":"/SDKs/web-sdk/abha-sdk/get-started"},{"title":"Registration","href":"/SDKs/web-sdk/abha-sdk/abha-login-create"},{"title":"Profile KYC","href":"/SDKs/web-sdk/abha-sdk/abha-kyc"},{"title":"Scan \u0026 Share","href":"/SDKs/web-sdk/abha-sdk/abha-s\u0026s"},{"title":"Custom Theming","href":"/SDKs/web-sdk/abha-sdk/abha-sdk-theme"}]}]}]},{"group":"Milestone 2","icon":"share-nodes","pages":[{"title":"Milestone 2","href":"/api-reference/user-app/abdm-connect/flows/m2"},{"group":"Care Contexts","icon":"notes-medical","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/care-contexts/getting-started"},{"group":"Data","icon":"files","pages":[{"title":"Encryption","href":"/api-reference/user-app/abdm-connect/care-contexts/ecdh-encryption"},{"group":"Sharing","icon":"share","pages":[{"openapi":"PATCH /abdm/v1/hiu/keyset","title":"Update public keyset","href":"/api-reference/user-app/abdm-connect/care-contexts/hiu-keys"},{"openapi":"POST /abdm/v1/hip/care-context/data/on-fetch","title":"Push care context data to HIU","href":"/api-reference/user-app/abdm-connect/care-contexts/data-on-fetch"},{"openapi":"POST /abdm/v1/hiu/care-context/data/on-push","title":"Push FHIR parsing status","href":"/api-reference/user-app/abdm-connect/care-contexts/data-on-push"},{"openapi":"GET /abdm/v1/hiu/care-context/data/{transaction_id}/entries/{content_ref}","title":"Fetch data push entry","href":"/api-reference/user-app/abdm-connect/care-contexts/data-push-entry"}]}]},{"group":"Providers","icon":"hospitals","pages":[{"group":"Linked Providers","pages":[{"openapi":"get /abdm/v1/care-contexts/providers","title":"Get Linked Providers","href":"/api-reference/user-app/abdm-connect/care-contexts/providers/providers"}]},{"group":"Linked Care Contexts","pages":[{"openapi":"get /abdm/v1/care-contexts/linked","title":"Get Linked CareContexts","href":"/api-reference/user-app/abdm-connect/care-contexts/records/records"}]}]},{"group":"Linking","icon":"link","pages":[{"group":"HIP Inititated Linking","pages":[{"openapi":"POST /abdm/v1/care-contexts/link","title":"Care context linking","href":"/api-reference/user-app/abdm-connect/care-contexts/link/hip-linking"}]},{"group":"Notify unlinked care contexts","pages":[{"openapi":"POST /abdm/v1/care-contexts/sms/notify","title":"Notify unlinked care contexts","href":"/api-reference/user-app/abdm-connect/care-contexts/records/notify"}]},{"group":"Discover and Link","pages":[{"title":"Care Context Discovery","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/introduction"},{"group":"PHR","pages":[{"openapi":"post /abdm/v1/care-contexts/discover","title":"Discover unlinked care-contexts","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/discover"},{"openapi":"post /abdm/v1/care-contexts/discover/link/init","title":"Initialise Linking","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/link-init"},{"openapi":"post /abdm/v1/care-contexts/discover/link/confirm","title":"Confirm Linking","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/link-confirm"}]},{"group":"HIP","pages":[{"openapi":"post /abdm/v1/care-contexts/on-discover","title":"Discover On Care Contexts","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/on_discover"},{"openapi":"post /abdm/v1/care-contexts/discover/link/on-init","title":"Discover Link On Init","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/link_on_init"},{"openapi":"post /abdm/v1/care-contexts/discover/link/on-confirm","title":"Discover Link On Confirm","href":"/api-reference/user-app/abdm-connect/care-contexts/discover/link_on_confirm"}]}]}]}]},{"group":"Patient Requests","icon":"hospital-user","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/patient-requests/getting-started"},{"openapi":"get /abdm/v1/requests","title":null,"href":"/api-reference/user-app/abdm-connect/patient-requests/list-requests"},{"openapi":"get /abdm/v1/request","title":null,"href":"/api-reference/user-app/abdm-connect/patient-requests/requests-get-details"}]},{"group":"Providers","icon":"hospital","pages":[{"group":"Search","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/providers/getting-started"},{"openapi":"get /abdm/v1/provider/{hip_id}","title":"Get Provider Details","href":"/api-reference/user-app/abdm-connect/providers/provider"},{"openapi":"get /abdm/v1/providers","title":"Search Providers","href":"/api-reference/user-app/abdm-connect/providers/search/providers"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Care Context Linking Status","href":"/api-reference/user-app/abdm-connect/webhooks/link-care-context"},{"title":"Scan and Share Token Received","href":"/api-reference/user-app/abdm-connect/webhooks/hip-scan-and-share"},{"title":"Health Data Requested by HIU","href":"/api-reference/user-app/abdm-connect/webhooks/hip-data-fetch"},{"title":"Health Data Received from HIP","href":"/api-reference/user-app/abdm-connect/webhooks/hiu-data-push"},{"title":"Subscription Updated","href":"/api-reference/user-app/abdm-connect/webhooks/subscription-modify"},{"title":"New Care Context Linked (Subscription)","href":"/api-reference/user-app/abdm-connect/webhooks/subscription-notify"},{"group":"Care Contexts Discovery","pages":[{"title":"Discovery Request Received","href":"/api-reference/user-app/abdm-connect/webhooks/discover-care-context"},{"title":"Link Initiation - Generate OTP","href":"/api-reference/user-app/abdm-connect/webhooks/discover-link-init"},{"title":"Link Confirmation - Verify OTP","href":"/api-reference/user-app/abdm-connect/webhooks/discover-link-confirm"}]}]},{"group":"SDKs","icon":"box-open","pages":[{"group":"Backend SDK","icon":"code","pages":[{"title":"Golang","href":"/SDKs/backend/go-sdk"}]}]}]},{"group":"Milestone 3","icon":"handshake","pages":[{"title":"Milestone 3","href":"/api-reference/user-app/abdm-connect/flows/m3"},{"group":"Consents","icon":"handshake","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/consents/getting-started"},{"group":"HIU","pages":[{"openapi":"post /abdm/v1/consents/create","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-create"},{"openapi":"post /abdm/v1/consents/list","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-list"},{"openapi":"post /abdm/v1/consents/details","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-details"}]},{"group":"PHR","pages":[{"openapi":"post /abdm/v1/consents/approve","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-approve"},{"openapi":"post /abdm/v1/consents/deny","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-deny"},{"openapi":"post /abdm/v1/consents/revoke","title":null,"href":"/api-reference/user-app/abdm-connect/consents/consent-revoke"}]},{"group":"Auto Approval","pages":[{"openapi":"get /abdm/v1/consents/auto-approval","title":null,"href":"/api-reference/user-app/abdm-connect/consents/auto-approval/get-status"},{"openapi":"patch /abdm/v1/consents/auto-approval","title":null,"href":"/api-reference/user-app/abdm-connect/consents/auto-approval/update-auto-approval-policy"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/consent-update"}]},{"group":"SDKs","icon":"box-open","pages":[{"group":"M3 - Consent Management","icon":"file-medical","pages":[{"title":"Get Started","href":"/SDKs/web-sdk/consent-management/get-started"}]}]}]},{"group":"Milestone 4","icon":"building-columns","pages":[{"title":"Milestone 4","href":"/api-reference/user-app/abdm-connect/flows/m4"},{"group":"Registries","icon":"building-columns","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/getting-started"},{"group":"HPR (Professionals)","icon":"user-doctor","pages":[{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/init","title":"Get Aadhaar OTP","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/get-aadhar-otp"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/verify","title":"Verify Aadhaar OTP","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/verify-aadhar-otp"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/demo/verify","title":"Verify Mobile","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/verify-mobile"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/check/exist","title":"Get HPR Info","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/check-hpr-exist"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/suggest","title":"Suggest IDs","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/suggest-ids"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/create","title":"Create HPR","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/create-hpr"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/mobile/init","title":"Get Mobile OTP","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/get-mobile-otp"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/mobile/verify","title":"Verify Mobile OTP","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/verify-mobile-otp"},{"openapi":"post /abdm/nhpr/v1/hpr/aadhaar/check/available","title":"Check If HPR is Available","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hpr/check-hpr-available"}]},{"group":"HFR (Facilities)","icon":"hospital","pages":[{"openapi":"get /abdm/nhpr/v1/hfr/search/{hfrId}","title":"Search HFR","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hfr/search-facility"},{"openapi":"post /abdm/nhpr/v1/hfr/onboard","title":"Onboard HFR","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hfr/onboard-facility"},{"openapi":"post /abdm/nhpr/v1/hfr/link","title":"Link HFR","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/hfr/link-facility"}]},{"group":"Onboarding","icon":"plus","pages":[{"title":"Facility Onboarding","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/onboarding-overview"},{"openapi":"post /abdm/v1/hip/onboard","title":"Onboard facility","href":"/api-reference/user-app/abdm-connect/nhpr-abdm/onboarding"}]}]},{"group":"SDKs","icon":"box-open","pages":[{"group":"M4- NHPR SDK","icon":"file-medical","pages":[{"title":"Get Started","href":"/SDKs/web-sdk/nhpr-sdk/get-started"}]}]}]},{"group":"UHI","icon":"hospital-user","pages":[{"group":"Blood Bank","icon":"droplet","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/blood-bank/getting-started"},{"openapi":"POST /abdm/uhi/v1/blood-bank/search","title":"Search Blood Banks","href":"/api-reference/user-app/abdm-connect/blood-bank/state-district"},{"openapi":"GET /abdm/uhi/v1/blood-bank/search/{request_id}","title":"Get Blood Banks","href":"/api-reference/user-app/abdm-connect/blood-bank/get-blood-banks"}]},{"group":"Scan \u0026 Pay","icon":"money-bill","hidden":true,"tag":"Coming Soon","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/scan-and-pay/getting-started"},{"openapi":"post /abdm/v1/profile/scan-and-pay/open-order","title":"Open Orders","href":"/api-reference/user-app/abdm-connect/scan-and-pay/open-orders"},{"openapi":"get /abdm/v1/profile/scan-and-pay/open-order/{request_id}","title":"Get Open Orders","href":"/api-reference/user-app/abdm-connect/scan-and-pay/get-open-orders"},{"openapi":"post /abdm/v1/profile/scan-and-pay/patient-select","title":"Patient Select","href":"/api-reference/user-app/abdm-connect/scan-and-pay/patient-select"},{"openapi":"get /abdm/v1/profile/scan-and-pay/patient-select/{request_id}","title":"Get Patient Select Details","href":"/api-reference/user-app/abdm-connect/scan-and-pay/get-patient-select"},{"openapi":"get /abdm/v1/profile/scan-and-pay/transaction-details/{request_id}","title":"Get Transaction Details","href":"/api-reference/user-app/abdm-connect/scan-and-pay/get-transaction-details"}]},{"group":"Physical Consultation","icon":"calendar-check","hidden":true,"tag":"Coming Soon","pages":[{"openapi":"post /abdm/uhi/v1/physical-consultation/search/doctors","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/search-doctors"},{"openapi":"get /abdm/uhi/v1/physical-consultation/search/doctors","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-doctors"},{"openapi":"post /abdm/uhi/v1/physical-consultation/search/doctors/slots","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/search-slots"},{"openapi":"get /abdm/uhi/v1/physical-consultation/search/doctors/slots","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-slots"},{"openapi":"post /abdm/uhi/v1/physical-consultation/booking/init","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/init"},{"openapi":"get /abdm/uhi/v1/physical-consultation/booking/init","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-init"},{"openapi":"post /abdm/uhi/v1/physical-consultation/booking/confirm","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/confirm"},{"openapi":"get /abdm/uhi/v1/physical-consultation/booking/confirm","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-confirm"},{"openapi":"post /abdm/uhi/v1/physical-consultation/booking/status","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/order-status"},{"openapi":"get /abdm/uhi/v1/physical-consultation/booking/status","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-order-status"},{"openapi":"post /abdm/uhi/v1/physical-consultation/booking/cancel","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/cancel"},{"openapi":"get /abdm/uhi/v1/physical-consultation/booking/cancel","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/get-cancel"},{"openapi":"post /abdm/uhi/v1/physical-consultation/booking/update","title":null,"href":"/api-reference/user-app/abdm-connect/phys-cons/update"}]},{"group":"Webhooks","icon":"webhook","hidden":true,"pages":[{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/search-doctors"},{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/search-slots"},{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/booking-init"},{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/booking-confirm"},{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/booking-status"},{"title":null,"href":"/api-reference/user-app/abdm-connect/webhooks/booking-cancel"}]}]},{"group":"NHCX","icon":"file-invoice-dollar","pages":[{"title":"Overview","href":"/api-reference/user-app/abdm-connect/nhcx/getting-started"},{"group":"Policy","icon":"magnifying-glass","pages":[{"openapi":"get /abdm/nhcx/v1/payers","title":"Search Payers","href":"/api-reference/user-app/abdm-connect/nhcx/search-payers"},{"openapi":"post /abdm/nhcx/v1/policies/search","title":"Search Policies","href":"/api-reference/user-app/abdm-connect/nhcx/search-policies"},{"openapi":"post /abdm/nhcx/v1/coverage/discovery","title":"Discover Policy","href":"/api-reference/user-app/abdm-connect/nhcx/discover-policy"},{"openapi":"get /abdm/nhcx/v1/coverage/discovery/status","title":"Policy Discovery Status","href":"/api-reference/user-app/abdm-connect/nhcx/discovery-status"},{"openapi":"post /abdm/nhcx/v1/policies/{policyId}/eligibility","title":"Check Eligibility","href":"/api-reference/user-app/abdm-connect/nhcx/check-eligibility"},{"openapi":"post /abdm/nhcx/v1/policies/{policyId}/plan/refresh","title":"Refresh Plan","href":"/api-reference/user-app/abdm-connect/nhcx/refresh-plan"}]},{"group":"Procedure Catalogue","icon":"book-medical","pages":[{"openapi":"get /abdm/nhcx/v1/policies/{policyId}/specialities","title":"List Specialities","href":"/api-reference/user-app/abdm-connect/nhcx/list-specialities"},{"openapi":"get /abdm/nhcx/v1/policies/{policyId}/specialities/{specialityCode}/procedures","title":"List Procedures","href":"/api-reference/user-app/abdm-connect/nhcx/list-procedures"},{"openapi":"get /abdm/nhcx/v1/policies/{policyId}/procedures/{procedureCode}","title":"Get Procedure","href":"/api-reference/user-app/abdm-connect/nhcx/get-procedure"}]},{"group":"Claims","icon":"folder-open","pages":[{"openapi":"post /abdm/nhcx/v1/claims","title":"Create Claim","href":"/api-reference/user-app/abdm-connect/nhcx/create-claim"},{"openapi":"get /abdm/nhcx/v1/claims","title":"List Claims","href":"/api-reference/user-app/abdm-connect/nhcx/list-claims"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}","title":"Get Claim","href":"/api-reference/user-app/abdm-connect/nhcx/get-claim"},{"openapi":"put /abdm/nhcx/v1/claims/{claimId}/draft","title":"Save Draft","href":"/api-reference/user-app/abdm-connect/nhcx/save-draft"},{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/archive","title":"Archive Claim","href":"/api-reference/user-app/abdm-connect/nhcx/archive-claim"}]},{"group":"Pre-auth","icon":"file-shield","pages":[{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/preauth","title":"Submit Pre-auth","href":"/api-reference/user-app/abdm-connect/nhcx/submit-preauth"},{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/preauth/cancel","title":"Cancel Pre-auth","href":"/api-reference/user-app/abdm-connect/nhcx/cancel-preauth"},{"openapi":"post /abdm/nhcx/v1/preauth/preview","title":"Preview Pre-auth Bundle","href":"/api-reference/user-app/abdm-connect/nhcx/preview-preauth"}]},{"group":"Claim Submission","icon":"file-invoice","pages":[{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/claim","title":"Submit Claim","href":"/api-reference/user-app/abdm-connect/nhcx/submit-claim"},{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/claim/preview","title":"Preview Claim Bundle","href":"/api-reference/user-app/abdm-connect/nhcx/preview-claim"},{"openapi":"post /abdm/nhcx/v1/claim/preview","title":"Preview Claim Bundle (Full Request)","href":"/api-reference/user-app/abdm-connect/nhcx/preview-claim-full"},{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/claim/reprocess","title":"Reprocess Claim","href":"/api-reference/user-app/abdm-connect/nhcx/reprocess-claim"}]},{"group":"Biometric Auth","icon":"fingerprint","pages":[{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/biometric-auth/init","title":"Init Biometric Auth","href":"/api-reference/user-app/abdm-connect/nhcx/biometric-init"},{"openapi":"post /abdm/nhcx/v1/claims/{claimId}/biometric-auth/verify","title":"Verify Biometric Auth","href":"/api-reference/user-app/abdm-connect/nhcx/biometric-verify"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/biometric-auth/consent","title":"Get Biometric Consent","href":"/api-reference/user-app/abdm-connect/nhcx/biometric-consent"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/biometric-auth/sessions","title":"List Biometric Sessions","href":"/api-reference/user-app/abdm-connect/nhcx/biometric-sessions"}]},{"group":"Tracking","icon":"list-check","pages":[{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/requests","title":"Get Claim Requests","href":"/api-reference/user-app/abdm-connect/nhcx/claim-requests"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}","title":"Get Claim Request","href":"/api-reference/user-app/abdm-connect/nhcx/claim-request"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/requests/{correlationId}/documents/{docId}","title":"Get Claim Request Document","href":"/api-reference/user-app/abdm-connect/nhcx/claim-request-document"},{"openapi":"get /abdm/nhcx/v1/claims/{claimId}/payments","title":"Get Claim Payments","href":"/api-reference/user-app/abdm-connect/nhcx/claim-payments"}]},{"group":"Records Adapter","icon":"plug","pages":[{"openapi":"post /abdm/nhcx/v1/records/adapters","title":"Register Records Adapter","href":"/api-reference/user-app/abdm-connect/nhcx/register-adapter"},{"openapi":"get /abdm/nhcx/v1/records/adapters","title":"Get Records Adapter","href":"/api-reference/user-app/abdm-connect/nhcx/get-adapter"},{"openapi":"get /abdm/nhcx/v1/records/admission/{admissionId}","title":"Get Admission Visits","href":"/api-reference/user-app/abdm-connect/nhcx/admission-visits"},{"openapi":"get /abdm/nhcx/v1/records/visits/{visitId}","title":"Get Visit FHIR","href":"/api-reference/user-app/abdm-connect/nhcx/visit-fhir"}]}]}]},{"group":"Datasets","icon":"database","pages":[{"title":"Overview","href":"/api-reference/datasets/overview"},{"group":"Dataset types","expanded":true,"pages":[{"title":"Medications","href":"/api-reference/datasets/medications"},{"title":"Lab investigations","href":"/api-reference/datasets/lab-investigations"},{"title":"Lab results","href":"/api-reference/datasets/lab-results"},{"title":"Lab panels","href":"/api-reference/datasets/lab-panels"},{"title":"Symptoms","href":"/api-reference/datasets/symptoms"},{"title":"Diagnoses","href":"/api-reference/datasets/diagnoses"}]},{"group":"Records","pages":[{"openapi":"post /admin/datasets/v1/","title":"Create or update records","href":"/api-reference/datasets/write"},{"openapi":"get /admin/datasets/v1/","title":"List dataset records","href":"/api-reference/datasets/list"},{"openapi":"get /admin/datasets/v1/{entity_id}/","title":"Get a record","href":"/api-reference/datasets/get"},{"openapi":"get /admin/datasets/v1/export.csv","title":"Export the catalog as CSV","href":"/api-reference/datasets/export"},{"openapi":"get /admin/datasets/v1/batches/","title":"List CSV import batches","href":"/api-reference/datasets/batches"},{"openapi":"post /admin/datasets/v1/delete/","title":"Deactivate records","href":"/api-reference/datasets/delete"},{"openapi":"post /admin/datasets/v1/delete-all/","title":"Delete the whole catalog","href":"/api-reference/datasets/delete-all"}]},{"group":"Partner search","pages":[{"openapi":"get /admin/datasets/v1/search-status/","title":"Get partner search status","href":"/api-reference/datasets/search-status-get"},{"openapi":"post /admin/datasets/v1/search-status/","title":"Turn partner search on or off","href":"/api-reference/datasets/search-status-set"}]},{"group":"Reference","pages":[{"title":"Accepted drug forms","href":"/api-reference/datasets/forms"}]}]},{"group":"Doctor Tool","pages":[{"group":"Actors","icon":"user","pages":[{"title":null,"href":"/api-reference/doc-tool/Actors/actors"}]},{"group":"Instructions","icon":"star","pages":[{"title":null,"href":"/api-reference/doc-tool/Instructions/before-you-begin"}]},{"group":"Patient Directory APIs","icon":"hospital-user","pages":[{"group":"Patient Registration APIs (Deprecated)","pages":[{"title":null,"href":"/api-reference/doc-tool/patient-registration-api/getting-started"},{"openapi":"post /dr/v1/patient","title":"Add Patient to Directory","href":"/api-reference/doc-tool/patient-registration-api/add-patient-to-directory"},{"openapi":"get /dr/v1/business/patients/search","title":"Search Patient profiles by mobile number","href":"/api-reference/doc-tool/patient-registration-api/search-patient-by-mobile"},{"openapi":"get /dr/v1/patient/{patient_id}","title":"Get patient details by profile id","href":"/api-reference/doc-tool/patient-registration-api/get-patient-details-by-id"},{"openapi":"patch /dr/v1/patient/{patient_id}","title":"Update Patient Details","href":"/api-reference/doc-tool/patient-registration-api/update-patient-details-api"}]},{"group":"Patient Directory APIs","pages":[{"title":null,"href":"/api-reference/doc-tool/patient-directory-apis/getting-started"},{"openapi":"post /profiles/v1/patient/","title":"Create a patient profile","href":"/api-reference/doc-tool/patient-directory-apis/add-patient"},{"openapi":"get /profiles/v1/patient/search","title":"Search patient profiles","href":"/api-reference/doc-tool/patient-directory-apis/search-patient"},{"openapi":"get /profiles/v1/patient/{oid}","title":"Retrieve patient profile","href":"/api-reference/doc-tool/patient-directory-apis/retrieve-patient-details"},{"openapi":"patch /profiles/v1/patient/{oid}","title":"Update patient profile details","href":"/api-reference/doc-tool/patient-directory-apis/update-patient-details"},{"openapi":"delete /profiles/v1/patient/{oid}","title":"Archive or permanently delete patient profile","href":"/api-reference/doc-tool/patient-directory-apis/delete-patient"},{"openapi":"get /profiles/v1/patient/minified/","title":"List patient profiles","href":"/api-reference/doc-tool/patient-directory-apis/patients-list-minified"},{"openapi":"get /profiles/v1/patient/by-mobile/","title":"Retrieve patient profiles by mobile number","href":"/api-reference/doc-tool/patient-directory-apis/retrieve-patients-by-mobile"},{"openapi":"get /profiles/v1/patient/{username}/username/?flatten=true","title":"Retrieve patient profile by username","href":"/api-reference/doc-tool/patient-directory-apis/retrieve-patient-by-username"}]},{"group":"EMR User APIs","pages":[{"openapi":"get /profiles/v1/emr-user/{oid}","title":"Retrieve EMR user profile","href":"/api-reference/doc-tool/patient-directory-apis/retrieve-emr-user"},{"openapi":"patch /profiles/v1/emr-user/{oid}","title":"Update EMR user profile","href":"/api-reference/doc-tool/patient-directory-apis/update-emr-user"}]},{"group":"SDKs","pages":[{"title":"Trinity Profiles SDK (TypeScript)","href":"/api-reference/doc-tool/patient-directory-sdks/patient-directory-ts-sdk"}]}]},{"group":"Doctor and clinic API","icon":"stethoscope","pages":[{"title":null,"href":"/api-reference/doc-tool/doctor-and-clinic-api/getting-started"},{"openapi":"get /dr/v1/business/entities","title":"Get Clinic and Doctor details","description":"\n### Overview\nThe Get Clinic and Doctor Details API provides a comprehensive list of clinics and doctors associated with those clinics for a business. This API is designed to retrieve detailed information about clinics, the doctors working at each clinic, and the overarching business entity.\n### Endpoint\n**URL:** `{{HOST}}/dr/v1/business/entities`\n\n**Method:** GET\n### Request Parameters\nThis endpoint does not require any parameters. The auth header contains business-id information which will be used to fetch the details.\n### Response Parameters\n| Parameter | Type | Description |\n| --- | --- | --- |\n| status | integer | HTTP status code of the response |\n| data | object | Response data object |\n| data.clinics | array | List of clinic objects |\n| data.clinics[].clinic_id | string | Unique identifier of the clinic |\n| data.clinics[].name | string | Name of the clinic |\n| data.clinics[].doctors | array | List of doctor IDs associated with the clinic |\n| data.doctors | array | List of doctor objects |\n| data.doctors[].name | string | Name of the doctor |\n| data.doctors[].doctor_id | string | Unique identifier of the doctor |\n| data.business | object | Details of the business entity |\n| data.business.business_id | string | Unique identifier of the business |\n| data.business.name | string | Name of the business |","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-clinic-and-doctor-details"},{"openapi":"get /dr/v1/doctor/{doctor_id}","title":"Get Doctor profile","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-doctor-profile"},{"openapi":"get /dr/v1/business/clinic/{clinic_id}","title":"Get Clinic details","description":"### Overview\nThis API endpoint retrieves detailed information about a specific clinic using its unique identifier.\n### Endpoint\n**URL:** `{{HOST}}/dr/v1/business/clinic/{{clinic_id}}`\n**Method:** GET\n### Request Parameters\n| Parameter | Type | Description | Required |\n| --- | --- | --- | --- |\n| clinic_id | string | Unique identifier for the clinic | Yes |\n### Response Parameters\n| Parameter | Type | Description |\n| --- | --- | --- |\n| success | boolean | Indicates if the request was successful |\n| data | object | Response data object |\n| data.clinic | object | Clinic details |\n| data.clinic.clinic_id | string | Unique identifier of the clinic |\n| data.clinic.name | string | Name of the clinic |\n| data.clinic.address | object | Address details of the clinic |\n| data.clinic.address.city | string | City of the clinic |\n| data.clinic.address.country | string | Country of the clinic |\n| data.clinic.address.lat | string | Latitude of the clinic |\n| data.clinic.address.line1 | string | Address line 1 |\n| data.clinic.address.lon | string | Longitude of the clinic |\n| data.clinic.address.pincode | string | Pincode of the clinic |\n| data.clinic.address.state | string | State of the clinic |","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-clinic-details"},{"openapi":"get /dr/v1/doctor/service/{doctor_id}","title":"Get Doctor services","href":"/api-reference/doc-tool/doctor-and-clinic-api/get-doc-service"}]},{"group":"Config management APIs","icon":"user-cog","pages":[{"group":"User APIs","pages":[{"openapi":"get /cdr/v1/hipusers/","title":"Get All HIP Users of a Business","href":"/api-reference/doc-tool/user-apis/get-all-users"},{"openapi":"get /cdr/v1/hipusers/{hip_user_id}","title":"Get HIP User Details by ID","href":"/api-reference/doc-tool/user-apis/get-user-by-id"}]},{"group":"Workspace APIs","pages":[{"openapi":"get /cdr/v1/get_business_info/","title":"Get Workspace Information","href":"/api-reference/doc-tool/business-api/get-business-info"}]},{"group":"Onboarding APIs","pages":[{"group":"Doctor","pages":[{"openapi":"post /cdr/v1/doctor/","title":"Create Doctor Profile","href":"/api-reference/doc-tool/onboarding-apis/onboard-doctor"},{"openapi":"get /cdr/v1/doctor/","title":"List Doctors","href":"/api-reference/doc-tool/onboarding-apis/list-doctors"},{"openapi":"get /cdr/v1/doctor/{doc_id}/","title":"Get Doctor by ID","href":"/api-reference/doc-tool/onboarding-apis/get-doctor"},{"openapi":"patch /cdr/v1/doctor/{doc_id}/","title":"Update Doctor","href":"/api-reference/doc-tool/onboarding-apis/update-doctor"},{"openapi":"delete /cdr/v1/doctor/{doc_id}/","title":"Delete Doctor","href":"/api-reference/doc-tool/onboarding-apis/delete-doctor"}]},{"group":"Clinic","pages":[{"openapi":"post /cdr/v1/clinic/","title":"Create Clinic","href":"/api-reference/doc-tool/onboarding-apis/onboard-clinic"},{"openapi":"get /cdr/v1/clinic/","title":"List Clinics","href":"/api-reference/doc-tool/onboarding-apis/list-clinics"},{"openapi":"get /cdr/v1/clinic/{clinic_id}/","title":"Get Clinic by ID","href":"/api-reference/doc-tool/onboarding-apis/get-clinic"},{"openapi":"patch /cdr/v1/clinic/{clinic_id}/","title":"Update Clinic","href":"/api-reference/doc-tool/onboarding-apis/update-clinic"},{"openapi":"delete /cdr/v1/clinic/{clinic_id}/","title":"Delete Clinic","href":"/api-reference/doc-tool/onboarding-apis/delete-clinic"}]},{"group":"Eka User","pages":[{"openapi":"post /cdr/v1/ekauser/","title":"Create Eka User","href":"/api-reference/doc-tool/onboarding-apis/onboard-ekauser"},{"openapi":"get /cdr/v1/ekauser/","title":"List Eka Users","href":"/api-reference/doc-tool/onboarding-apis/list-ekausers"},{"openapi":"get /cdr/v1/ekauser/{user_id}/","title":"Get Eka User by ID","href":"/api-reference/doc-tool/onboarding-apis/get-ekauser"},{"openapi":"patch /cdr/v1/ekauser/{user_id}/","title":"Update Eka User","href":"/api-reference/doc-tool/onboarding-apis/update-ekauser"},{"openapi":"delete /cdr/v1/ekauser/{user_id}/","title":"Delete Eka User","href":"/api-reference/doc-tool/onboarding-apis/delete-ekauser"}]}]}]},{"group":"Appointment API","icon":"calendar-check","pages":[{"title":null,"href":"/api-reference/doc-tool/appointment-api/getting-started"},{"openapi":"get /dr/v1/doctor/{doctor_id}/clinic/{clinic_id}/appointment/slot","title":"Get Appointment Slots","href":"/api-reference/doc-tool/appointment-api/get-appointment-slots"},{"openapi":"post /dr/v1/appointment","title":"Book Appointment Slot","href":"/api-reference/doc-tool/appointment-api/book-appointment-slot"},{"openapi":"get /dr/v1/appointment/{appointment_id}","title":"Get Appointment Details","href":"/api-reference/doc-tool/appointment-api/get-appointment-details"},{"openapi":"patch /dr/v1/appointment/{appointment_id}","title":"Update Appointment","href":"/api-reference/doc-tool/appointment-api/update-appointment"},{"openapi":"patch /dr/v2/appointment/{appointment_id}","title":"Update Appointment V2","href":"/api-reference/doc-tool/appointment-api/update-appointment-v2"},{"openapi":"post /dr/v1/appointment/{appointment_id}/parked","title":"Parked Appointment","href":"/api-reference/doc-tool/appointment-api/parked-appointment"},{"openapi":"post /dr/v1/appointment/{appointment_id}/complete","title":"Complete Appointment","href":"/api-reference/doc-tool/appointment-api/complete-appointment"},{"openapi":"put /dr/v1/appointment/{appointment_id}/cancel","title":"Cancel Appointment","href":"/api-reference/doc-tool/appointment-api/cancel-appointment"},{"openapi":"get /dr/v1/appointment","title":"Get Appointments","href":"/api-reference/doc-tool/appointment-api/get-appointments-by-date"},{"openapi":"post /dr/v1/appointment/{appointment_id}/change-status","title":"No-Show Appointment","href":"/api-reference/doc-tool/appointment-api/change-status"},{"openapi":"put /dr/v1/appointment/{appointment_id}/follow-up/confirm","title":"Confirm Follow-Up Appointment","href":"/api-reference/doc-tool/appointment-api/confirm-follow-up-appointment"},{"openapi":"patch /appointments/v1/{appointment_id}/reschedule","title":"Reschedule Appointment","href":"/api-reference/doc-tool/appointment-api/reschedule-appointment"},{"group":"Schedule","pages":[{"openapi":"post /schedule","title":"Create Schedule","href":"/api-reference/doc-tool/appointment-api/create-schedule"},{"openapi":"patch /schedule/{scheduleId}","title":"Update Schedule","href":"/api-reference/doc-tool/appointment-api/update-schedule"},{"openapi":"delete /schedule/{scheduleId}","title":"Delete Schedule","href":"/api-reference/doc-tool/appointment-api/delete-schedule"},{"openapi":"get /schedule/resolved","title":"Get Resolved Schedule","href":"/api-reference/doc-tool/appointment-api/get-business-resolved-schedule"}]},{"group":"Service Configuration","pages":[{"openapi":"get /schedule/service-conf/{entityId}","title":"Get Service Conf List","href":"/api-reference/doc-tool/appointment-api/get-service-conf-list"},{"openapi":"get /schedule/service-conf/{entityId}/{conf_id}","title":"Get Service Conf Details","href":"/api-reference/doc-tool/appointment-api/get-service-conf-details"}]}]},{"group":"Payments API","icon":"money-bill-wave","pages":[{"openapi":"get /dr/v1/payment/transaction_status/{transaction_id}","title":"Get Transaction Status","href":"/api-reference/doc-tool/payment-api/get-transaction-status"}]},{"group":"Prescription API","icon":"file-prescription","pages":[{"openapi":"get /dr/v1/prescription/{prescription_id}","title":"Get Prescription details","href":"/api-reference/doc-tool/prescription-api/get-prescription-details"}]},{"group":"IPD API","icon":"bed-pulse","pages":[{"openapi":"get /ipd/v1/service/ipd","title":"Get IPD Setup Data","href":"/api-reference/doc-tool/ipd-api/setup/get-ipd-setup-data"},{"group":"Categories","pages":[{"openapi":"post /ipd/v1/service/categories","title":"Create Category","href":"/api-reference/doc-tool/ipd-api/categories/create-category"},{"openapi":"post /ipd/v1/service/categories/{category_id}","title":"Update Category","href":"/api-reference/doc-tool/ipd-api/categories/update-category"},{"openapi":"delete /ipd/v1/service/categories/{category_id}","title":"Delete Category","href":"/api-reference/doc-tool/ipd-api/categories/delete-category"}]},{"group":"Rooms","pages":[{"openapi":"post /ipd/v1/service/rooms","title":"Create Room","href":"/api-reference/doc-tool/ipd-api/rooms/create-room"},{"openapi":"post /ipd/v1/service/rooms/{room_id}","title":"Update Room","href":"/api-reference/doc-tool/ipd-api/rooms/update-room"},{"openapi":"delete /ipd/v1/service/rooms/{room_id}","title":"Delete Room","href":"/api-reference/doc-tool/ipd-api/rooms/delete-room"}]},{"group":"Beds","pages":[{"openapi":"post /ipd/v1/service/beds","title":"Create Bed","href":"/api-reference/doc-tool/ipd-api/beds/create-bed"},{"openapi":"post /ipd/v1/service/beds/{bed_id}","title":"Update Bed","href":"/api-reference/doc-tool/ipd-api/beds/update-bed"},{"openapi":"delete /ipd/v1/service/beds/{bed_id}","title":"Delete Bed","href":"/api-reference/doc-tool/ipd-api/beds/delete-bed"},{"openapi":"post /ipd/v1/service/bed-clinic-relations","title":"Link Bed to Clinic","href":"/api-reference/doc-tool/ipd-api/beds/link-bed-to-clinic"},{"openapi":"delete /ipd/v1/service/bed-clinic-relations","title":"Unlink Bed from Clinic","href":"/api-reference/doc-tool/ipd-api/beds/unlink-bed-from-clinic"}]},{"group":"Rate Plans","pages":[{"openapi":"post /ipd/v1/service/rateplans","title":"Create Rate Plan","href":"/api-reference/doc-tool/ipd-api/rate-plans/create-rate-plan"},{"openapi":"post /ipd/v1/service/rateplans/{rate_plan_id}","title":"Update Rate Plan","href":"/api-reference/doc-tool/ipd-api/rate-plans/update-rate-plan"},{"openapi":"delete /ipd/v1/service/rateplans/{rate_plan_id}","title":"Delete Rate Plan","href":"/api-reference/doc-tool/ipd-api/rate-plans/delete-rate-plan"},{"openapi":"post /ipd/v1/service/rateplans/inclusions","title":"Create Rate Plan Inclusion","href":"/api-reference/doc-tool/ipd-api/rate-plans/create-rate-plan-inclusion"},{"openapi":"post /ipd/v1/service/rateplans/inclusions/{inclusion_id}","title":"Update Rate Plan Inclusion","href":"/api-reference/doc-tool/ipd-api/rate-plans/update-rate-plan-inclusion"},{"openapi":"delete /ipd/v1/service/rateplans/inclusions/{inclusion_id}","title":"Delete Rate Plan Inclusion","href":"/api-reference/doc-tool/ipd-api/rate-plans/delete-rate-plan-inclusion"},{"openapi":"post /ipd/v1/service/rate-plan-clinic-relations","title":"Link Rate Plan to Clinic","href":"/api-reference/doc-tool/ipd-api/rate-plans/link-rate-plan-to-clinic"},{"openapi":"delete /ipd/v1/service/rate-plan-clinic-relations","title":"Unlink Rate Plan from Clinic","href":"/api-reference/doc-tool/ipd-api/rate-plans/unlink-rate-plan-from-clinic"}]},{"group":"Nursing Notes","pages":[{"openapi":"post /ipd/v1/service/nursing-notes","title":"Create Nursing Note","href":"/api-reference/doc-tool/ipd-api/nursing-notes/create-nursing-note"},{"openapi":"get /ipd/v1/service/nursing-notes/admission/{admission_id}","title":"List Nursing Notes for Admission","href":"/api-reference/doc-tool/ipd-api/nursing-notes/list-nursing-notes"},{"openapi":"patch /ipd/v1/service/nursing-notes/{note_id}","title":"Update Nursing Note","href":"/api-reference/doc-tool/ipd-api/nursing-notes/update-nursing-note"},{"openapi":"post /ipd/v1/service/nursing-notes-templates","title":"Create Nursing Note Template","href":"/api-reference/doc-tool/ipd-api/nursing-notes/create-nursing-note-template"},{"openapi":"get /ipd/v1/service/nursing-notes-templates","title":"List Nursing Note Templates","href":"/api-reference/doc-tool/ipd-api/nursing-notes/list-nursing-note-templates"},{"openapi":"patch /ipd/v1/service/nursing-notes-templates/{template_id}","title":"Update Nursing Note Template","href":"/api-reference/doc-tool/ipd-api/nursing-notes/update-nursing-note-template"}]},{"group":"Discharge Summaries","pages":[{"openapi":"post /ipd/v1/service/discharge-summaries","title":"Create Discharge Summary","href":"/api-reference/doc-tool/ipd-api/discharge-summaries/create-discharge-summary"},{"openapi":"get /ipd/v1/service/discharge-summaries/admission/{admission_id}","title":"List Discharge Summaries for Admission","href":"/api-reference/doc-tool/ipd-api/discharge-summaries/list-discharge-summaries"},{"openapi":"patch /ipd/v1/service/discharge-summaries/{summary_id}","title":"Update Discharge Summary","href":"/api-reference/doc-tool/ipd-api/discharge-summaries/update-discharge-summary"}]},{"group":"Orders","pages":[{"openapi":"post /ipd/v1/service/orders","title":"Create Order","href":"/api-reference/doc-tool/ipd-api/orders/create-order"},{"openapi":"get /ipd/v1/service/orders","title":"List Orders","href":"/api-reference/doc-tool/ipd-api/orders/list-orders"},{"openapi":"get /ipd/v1/service/orders/{order_id}","title":"Get Order","href":"/api-reference/doc-tool/ipd-api/orders/get-order"},{"openapi":"patch /ipd/v1/service/orders/{order_id}","title":"Mark Order Collected","href":"/api-reference/doc-tool/ipd-api/orders/mark-order-collected"},{"openapi":"patch /ipd/v1/service/orders/{order_id}/status","title":"Update Order Status","href":"/api-reference/doc-tool/ipd-api/orders/update-order-status"}]},{"group":"Dawakhana","pages":[{"openapi":"get /ipd/v1/service/dawakhana/orders","title":"List Dawakhana Orders","href":"/api-reference/doc-tool/ipd-api/dawakhana/list-dawakhana-orders"},{"openapi":"get /ipd/v1/service/dawakhana/orders/count","title":"Count Dawakhana Orders","href":"/api-reference/doc-tool/ipd-api/dawakhana/count-dawakhana-orders"},{"openapi":"get /ipd/v1/service/dawakhana/orders/{order_id}","title":"Get Dawakhana Order","href":"/api-reference/doc-tool/ipd-api/dawakhana/get-dawakhana-order"},{"openapi":"post /ipd/v1/service/dawakhana/orders/{order_id}/dispatch","title":"Dispatch Dawakhana Order","href":"/api-reference/doc-tool/ipd-api/dawakhana/dispatch-dawakhana-order"},{"openapi":"post /ipd/v1/service/dawakhana/orders/{order_id}/cancel","title":"Cancel Dawakhana Order","href":"/api-reference/doc-tool/ipd-api/dawakhana/cancel-dawakhana-order"},{"openapi":"post /ipd/v1/service/dawakhana/orders/{order_id}/return","title":"Return Dawakhana Order","href":"/api-reference/doc-tool/ipd-api/dawakhana/return-dawakhana-order"},{"openapi":"post /ipd/v1/service/dawakhana/orders/returns","title":"Create Dawakhana Standalone Return","href":"/api-reference/doc-tool/ipd-api/dawakhana/create-dawakhana-return"},{"openapi":"get /ipd/v1/service/dawakhana/orders/clearances","title":"List Dawakhana Pending Clearances","href":"/api-reference/doc-tool/ipd-api/dawakhana/list-dawakhana-clearances"},{"openapi":"get /ipd/v1/service/dawakhana/config","title":"Get Dawakhana Config","href":"/api-reference/doc-tool/ipd-api/dawakhana/get-dawakhana-config"},{"openapi":"put /ipd/v1/service/dawakhana/config","title":"Update Dawakhana Config","href":"/api-reference/doc-tool/ipd-api/dawakhana/update-dawakhana-config"}]},{"group":"Pharmacies","pages":[{"openapi":"get /ipd/v1/service/pharmacies","title":"List Pharmacies","href":"/api-reference/doc-tool/ipd-api/pharmacies/list-pharmacies"},{"openapi":"post /ipd/v1/service/pharmacies/inventory-status","title":"Get Inventory Status","href":"/api-reference/doc-tool/ipd-api/pharmacies/get-inventory-status"},{"openapi":"post /ipd/v1/service/pharmacies/clearance-clear","title":"Mark Pharmacy Clearance Cleared","href":"/api-reference/doc-tool/ipd-api/pharmacies/mark-pharmacy-clearance-cleared"},{"openapi":"get /ipd/v1/service/pharmacies/billing-config/evital","title":"Get eVital Billing Config","href":"/api-reference/doc-tool/ipd-api/pharmacies/get-evital-billing-config"},{"openapi":"put /ipd/v1/service/pharmacies/billing-config","title":"Update Pharmacy Billing Config","href":"/api-reference/doc-tool/ipd-api/pharmacies/update-pharmacy-billing-config"}]},{"group":"Admissions","pages":[{"openapi":"get /ipd/v1/service/admissions/{admission_id}","title":"Get Admission","href":"/api-reference/doc-tool/ipd-api/admissions/get-admission"},{"openapi":"get /ipd/v1/service/admissions/{admission_id}/visits","title":"Get Admission with Visits","href":"/api-reference/doc-tool/ipd-api/admissions/get-admission-visits"},{"openapi":"get /ipd/v1/service/admissions/{admission_id}/estimate","title":"Get Admission Estimate","href":"/api-reference/doc-tool/ipd-api/admissions/get-admission-estimate"},{"openapi":"post /ipd/v1/service/admissions/{admission_id}/fs-estimates","title":"Save Admission Estimates","href":"/api-reference/doc-tool/ipd-api/admissions/save-admission-estimates"},{"openapi":"get /ipd/v1/service/admissions/advices/{patient_id}","title":"List Admission Advices for Patient","href":"/api-reference/doc-tool/ipd-api/admissions/list-admission-advices"},{"openapi":"post /ipd/v1/service/admissions/generate-ipid","title":"Generate IPID","href":"/api-reference/doc-tool/ipd-api/admissions/generate-ipid"},{"openapi":"get /ipd/v1/service/admissions/generate-ipid","title":"Generate IPID (GET)","href":"/api-reference/doc-tool/ipd-api/admissions/generate-ipid-get"},{"openapi":"get /ipd/v1/service/admissions/ipid-config","title":"Get IPID Config","href":"/api-reference/doc-tool/ipd-api/admissions/get-ipid-config"},{"openapi":"post /ipd/v1/service/admissions/ipid-config","title":"Update IPID Config","href":"/api-reference/doc-tool/ipd-api/admissions/update-ipid-config"},{"openapi":"get /ipd/v1/service/admissions/generate-discharge-summary/{admission_id}","title":"Generate Discharge Summary","href":"/api-reference/doc-tool/ipd-api/admissions/generate-discharge-summary"},{"openapi":"get /ipd/v1/service/admissions/discharge-release-rules","title":"Get Discharge Release Rules","href":"/api-reference/doc-tool/ipd-api/admissions/get-discharge-release-rules"},{"openapi":"put /ipd/v1/service/admissions/discharge-release-rules","title":"Update Discharge Release Rules","href":"/api-reference/doc-tool/ipd-api/admissions/update-discharge-release-rules"}]},{"group":"Admission Lifecycle","pages":[{"group":"Admissions","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions","title":"List IPD admissions","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/list-ipd-admissions"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions","title":"Create an IPD admission","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/create-an-ipd-admission"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}","title":"Get an IPD admission by id","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/get-an-ipd-admission-by-id"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json patch /ipd/v1/sdk/admissions/{admission_id}","title":"Update an IPD admission","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/update-an-ipd-admission"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/can-admit","title":"Check whether a patient can be admitted","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/check-whether-a-patient-can-be-admitted"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/ipid-in-use","title":"Check whether an IPD case number is in use","href":"/api-reference/doc-tool/ipd-api/sdk/admissions/check-whether-an-ipd-case-number-is-in-use"}]},{"group":"Discharge \u0026 Clearances","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/discharge/initiate","title":"Initiate a discharge","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/initiate-a-discharge"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/clearances","title":"List an admission's discharge clearances","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/list-an-admission-s-discharge-clearances"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/clearances/{type}/complete","title":"Complete a discharge clearance","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/complete-a-discharge-clearance"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/clearances/{type}/reopen","title":"Reopen a discharge clearance","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/reopen-a-discharge-clearance"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/pharmacy-clearance-notify","title":"Get the pharmacy discharge-notification state","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/get-the-pharmacy-discharge-notification-state"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/pharmacy-clearance-notify","title":"Notify the admission's pharmacies of a discharge","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/notify-the-admission-s-pharmacies-of-a-discharge"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/pharmacy-clearance-notify/retry","title":"Resend to the pharmacies that failed","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/resend-to-the-pharmacies-that-failed"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/pharmacy-clearance-notify/cancel","title":"Withdraw a discharge notification","href":"/api-reference/doc-tool/ipd-api/sdk/discharge-clearances/withdraw-a-discharge-notification"}]},{"group":"Events","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events","title":"List an admission's events","href":"/api-reference/doc-tool/ipd-api/sdk/events/list-an-admission-s-events"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/events","title":"Record an admission event","href":"/api-reference/doc-tool/ipd-api/sdk/events/record-an-admission-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json delete /ipd/v1/sdk/admissions/{admission_id}/events/{event_id}","title":"Delete an admission event","href":"/api-reference/doc-tool/ipd-api/sdk/events/delete-an-admission-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/latest","title":"Get the latest event of a kind","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-latest-event-of-a-kind"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/discharge-initiation","title":"Get the discharge initiation event","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-discharge-initiation-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/discharge-disposition","title":"Get the discharge disposition event","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-discharge-disposition-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/discharge-clearance","title":"Get the discharge clearance-exit event","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-discharge-clearance-exit-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/discharge-summary","title":"Get the discharge summary submitted event","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-discharge-summary-submitted-event"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/events/latest-clearance-meta","title":"Get the latest completion per clearance","href":"/api-reference/doc-tool/ipd-api/sdk/events/get-the-latest-completion-per-clearance"}]},{"group":"Billing – Account","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/billing/price-lists","title":"List billing price lists","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/list-billing-price-lists"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/account","title":"Open the admission's billing account","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/open-the-admission-s-billing-account"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json put /ipd/v1/sdk/admissions/{admission_id}/billing/price-list","title":"Change the account's price list","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/change-the-account-s-price-list"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/summary","title":"Get the billing summary","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/get-the-billing-summary"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/state","title":"Get the full billing state","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/get-the-full-billing-state"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/settle","title":"Settle the billing account","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/settle-the-billing-account"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/close","title":"Close the billing account","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/close-the-billing-account"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/reopen","title":"Reopen the billing account","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/reopen-the-billing-account"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/suspend","title":"Put the billing account on hold","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/put-the-billing-account-on-hold"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/resume","title":"Lift the billing account's hold","href":"/api-reference/doc-tool/ipd-api/sdk/billing-account/lift-the-billing-account-s-hold"}]},{"group":"Billing – Charges","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/charges","title":"List charges","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/list-charges"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/charges","title":"Add charges","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/add-charges"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json patch /ipd/v1/sdk/admissions/{admission_id}/billing/charges/{charge_id}","title":"Update a charge","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/update-a-charge"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/charges/{charge_id}/void","title":"Void a charge","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/void-a-charge"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/draft/quote","title":"Price draft charges","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/price-draft-charges"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/draft/submit","title":"Save draft charges","href":"/api-reference/doc-tool/ipd-api/sdk/billing-charges/save-draft-charges"}]},{"group":"Billing – Payments","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/payments","title":"List payments","href":"/api-reference/doc-tool/ipd-api/sdk/billing-payments/list-payments"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/payments","title":"Record a payment","href":"/api-reference/doc-tool/ipd-api/sdk/billing-payments/record-a-payment"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/payments/{payment_id}/void","title":"Void a payment","href":"/api-reference/doc-tool/ipd-api/sdk/billing-payments/void-a-payment"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/payments/{payment_id}/allocate","title":"Apply a payment to an invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-payments/apply-a-payment-to-an-invoice"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/invoices/{invoice_id}/pay","title":"Pay an invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-payments/pay-an-invoice"}]},{"group":"Billing – Invoices","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/invoices","title":"List invoices","href":"/api-reference/doc-tool/ipd-api/sdk/billing-invoices/list-invoices"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/invoices","title":"Create an invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-invoices/create-an-invoice"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/invoices/{invoice_id}/void","title":"Void an invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-invoices/void-an-invoice"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/invoices/{invoice_id}/cancel","title":"Cancel an issued invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-invoices/cancel-an-issued-invoice"}]},{"group":"Billing – Deposits","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/deposits","title":"List deposits","href":"/api-reference/doc-tool/ipd-api/sdk/billing-deposits/list-deposits"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/deposits","title":"Collect a deposit","href":"/api-reference/doc-tool/ipd-api/sdk/billing-deposits/collect-a-deposit"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/allocate","title":"Apply a deposit to an invoice","href":"/api-reference/doc-tool/ipd-api/sdk/billing-deposits/apply-a-deposit-to-an-invoice"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/deposits/{deposit_id}/refund","title":"Refund a deposit","href":"/api-reference/doc-tool/ipd-api/sdk/billing-deposits/refund-a-deposit"}]},{"group":"Billing – Room Meters","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters","title":"List room meters","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/list-room-meters"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meter/sync","title":"Sync the room meter","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/sync-the-room-meter"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/sync","title":"Sync room meters","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/sync-room-meters"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/{meter_id}/pause","title":"Pause a room meter","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/pause-a-room-meter"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/{meter_id}/resume","title":"Resume a room meter","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/resume-a-room-meter"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/{meter_id}/slice","title":"Bill part of a room meter","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/bill-part-of-a-room-meter"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/pause","title":"Pause all room meters","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/pause-all-room-meters"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/resume","title":"Resume all room meters","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/resume-all-room-meters"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/stop","title":"Stop the room meter","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/stop-the-room-meter"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json post /ipd/v1/sdk/admissions/{admission_id}/billing/room-meters/stop-and-bill","title":"Stop and bill room meters","href":"/api-reference/doc-tool/ipd-api/sdk/billing-room-meters/stop-and-bill-room-meters"}]},{"group":"Billing – Returns \u0026 Links","pages":[{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/returns","title":"List returns","href":"/api-reference/doc-tool/ipd-api/sdk/billing-returns-links/list-returns"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/adjustment-notes","title":"List credit and debit notes","href":"/api-reference/doc-tool/ipd-api/sdk/billing-returns-links/list-credit-and-debit-notes"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/order-charge-links","title":"List pharmacy order charge links","href":"/api-reference/doc-tool/ipd-api/sdk/billing-returns-links/list-pharmacy-order-charge-links"},{"openapi":"api-reference/doc-tool/ipd-api/ipd-sdk-openapi.json get /ipd/v1/sdk/admissions/{admission_id}/billing/order-return-links","title":"List pharmacy return links","href":"/api-reference/doc-tool/ipd-api/sdk/billing-returns-links/list-pharmacy-return-links"}]}]}]},{"group":"Notify","icon":"bell","pages":[{"openapi":"post /notification/v1/notify","title":"Send Notification","href":"/api-reference/doc-tool/notify/notify"}]},{"group":"Webhooks","icon":"webhook","pages":[{"group":"Appointment Events","icon":"calendar-check","pages":[{"openapi":"post /registered_url_for_add_appointment_events","title":"Create appointment","href":"/api-reference/doc-tool/post_webhooks/add-appointment-webhook"},{"openapi":"post /registered_url_for_update_appointment_events","title":"Update appointment","href":"/api-reference/doc-tool/post_webhooks/update-appointment-webhook"},{"openapi":"post /registered_url_for_assessment_taken_events","title":"Assessment Taken","href":"/api-reference/doc-tool/post_webhooks/assessment-taken-webhook"},{"openapi":"post /registered_url_for_status_change_events","title":"Status changed","href":"/api-reference/doc-tool/post_webhooks/status-change-webhook"},{"openapi":"post /registered_url_for_appointment_tele_dr_joined_webhook_events","title":"Doctor Joined Video Call","href":"/api-reference/doc-tool/post_webhooks/appointment-tele-dr-joined-webhook"},{"openapi":"post /registered_url_for_appointment_reminder_instant_webhook_events","title":"Appointment Reminder (Instant)","href":"/api-reference/doc-tool/post_webhooks/appointment-reminder-instant-webhook"},{"openapi":"post /registered_url_for_appointment_followup_reminder_instant_webhook_events","title":"Follow-up Appointment Reminder (Instant)","href":"/api-reference/doc-tool/post_webhooks/appointment-followup-reminder-instant-webhook"},{"openapi":"post /registered_url_for_vaccination_reminder_webhook_events","title":"Vaccination Reminder","href":"/api-reference/doc-tool/post_webhooks/vaccination-reminder-webhook"}]},{"group":"Prescription","icon":"file-prescription","pages":[{"openapi":"post /registered_url_for_prescription_events","title":"Prescription Created Event","href":"/api-reference/doc-tool/post_webhooks/prescription-webhook"},{"openapi":"post /registered_url_for_prescription_communication_events","title":"Prescription Communication Event","href":"/api-reference/doc-tool/post_webhooks/prescription-communication-webhook"}]},{"group":"Doctor","icon":"stethoscope","pages":[{"openapi":"post /registered_url_for_doctor_events","title":"Doctor Events","href":"/api-reference/doc-tool/post_webhooks/doctor-webhook"},{"openapi":"post /registered_url_for_google_review_events","title":"Google Review Automatic Event","href":"/api-reference/doc-tool/post_webhooks/google-review-webhook"},{"openapi":"post /registered_url_for_google_review_manual_events","title":"Google Review Manual Event","href":"/api-reference/doc-tool/post_webhooks/google-review-manual-webhook"},{"openapi":"post /registered_url_for_consent_form","title":"Consent Form Events","href":"/api-reference/doc-tool/post_webhooks/mcert-webhook"}]},{"group":"Receipt \u0026 Payment Link","icon":"indian-rupee-sign","pages":[{"openapi":"post /registered_url_for_receipt_events","title":"Receipt Events","href":"/api-reference/doc-tool/post_webhooks/receipt-webhook"},{"openapi":"post /registered_url_for_receipt_payment_requested_events","title":"Payment Link Requested","href":"/api-reference/doc-tool/post_webhooks/payment-link-webhook"}]},{"group":"IPD","icon":"bed-pulse","pages":[{"openapi":"post /registered_url_for_ipd_admissions_events","title":"IPD Admission","href":"/api-reference/doc-tool/post_webhooks/ipd-admissions"},{"openapi":"post /registered_url_for_ipd_admissions_events_events","title":"IPD Admission Event","href":"/api-reference/doc-tool/post_webhooks/ipd-admissions-events"},{"openapi":"post /registered_url_for_ipd_admissions_clearances_events","title":"IPD Admission Clearance","href":"/api-reference/doc-tool/post_webhooks/ipd-admissions-clearances"},{"openapi":"post /registered_url_for_ipd_admissions_estimates_events","title":"IPD Admission Estimate","href":"/api-reference/doc-tool/post_webhooks/ipd-admissions-estimates"}]}]},{"group":"IP Allowlisting","icon":"list-check","pages":[{"title":"IP Allowlisting for Clients","href":"/api-reference/doc-tool/ip-allowlisting-for-clients"}]}]},{"group":"Medical Knowledge-bases","icon":"book-open-cover","pages":[{"title":null,"href":"/api-reference/knowledge-base/overview"},{"group":"Protocols","icon":"brain","pages":[{"openapi":"post /eka-mcp/protocols/v1/search","title":"Search Protocols","href":"/api-reference/knowledge-base/protocols/search"},{"openapi":"get /eka-mcp/protocols/v1/publishers/all","title":"Get all Publishers","href":"/api-reference/knowledge-base/protocols/publishers"}]},{"group":"Medications","icon":"house-medical","pages":[{"openapi":"get /eka-mcp/medications/v1/search","title":"Search Medications","href":"/api-reference/knowledge-base/medications/search"},{"openapi":"get /eka-mcp/pharmacology/v1/search","title":"Get Generic (pharmacology) Information","href":"/api-reference/knowledge-base/medications/pharmacology"}]},{"group":"Ontology Linking (Deprecated)","icon":"link","pages":[{"title":"SNOMED Linking (Deprecated)","openapi":"get /eka-mcp/linking/v1/snomed","href":"/api-reference/knowledge-base/linking/snomed"}]}]},{"group":"Medical Records","icon":"book-open-cover","pages":[{"group":"APIs","icon":"network-wired","pages":[{"group":"Add","icon":"upload","pages":[{"title":"Overview","href":"/api-reference/user-app/records/create-overview"},{"openapi":"post /mr/api/v1/docs","title":"Step 1: Upload Record","href":"/api-reference/user-app/records/obtain-authorization"},{"title":"Step 2: Upload Record","href":"/api-reference/user-app/records/upload-records"}]},{"group":"Read","icon":"eye","pages":[{"title":"Overview","href":"/api-reference/user-app/records/read-documents"},{"openapi":"get /mr/api/v1/docs/{id}","title":"Describes a document","href":"/api-reference/user-app/records/describe-record"},{"openapi":"get /mr/api/v1/docs","title":"List Documents","href":"/api-reference/user-app/records/list-records"},{"openapi":"get /health/api/v1/fhir/retrieve","title":"Retrieve health records","href":"/api-reference/user-app/records/retrieve-health-records"},{"openapi":"get /mr/api/v1/docs/refresh","title":"Sends a refresh event to the origin","href":"/api-reference/user-app/records/send-refresh"}]},{"group":"Update","icon":"pencil","pages":[{"title":"Overview","href":"/api-reference/user-app/records/update_overview"},{"openapi":"patch /mr/api/v1/docs/{id}","title":"Update Document","href":"/api-reference/user-app/records/update-document"}]},{"group":"Delete","icon":"trash","pages":[{"title":"Overview","href":"/api-reference/user-app/records/delete_overview"},{"openapi":"delete /mr/api/v1/docs/{id}","title":"Delete a document","href":"/api-reference/user-app/records/delete-document"}]},{"group":"Cases","icon":"folder-open","pages":[{"openapi":"post /mr/api/v1/cases","title":"Create Case","href":"/api-reference/user-app/records/create-case"},{"openapi":"patch /mr/api/v1/cases/{id}","title":"Update Case","href":"/api-reference/user-app/records/update-case"},{"openapi":"get /mr/api/v1/cases","title":"List Cases","href":"/api-reference/user-app/records/list-case"},{"openapi":"delete /mr/api/v1/cases/{id}","title":"Delete Case","href":"/api-reference/user-app/records/delete-case"}]}]},{"group":"SDKs","icon":"box-open","pages":[{"group":"Mobile","icon":"mobile","pages":[{"title":null,"href":"/api-reference/user-app/records/SDKs/iOS-sdk"}]},{"group":"Web","icon":"globe","pages":[{"title":"Get Started","href":"/SDKs/web-sdk/mr-sdk/get-started"},{"title":"Records","href":"/SDKs/web-sdk/mr-sdk/records"},{"title":"Cases","href":"/SDKs/web-sdk/mr-sdk/cases"},{"title":"Offline \u0026 Sync","href":"/SDKs/web-sdk/mr-sdk/offline-and-sync"}]}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":null,"href":"/api-reference/user-app/records/record-refresh-webhook"},{"title":null,"href":"/api-reference/user-app/records/record-uploaded-webhook"}]}]},{"group":"User App","pages":[{"group":"Notifications","icon":"bell","pages":[{"openapi":"post /notification/add-device","title":"Add Device","href":"/api-reference/user-app/notifications/add-device"},{"openapi":"delete /notification/delete-device","title":"Delete Device","href":"/api-reference/user-app/notifications/delete-device"},{"openapi":"post /notification/fcm-creds","title":"Add FCM Credentials","href":"/api-reference/user-app/notifications/fcm-creds"}]},{"group":"Vital","icon":"book-open-cover","pages":[{"openapi":"patch /trackers/api/v1/vitals/{txn_id}","title":"Update Patient Vitals and Link to ABHA","href":"/api-reference/user-app/vitals/vitals"},{"title":null,"href":"/api-reference/user-app/vitals/vital-information-table"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"post /webhook/event","title":null,"href":"/api-reference/user-app/webhook/right-to-access"}]},{"group":"Privacy","icon":"shield-halved","pages":[{"openapi":"post /privacy/v1/user-data","title":"Request User Data","href":"/api-reference/user-app/privacy/right-to-access"}]}]},{"group":"Medical Database","icon":"book-open-cover","pages":[{"group":"Resources","pages":[{"openapi":"get /medical-db/v1/drugs-and-labs","title":"Search Drugs and Laboratory Tests","href":"/api-reference/medical-db/drugs-and-labs"},{"openapi":"get /medical-db/v1/sym-and-diag","title":"Search Symptoms and Diagnoses","href":"/api-reference/medical-db/symptoms-and-diagnosis"}]}]}]},{"tab":"EkaScribe","pages":[{"title":"EkaScribe","href":"/ekascribe/overview"}]},{"tab":"SDKs","hidden":true,"pages":[{"title":"SDKs","href":"/SDKs/android/ekascribe"}]},{"tab":"AI Tools","pages":[{"title":"AI Tools","href":"/ai-tools/agent-kit/introduction"}]},{"tab":"CookBook","pages":[{"title":"CookBook","href":"/cookbook/whats-possible/health-assessment"}]},{"tab":"Spotlight","pages":[{"title":"Spotlight","href":"/eka-medai/spotlight"}]}]},{"anchor":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Get Doctor profile - Eka Developer Platform APIs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}