Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Idempotency-Key
string
required
A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with 409 idempotency_key_conflict, and retrying while the first request is still running with 409 idempotency_key_reused. See Retries and idempotency.
Minimum string length: 1
Path Parameters
clinic_id
string<uuid>
required
appointment_id
string<uuid>
required
Body
application/json
reason
string
notify_patient
boolean
default:true
false only ever DOWNGRADES notification columns — the patient is not emailed about the cancellation, and it never re-enables a row already silenced.
run_automations
boolean
default:false
Response
OK.
data
object
required
Never present here, by name: client_appointment_date/client_start_time/ client_end_time/client_timezone, form_data, custom_color, provider_user_id, time_range, excluded_from_overlap_check, booking_identity_review, provider_busy_minutes, out_of_office_confirmed_at, booking_confirmation_deferred, clinic_id.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClinikEHR API","description":"Reference and guides for the ClinikEHR API — read a clinic's own inventory from your own systems.","colors":{"primary":"#0D9488","light":"#2DD4BF","dark":"#0F766E"},"logo":{"light":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/light.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=1c5da83101c773651a555abca64ef883","dark":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/dark.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=6c05e14b5874038f79df529085e321f8","href":"https://clinikehr.com"},"favicon":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/favicon.png?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=be1f63bf62da11aedb3dfd672a98f8d5","api":{"playground":{"display":"simple"},"examples":{"defaults":"all","languages":["curl","javascript","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://help.clinikehr.com","label":"Help Center"},{"href":"https://status.clinikehr.com","label":"Status"},{"href":"mailto:[email protected]","label":"Contact support"}],"primary":{"type":"button","label":"Open developer portal","href":"https://developer.clinikehr.com"}},"footer":{"socials":{"website":"https://clinikehr.com","x":"https://x.com/clinikehr","linkedin":"https://www.linkedin.com/company/clinikehr"},"links":[{"header":"Product","items":[{"label":"ClinikEHR","href":"https://clinikehr.com"},{"label":"Pricing","href":"https://clinikehr.com/pricing"}]},{"header":"Resources","items":[{"label":"Help Center","href":"https://help.clinikehr.com"},{"label":"Developer portal","href":"https://developer.clinikehr.com"},{"label":"Status","href":"https://status.clinikehr.com"}]},{"header":"Company","items":[{"label":"Contact support","href":"mailto:[email protected]"},{"label":"Privacy","href":"https://clinikehr.com/privacy"},{"label":"Terms","href":"https://clinikehr.com/terms"}]}]},"seo":{"metatags":{"og:site_name":"ClinikEHR API"},"indexing":"navigable"},"fonts":{"family":"Geist"},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"integrations":{"posthog":{"apiKey":"phc_817t39VWvmzFeNxvLBBOVQM0CnsuX5INS2qERVGXmIY","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clinikehrapi","hasAudioNarration":false,"actualSubdomain":"clinikehrapi","customDomains":["docs.clinikehr.com"],"gitSource":{"type":"github","owner":"clinikehr","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af297a5e44c8040cf970c65","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":121},{"language":"default","tag":"Documentation","count":48},{"language":"default","tag":"Resources","count":20},{"language":"default","tag":"Inventory","count":20},{"language":"default","tag":"HMO insurance","count":14},{"language":"default","tag":"Patients","count":11},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Appointments","count":8},{"language":"default","tag":"CRM","count":8},{"language":"default","tag":"Building an integration","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"site-roles","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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ck-teal-50: #f0fdfa;--ck-teal-100: #ccfbf1;--ck-teal-500: #14b8a6;--ck-teal-600: #0d9488;--ck-teal-700: #0f766e;--ck-surface: #ffffff;--ck-surface-muted: #f8fafc;--ck-border: #e2e8f0;--ck-text: #0f172a;--ck-text-muted: #64748b;--ck-edition-clinic: #0d9488;--ck-edition-pharmacy: #7c3aed;--ck-edition-lims: #0284c7;--ck-edition-portal: #db2777}.dark{--ck-surface: #0b1120;--ck-surface-muted: #111827;--ck-border: #1f2937;--ck-text: #e2e8f0;--ck-text-muted: #94a3b8;--ck-edition-clinic: #2dd4bf;--ck-edition-pharmacy: #a78bfa;--ck-edition-lims: #38bdf8;--ck-edition-portal: #f472b6}.ck-avail{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem;margin:1.25rem 0 1.75rem;padding:0.75rem 0.9rem;border:1px solid var(--ck-border);border-radius:0.75rem;background:var(--ck-surface-muted);font-size:0.8125rem;line-height:1.4}.ck-avail__label{font-weight:600;color:var(--ck-text-muted);text-transform:uppercase;letter-spacing:0.04em;font-size:0.6875rem;margin-right:0.15rem}.ck-pill{display:inline-flex;align-items:center;gap:0.35rem;padding:0.2rem 0.6rem;border-radius:999px;border:1px solid currentColor;font-weight:600;font-size:0.75rem;white-space:nowrap}.ck-pill--clinic{color:var(--ck-edition-clinic)}.ck-pill--pharmacy{color:var(--ck-edition-pharmacy)}.ck-pill--lims{color:var(--ck-edition-lims)}.ck-pill--portal{color:var(--ck-edition-portal)}.ck-pill--plan{color:var(--ck-text-muted);border-style:dashed}.ck-pill--role{color:var(--ck-text-muted);border-color:var(--ck-border);background:var(--ck-surface)}.ck-avail__note{flex-basis:100%;color:var(--ck-text-muted)}.ck-callout{margin:1.5rem 0;padding:0.9rem 1rem;border-radius:0.75rem;border:1px solid var(--ck-border);border-left-width:3px;background:var(--ck-surface-muted)}.ck-callout--note{border-left-color:var(--ck-teal-600)}.ck-callout--info{border-left-color:#6366f1}.dark .ck-callout--note{border-left-color:var(--ck-teal-500)}.dark .ck-callout--info{border-left-color:#818cf8}.ck-callout__body{margin:0;font-size:0.9375rem;line-height:1.6;color:var(--ck-text)}.ck-callout__body a{color:var(--ck-teal-700);text-decoration:underline;text-underline-offset:2px}.dark .ck-callout__body a{color:var(--ck-teal-500)}.ck-task{display:grid;gap:0.75rem;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));margin:1.5rem 0}.ck-task__cell{border:1px solid var(--ck-border);border-radius:0.75rem;padding:0.85rem 1rem;background:var(--ck-surface)}.ck-task__title{font-size:0.6875rem;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;color:var(--ck-teal-600);margin-bottom:0.35rem}.dark .ck-task__title{color:var(--ck-teal-500)}.ck-task__body{font-size:0.875rem;color:var(--ck-text);margin:0}.ck-path{display:inline-flex;flex-wrap:wrap;align-items:center;gap:0.35rem;padding:0.3rem 0.6rem;border-radius:0.5rem;background:var(--ck-teal-50);border:1px solid var(--ck-teal-100);font-size:0.8125rem;font-weight:500;color:var(--ck-teal-700)}.dark .ck-path{background:rgba(13, 148, 136, 0.12);border-color:rgba(45, 212, 191, 0.28);color:var(--ck-teal-500)}.ck-path__sep{opacity:0.55}#sidebar li>a,#sidebar li>div{font-size:0.8125rem}#content-area a[href]>div.group,#content-area .card{transition:transform 150ms ease, box-shadow 150ms ease, border-color 150ms ease}#content-area a[href]:hover>div.group,#content-area .card:hover{transform:translateY(-2px);box-shadow:0 8px 24px -12px rgba(15, 23, 42, 0.25);border-color:var(--ck-teal-500)}.dark #content-area a[href]:hover>div.group,.dark #content-area .card:hover{box-shadow:0 8px 24px -12px rgba(0, 0, 0, 0.6)}#content-area table{display:block;overflow-x:auto;max-width:100%}#content-area thead th{font-size:0.75rem;text-transform:uppercase;letter-spacing:0.04em;color:var(--ck-text-muted)}#content-area .steps .step-number,#content-area [class*=\"step\"]>div[class*=\"rounded-full\"]{background-color:var(--ck-teal-600);color:#fff}@media (max-width: 768px){#content-area table{font-size:0.8125rem}#content-area th,#content-area td{padding-left:0.6rem;padding-right:0.6rem}}@media (max-width: 640px){.ck-avail{padding:0.6rem 0.7rem;gap:0.4rem;font-size:0.78rem}.ck-pill{padding:0.15rem 0.5rem;font-size:0.7rem}.ck-task{grid-template-columns:1fr;gap:0.5rem}.ck-task__cell{padding:0.7rem 0.85rem}.ck-path{font-size:0.78rem;line-height:1.9}.ck-callout{padding:0.75rem 0.85rem;margin:1.1rem 0}}@media (pointer: coarse){#content-area .card,#content-area a[href]>div.group{min-height:44px}#sidebar li>a{padding-top:0.45rem;padding-bottom:0.45rem}}"}]}
{"page":{"pagePath":"api-reference/appointments/cancel-an-appointment","slug":"/api-reference/appointments/cancel-an-appointment","pageMetadata":{"title":"Cancel an appointment","description":"**Permission:** `appointments:write`\n\nCancel an appointment. The only route that may set status=cancelled.","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/appointments/{appointment_id}/cancel","href":"/api-reference/appointments/cancel-an-appointment","autogeneratedByOpenApi":true},"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 code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Permission:\"\n }), \" \", _jsx(_components.code, {\n children: \"appointments:write\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Cancel an appointment. The only route that may set status=cancelled.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Cancel an appointment","description":"**Permission:** `appointments:write`\n\nCancel an appointment. The only route that may set status=cancelled.","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/appointments/{appointment_id}/cancel","href":"/api-reference/appointments/cancel-an-appointment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"cancelAppointment","tags":["Appointments"],"summary":"Cancel an appointment","security":["90b9ef33-e75a-4cb3-b697-a120e35be6db"],"parameters":["b5f8bb74-b598-4342-89ab-e7386f52227d","60ce0a3a-690c-4812-a5c3-d99a047613ff","24610c8b-42e0-4c73-a3b9-6a813644d744"],"requestBody":"822bc349-5a6a-412f-b347-2fd47671b51e","responses":{"200":"ebdec67d-ec22-4e4f-954a-8313cca71e39","400":"542e5699-d75a-430b-8c31-1fff28d2031e","401":"3569d038-dfde-4695-a1a1-c27f60efe9f9","403":"df26cc0b-8ec3-449b-83c1-d07db778eaff","404":"abb4cf27-40f0-40b6-98d7-17af9ba29b23","409":"13470bf8-55b3-49f2-80c1-c76c64265555","429":"cc27e881-23ed-4caf-891a-238989e590ff"},"description":"**Permission:** `appointments:write`\n\nCancel an appointment. The only route that may set status=cancelled.","method":"post","type":"path","servers":["6b4925f0-63ab-4b39-afe9-988d83d8bf2e"],"path":"/v1/clinics/{clinic_id}/appointments/{appointment_id}/cancel","baseUrlOptions":["https://api.clinikehr.com"],"title":"Cancel an appointment","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b5f8bb74-b598-4342-89ab-e7386f52227d":{"name":"Idempotency-Key","in":"header","required":true,"description":"A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with `409 idempotency_key_conflict`, and retrying while the first request is still running with `409 idempotency_key_reused`. See Retries and idempotency.","schema":{"type":"string","minLength":1,"isRequired":true,"description":"A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with `409 idempotency_key_conflict`, and retrying while the first request is still running with `409 idempotency_key_reused`. See Retries and idempotency.","uniqueKey":"","typeLabel":"string"}},"60ce0a3a-690c-4812-a5c3-d99a047613ff":{"name":"clinic_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"24610c8b-42e0-4c73-a3b9-6a813644d744":{"name":"appointment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"reason":{"type":"string","uniqueKey":"reason","typeLabel":"string"},"notify_patient":{"type":"boolean","default":true,"description":"false only ever DOWNGRADES notification columns — the patient is not emailed about the cancellation, and it never re-enables a row already silenced.","uniqueKey":"notify_patient","typeLabel":"boolean"},"run_automations":{"type":"boolean","default":false,"uniqueKey":"run_automations","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"reason":"\u003cstring>","notify_patient":true,"run_automations":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ebdec67d-ec22-4e4f-954a-8313cca71e39":{"description":"OK.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"Never present here, by name: client_appointment_date/client_start_time/ client_end_time/client_timezone, form_data, custom_color, provider_user_id, time_range, excluded_from_overlap_check, booking_identity_review, provider_busy_minutes, out_of_office_confirmed_at, booking_confirmation_deferred, clinic_id.","required":["id","status"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["scheduled","confirmed","in_progress","completed","cancelled","no_show","rescheduled"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"patient_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.patient_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.patient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.patient_id","typeLabel":"string\u003cuuid> | null"},"service_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.service_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.service_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.service_id","typeLabel":"string\u003cuuid> | null"},"clinician_id":{"oneOf":[{"type":"string","format":"uuid","description":"clinic_staff.id — never provider_user_id.","uniqueKey":"data.clinician_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"clinic_staff.id — never provider_user_id.","uniqueKey":"data.clinician_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.clinician_id","typeLabel":"string\u003cuuid> | null"},"start_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.start_at","typeLabel":"string\u003cdate-time> | null"},"end_at":{"oneOf":[{"type":"string","format":"date-time","description":"Derived from the service's duration — never independent input.","uniqueKey":"data.end_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Derived from the service's duration — never independent input.","uniqueKey":"data.end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.end_at","typeLabel":"string\u003cdate-time> | null"},"duration_minutes":{"oneOf":[{"type":"integer","uniqueKey":"data.duration_minutes.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.duration_minutes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.duration_minutes","typeLabel":"integer | null"},"timezone":{"oneOf":[{"type":"string","uniqueKey":"data.timezone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.timezone","typeLabel":"string | null"},"venue_type":{"oneOf":[{"type":"string","enum":["physical","online","mobile_clinic",null],"uniqueKey":"data.venue_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["physical","online","mobile_clinic",null],"uniqueKey":"data.venue_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.venue_type","typeLabel":"enum\u003cstring> | null"},"venue_details":{"oneOf":[{"type":"object","description":"Read-only.","uniqueKey":"data.venue_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Read-only.","uniqueKey":"data.venue_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.venue_details","typeLabel":"object | null"},"booking_source":{"oneOf":[{"type":"string","description":"Always \"api\" for a row this API created.","uniqueKey":"data.booking_source.oneOf.0","typeLabel":"string"},{"type":"null","description":"Always \"api\" for a row this API created.","uniqueKey":"data.booking_source.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.booking_source","typeLabel":"string | null"},"patient_notes":{"oneOf":[{"type":"string","uniqueKey":"data.patient_notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.patient_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.patient_notes","typeLabel":"string | null"},"clinic_notes":{"oneOf":[{"type":"string","uniqueKey":"data.clinic_notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.clinic_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.clinic_notes","typeLabel":"string | null"},"symptoms_description":{"oneOf":[{"type":"string","uniqueKey":"data.symptoms_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.symptoms_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.symptoms_description","typeLabel":"string | null"},"urgency_level":{"oneOf":[{"type":"string","enum":["low","normal","high","emergency",null],"uniqueKey":"data.urgency_level.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["low","normal","high","emergency",null],"uniqueKey":"data.urgency_level.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.urgency_level","typeLabel":"enum\u003cstring> | null"},"ai_category":{"oneOf":[{"type":"string","description":"Read-only.","uniqueKey":"data.ai_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only.","uniqueKey":"data.ai_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ai_category","typeLabel":"string | null"},"ai_priority_score":{"oneOf":[{"type":"number","description":"Read-only.","uniqueKey":"data.ai_priority_score.oneOf.0","typeLabel":"number"},{"type":"null","description":"Read-only.","uniqueKey":"data.ai_priority_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ai_priority_score","typeLabel":"number | null"},"ai_suggested_duration":{"oneOf":[{"type":"number","description":"Read-only.","uniqueKey":"data.ai_suggested_duration.oneOf.0","typeLabel":"number"},{"type":"null","description":"Read-only.","uniqueKey":"data.ai_suggested_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ai_suggested_duration","typeLabel":"number | null"},"predicted_show_probability":{"oneOf":[{"type":"number","description":"Read-only.","uniqueKey":"data.predicted_show_probability.oneOf.0","typeLabel":"number"},{"type":"null","description":"Read-only.","uniqueKey":"data.predicted_show_probability.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.predicted_show_probability","typeLabel":"number | null"},"confirmation_sent_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.confirmation_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.confirmation_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.confirmation_sent_at","typeLabel":"string\u003cdate-time> | null"},"confirmation_method":{"oneOf":[{"type":"string","uniqueKey":"data.confirmation_method.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.confirmation_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.confirmation_method","typeLabel":"string | null"},"reminder_sent_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.reminder_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.reminder_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reminder_sent_at","typeLabel":"string\u003cdate-time> | null"},"reminder_method":{"oneOf":[{"type":"string","uniqueKey":"data.reminder_method.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.reminder_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reminder_method","typeLabel":"string | null"},"reminder_sent":{"oneOf":[{"type":"boolean","uniqueKey":"data.reminder_sent.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"data.reminder_sent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.reminder_sent","typeLabel":"boolean | null"},"payment_status":{"oneOf":[{"type":"string","enum":["pending","paid","partial","refunded","waived","failed",null],"uniqueKey":"data.payment_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending","paid","partial","refunded","waived","failed",null],"uniqueKey":"data.payment_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payment_status","typeLabel":"enum\u003cstring> | null"},"payment_method":{"oneOf":[{"type":"string","uniqueKey":"data.payment_method.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payment_method","typeLabel":"string | null"},"payment_amount":{"oneOf":[{"type":"number","uniqueKey":"data.payment_amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.payment_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payment_amount","typeLabel":"number | null"},"payment_due_date":{"oneOf":[{"type":"string","format":"date","uniqueKey":"data.payment_due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"data.payment_due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payment_due_date","typeLabel":"string\u003cdate> | null"},"amount_paid":{"oneOf":[{"type":"number","description":"Read-only.","uniqueKey":"data.amount_paid.oneOf.0","typeLabel":"number"},{"type":"null","description":"Read-only.","uniqueKey":"data.amount_paid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.amount_paid","typeLabel":"number | null"},"payment_id":{"oneOf":[{"type":"string","description":"Read-only.","uniqueKey":"data.payment_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only.","uniqueKey":"data.payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.payment_id","typeLabel":"string | null"},"confirmation_code":{"oneOf":[{"type":"string","description":"Read-only.","uniqueKey":"data.confirmation_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only.","uniqueKey":"data.confirmation_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.confirmation_code","typeLabel":"string | null"},"cancellation_reason":{"oneOf":[{"type":"string","uniqueKey":"data.cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.cancellation_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancellation_reason","typeLabel":"string | null"},"cancelled_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.cancelled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancelled_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.completed_at","typeLabel":"string\u003cdate-time> | null"},"is_group_appointment":{"oneOf":[{"type":"boolean","description":"Read-only.","uniqueKey":"data.is_group_appointment.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Read-only.","uniqueKey":"data.is_group_appointment.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.is_group_appointment","typeLabel":"boolean | null"},"max_participants":{"oneOf":[{"type":"integer","description":"Read-only.","uniqueKey":"data.max_participants.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Read-only.","uniqueKey":"data.max_participants.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.max_participants","typeLabel":"integer | null"},"group_name":{"oneOf":[{"type":"string","description":"Read-only.","uniqueKey":"data.group_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only.","uniqueKey":"data.group_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.group_name","typeLabel":"string | null"},"recurrence_pattern_id":{"oneOf":[{"type":"string","format":"uuid","description":"Read-only. Creating/editing a whole series is refused.","uniqueKey":"data.recurrence_pattern_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Read-only. Creating/editing a whole series is refused.","uniqueKey":"data.recurrence_pattern_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recurrence_pattern_id","typeLabel":"string\u003cuuid> | null"},"series_id":{"oneOf":[{"type":"string","format":"uuid","description":"Read-only.","uniqueKey":"data.series_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Read-only.","uniqueKey":"data.series_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.series_id","typeLabel":"string\u003cuuid> | null"},"series_index":{"oneOf":[{"type":"integer","description":"Read-only.","uniqueKey":"data.series_index.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Read-only.","uniqueKey":"data.series_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.series_index","typeLabel":"integer | null"},"email_notifications":{"oneOf":[{"type":"boolean","description":"Whether the patient is emailed about this appointment: confirmations, changes, cancellations and reminders. false silences all of them. The clinicians involved are still told about a change.","uniqueKey":"data.email_notifications.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the patient is emailed about this appointment: confirmations, changes, cancellations and reminders. false silences all of them. The clinicians involved are still told about a change.","uniqueKey":"data.email_notifications.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.email_notifications","typeLabel":"boolean | null"},"sms_notifications":{"oneOf":[{"type":"boolean","description":"Whether the patient is sent text reminders for this appointment.","uniqueKey":"data.sms_notifications.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the patient is sent text reminders for this appointment.","uniqueKey":"data.sms_notifications.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.sms_notifications","typeLabel":"boolean | null"},"voice_notifications":{"oneOf":[{"type":"boolean","description":"Whether the patient is sent voice reminders for this appointment.","uniqueKey":"data.voice_notifications.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the patient is sent voice reminders for this appointment.","uniqueKey":"data.voice_notifications.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.voice_notifications","typeLabel":"boolean | null"},"notes_session_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"data.notes_session_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Read-only.","uniqueKey":"data.notes_session_ids","typeLabel":"string\u003cuuid>[]"},"class_session_id":{"oneOf":[{"type":"string","format":"uuid","description":"Read-only.","uniqueKey":"data.class_session_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Read-only.","uniqueKey":"data.class_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.class_session_id","typeLabel":"string\u003cuuid> | null"},"self_reschedule_count":{"oneOf":[{"type":"integer","description":"Read-only. Tracks PATIENT-initiated portal reschedules only — never incremented by this API.","uniqueKey":"data.self_reschedule_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Read-only. Tracks PATIENT-initiated portal reschedules only — never incremented by this API.","uniqueKey":"data.self_reschedule_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.self_reschedule_count","typeLabel":"integer | null"},"location_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.location_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.location_id","typeLabel":"string\u003cuuid> | null"},"participants":{"type":"array","items":{"type":"object","properties":{"patient_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.participants.items.[INDEX].patient_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.participants.items.[INDEX].patient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.participants.items.[INDEX].patient_id","typeLabel":"string\u003cuuid> | null"},"status":{"oneOf":[{"type":"string","uniqueKey":"data.participants.items.[INDEX].status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.participants.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.participants.items.[INDEX].status","typeLabel":"string | null"}},"uniqueKey":"data.participants.items.[INDEX]","typeLabel":"object"},"description":"Read-only group roster — group creation is a scope cut in v1.","uniqueKey":"data.participants","typeLabel":"object[]"},"created_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"scheduled","patient_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","service_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","clinician_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","start_at":"2023-11-07T05:31:56Z","end_at":"2023-11-07T05:31:56Z","duration_minutes":123,"timezone":"\u003cstring>","venue_type":"physical","venue_details":{},"booking_source":"\u003cstring>","patient_notes":"\u003cstring>","clinic_notes":"\u003cstring>","symptoms_description":"\u003cstring>","urgency_level":"low","ai_category":"\u003cstring>","ai_priority_score":123,"ai_suggested_duration":123,"predicted_show_probability":123,"confirmation_sent_at":"2023-11-07T05:31:56Z","confirmation_method":"\u003cstring>","reminder_sent_at":"2023-11-07T05:31:56Z","reminder_method":"\u003cstring>","reminder_sent":true,"payment_status":"pending","payment_method":"\u003cstring>","payment_amount":123,"payment_due_date":"2023-12-25","amount_paid":123,"payment_id":"\u003cstring>","confirmation_code":"\u003cstring>","cancellation_reason":"\u003cstring>","cancelled_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z","is_group_appointment":true,"max_participants":123,"group_name":"\u003cstring>","recurrence_pattern_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","series_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","series_index":123,"email_notifications":true,"sms_notifications":true,"voice_notifications":true,"notes_session_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"class_session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","self_reschedule_count":123,"location_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","participants":[{"patient_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"\u003cstring>"}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"542e5699-d75a-430b-8c31-1fff28d2031e":{"description":"The request failed validation (unknown query parameter, limit out of range, malformed body, a write-off sent without its reason — `reason_required`, or a `gtin` identifier that is not a valid GTIN — `invalid_gtin`).","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3569d038-dfde-4695-a1a1-c27f60efe9f9":{"description":"Missing, malformed, unknown, revoked or expired key, or the wrong secret.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"df26cc0b-8ec3-449b-83c1-d07db778eaff":{"description":"The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"abb4cf27-40f0-40b6-98d7-17af9ba29b23":{"description":"The record is absent, or out of the key's scope — one message for both.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"13470bf8-55b3-49f2-80c1-c76c64265555":{"description":"The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), an item that has been used and so cannot be deleted (`item_has_history`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), a stock report sent to a pharmacy that is not set to take one from another system (`external_stock_mode_required`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it).","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cc27e881-23ed-4caf-891a-238989e590ff":{"description":"Rate limited. See the Retry-After header.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 application/problem+json.","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["pointer","message"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"code":"\u003cstring>","request_id":"\u003cstring>","detail":"\u003cstring>","errors":[{"pointer":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"90b9ef33-e75a-4cb3-b697-a120e35be6db":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ehr_live_\u003ckeyId>_\u003csecret> or ehr_test_\u003ckeyId>_\u003csecret>","scopes":[],"schemeName":"ApiKey"}}},"servers":{"6b4925f0-63ab-4b39-afe9-988d83d8bf2e":{"url":"https://api.clinikehr.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"ehr_live_\u003ckeyId>_\u003csecret> or ehr_test_\u003ckeyId>_\u003csecret>","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi/ehr-api.v1.yaml"},"subdomain":"clinikehrapi","siteName":"ClinikEHR API","title":"Cancel an appointment - ClinikEHR API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T00:01:38.017Z","originalFileLocation":"api-reference/appointments/cancel-an-appointment.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=\"Permission: appointments:write Cancel an appointment. The only route that may set status=cancelled.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClinikEHR API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel an appointment - ClinikEHR API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Permission: appointments:write Cancel an appointment. The only route that may set status=cancelled.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClinikEHR API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clinikehrapi.mintlify.site/_mintlify/api/og/v2?division=Appointments\u0026amp;title=Cancel+an+appointment\u0026amp;description=**Permission%3A**+%60appointments%3Awrite%60%0A%0ACancel+an+appointment.+The+only+route+that+may+set+status%3Dcancelled.\u0026amp;theme=db10b84d30f87e3825f88ac9\u0026amp;signature=6cac60e06345c926933a20cb77b2b39cb925f9c4b1ac2a751495778a58d9b713\">\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=\"Cancel an appointment - ClinikEHR API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Permission: appointments:write Cancel an appointment. The only route that may set status=cancelled.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clinikehrapi.mintlify.site/_mintlify/api/og/v2?division=Appointments\u0026amp;title=Cancel+an+appointment\u0026amp;description=**Permission%3A**+%60appointments%3Awrite%60%0A%0ACancel+an+appointment.+The+only+route+that+may+set+status%3Dcancelled.\u0026amp;theme=db10b84d30f87e3825f88ac9\u0026amp;signature=6cac60e06345c926933a20cb77b2b39cb925f9c4b1ac2a751495778a58d9b713\">\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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClinikEHR API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9488\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/appointments/cancel-an-appointment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clinikehr.com/#organization\",\"name\":\"ClinikEHR API\",\"url\":\"https://docs.clinikehr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/light.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=1c5da83101c773651a555abca64ef883\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clinikehr.com#website\",\"name\":\"ClinikEHR API\",\"url\":\"https://docs.clinikehr.com\",\"publisher\":{\"@id\":\"https://docs.clinikehr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment#webpage\",\"url\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment\",\"name\":\"Cancel an appointment\",\"description\":\"Permission: appointments:write Cancel an appointment. The only route that may set status=cancelled.\",\"dateModified\":\"2026-11-01T00:01:38.017Z\",\"isPartOf\":{\"@id\":\"https://docs.clinikehr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Appointments\",\"item\":\"https://docs.clinikehr.com/api-reference/appointments/list-bookable-services\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel an appointment\",\"item\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment#apireference\",\"headline\":\"Cancel an appointment\",\"name\":\"Cancel an appointment\",\"description\":\"Permission: appointments:write Cancel an appointment. The only route that may set status=cancelled.\",\"url\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clinikehr.com/api-reference/appointments/cancel-an-appointment#webpage\"},\"dateModified\":\"2026-11-01T00:01:38.017Z\",\"publisher\":{\"@id\":\"https://docs.clinikehr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clinikehr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClinikEHR API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClinikEHR API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/appointments/cancel-an-appointment.md","siteName":"ClinikEHR API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/code.svg","href":"/api-reference/overview"}]},{"group":"Your key","pages":[{"title":"Get the current key","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/me","href":"/api-reference/me/get-the-current-key"}]},{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/connections","href":"/api-reference/connections/list-connections"}]},{"group":"Patients","pages":[{"title":"List patients","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/patients","href":"/api-reference/patients/list-patients"},{"title":"Create a patient","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/patients","href":"/api-reference/patients/create-a-patient"},{"title":"Get a patient","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/patients/{patient_id}","href":"/api-reference/patients/get-a-patient"},{"title":"Update a patient","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/patients/{patient_id}","href":"/api-reference/patients/update-a-patient"},{"title":"Archive a patient","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/patients/{patient_id}/archive","href":"/api-reference/patients/archive-a-patient"},{"title":"List possible duplicate patients","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/patients/duplicate_flags","href":"/api-reference/patients/list-possible-duplicate-patients"},{"title":"Search patients","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/patients/search","href":"/api-reference/patients/search-patients"},{"title":"List patient imports","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/patient-imports","href":"/api-reference/patients/list-patient-imports"},{"title":"Start a patient import","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/patient-imports","href":"/api-reference/patients/start-a-patient-import"},{"title":"Get a patient import","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/patient-imports/{job_id}","href":"/api-reference/patients/get-a-patient-import"},{"title":"Import the valid rows","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/patient-imports/{job_id}/run-valid","href":"/api-reference/patients/import-the-valid-rows"}]},{"group":"Appointments","pages":[{"title":"List bookable services","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/appointments/services","href":"/api-reference/appointments/list-bookable-services"},{"title":"List bookable clinicians","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/appointments/clinicians","href":"/api-reference/appointments/list-bookable-clinicians"},{"title":"Get available slots","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/appointments/availability","href":"/api-reference/appointments/get-available-slots"},{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/appointments","href":"/api-reference/appointments/list-appointments"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/appointments","href":"/api-reference/appointments/book-an-appointment"},{"title":"Get an appointment","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/appointments/{appointment_id}","href":"/api-reference/appointments/get-an-appointment"},{"title":"Update an appointment","description":"**Permission:** `appointments:write`\n\nReschedule or update an appointment. Immutable after create — patient_id, service_id, location_id, every payment field — are refused if sent.\n\nA new `start_at` or `clinician_id` is checked exactly as a new booking is (the slot must be free and the clinician bookable). Other fields are plain edits; an absent field is unchanged. `status` may only move to `confirmed` here; use the cancel route to cancel. A cancelled, completed or no-show appointment cannot be changed. With a test key the same edits work on the sandbox's fictional appointments, including a new time; a sandbox time is in UTC, and a slot that overlaps that clinician's other sandbox appointments is refused with `slot_taken`.\n\nWho is told. For a live (non-test) appointment that is still booked and in the future, changing `start_at`, `clinician_id` or `venue_type` emails the patient and any participants: a new time is a reschedule notice, a new clinician or venue is an \"Appointment updated\" notice. The clinicians involved are told in the app and by email: the new clinician that a visit was added, the previous clinician that it was removed, or the current clinician that it moved. This follows the clinic's appointment notification setting and each clinician's own email setting. With `email_notifications` false on the appointment the patient is not emailed, but the clinicians still are. Each later change sends its own notice, and the patient's reminder is re-armed for the new time. Test-key appointments never send email.","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/appointments/{appointment_id}","href":"/api-reference/appointments/update-an-appointment"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/appointments/{appointment_id}/cancel","href":"/api-reference/appointments/cancel-an-appointment"}]},{"group":"Encounters","pages":[{"title":"List encounters","description":"**Permission:** `encounters:read`\n\nList one patient's visits.\n\nAn encounter is a visit note: the visit's status, dates, reason for visit and clinician, with no clinical text (read the note through Notes; the ids are shared). `patient_id` is required. `status` filters to `draft` (not yet signed) or `completed`. Sensitive notes and a restricted patient's visits are never returned. With `Accept: application/fhir+json` the answer is a searchset Bundle of FHIR R4 Encounter resources.","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/encounters","href":"/api-reference/encounters/list-encounters"},{"title":"Open an encounter","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/encounters","href":"/api-reference/encounters/open-an-encounter"},{"title":"Get an encounter","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/encounters/{encounter_id}","href":"/api-reference/encounters/get-an-encounter"},{"title":"Update an encounter","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/encounters/{encounter_id}","href":"/api-reference/encounters/update-an-encounter"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/notes","href":"/api-reference/notes/list-notes"},{"title":"Create a draft note","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/notes","href":"/api-reference/notes/create-a-draft-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/notes/{note_id}","href":"/api-reference/notes/get-a-note"},{"title":"Update a draft note","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/notes/{note_id}","href":"/api-reference/notes/update-a-draft-note"},{"title":"List note templates","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/note-templates","href":"/api-reference/notes/list-note-templates"},{"title":"Get a note template","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/note-templates/{template_key}","href":"/api-reference/notes/get-a-note-template"},{"title":"List note clinicians","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/note-clinicians","href":"/api-reference/notes/list-note-clinicians"}]},{"group":"Conditions","pages":[{"title":"List conditions","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/conditions","href":"/api-reference/conditions/list-conditions"},{"title":"Submit a condition","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/conditions","href":"/api-reference/conditions/submit-a-condition"},{"title":"Get a condition","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/conditions/{condition_id}","href":"/api-reference/conditions/get-a-condition"},{"title":"Update or retract a condition","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/conditions/{condition_id}","href":"/api-reference/conditions/update-or-retract-a-condition"}]},{"group":"Allergies","pages":[{"title":"List allergies","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/allergies","href":"/api-reference/allergies/list-allergies"},{"title":"Submit an allergy","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/allergies","href":"/api-reference/allergies/submit-an-allergy"},{"title":"Get an allergy","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/allergies/{allergy_id}","href":"/api-reference/allergies/get-an-allergy"},{"title":"Update or retract an allergy","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/allergies/{allergy_id}","href":"/api-reference/allergies/update-or-retract-an-allergy"}]},{"group":"Medications","pages":[{"title":"List reported medicines","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/medication-statements","href":"/api-reference/medications/list-reported-medicines"},{"title":"Submit a reported medicine","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/medication-statements","href":"/api-reference/medications/submit-a-reported-medicine"},{"title":"Get a reported medicine","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/medication-statements/{medication_statement_id}","href":"/api-reference/medications/get-a-reported-medicine"},{"title":"Update or retract a reported medicine","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/medication-statements/{medication_statement_id}","href":"/api-reference/medications/update-or-retract-a-reported-medicine"},{"title":"List prescriptions","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/prescriptions","href":"/api-reference/medications/list-prescriptions"},{"title":"Get a prescription","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/prescriptions/{prescription_id}","href":"/api-reference/medications/get-a-prescription"}]},{"group":"Referrals","pages":[{"title":"List referrals","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/referrals","href":"/api-reference/referrals/list-referrals"},{"title":"Submit a referral","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/referrals","href":"/api-reference/referrals/submit-a-referral"},{"title":"Get a referral","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/referrals/{referral_id}","href":"/api-reference/referrals/get-a-referral"},{"title":"Update or retract a referral","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/referrals/{referral_id}","href":"/api-reference/referrals/update-or-retract-a-referral"}]},{"group":"Submissions","pages":[{"title":"Get a submission","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/submissions/{submission_id}","href":"/api-reference/submissions/get-a-submission"}]},{"group":"Providers","pages":[{"title":"List providers","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/providers","href":"/api-reference/providers/list-providers"},{"title":"Get a provider","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/providers/{provider_id}","href":"/api-reference/providers/get-a-provider"}]},{"group":"Care providers","pages":[{"title":"List outside care providers","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/care-providers","href":"/api-reference/careproviders/list-outside-care-providers"},{"title":"Add an outside care provider","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/care-providers","href":"/api-reference/careproviders/add-an-outside-care-provider"},{"title":"Get an outside care provider","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/care-providers/{care_provider_id}","href":"/api-reference/careproviders/get-an-outside-care-provider"},{"title":"Update an outside care provider","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/care-providers/{care_provider_id}","href":"/api-reference/careproviders/update-an-outside-care-provider"},{"title":"Remove an outside care provider","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml delete /v1/clinics/{clinic_id}/care-providers/{care_provider_id}","href":"/api-reference/careproviders/remove-an-outside-care-provider"}]},{"group":"Insurance payers","pages":[{"title":"List payers","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/payers","href":"/api-reference/payers/list-payers"},{"title":"Get a payer","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/payers/{payer_id}","href":"/api-reference/payers/get-a-payer"}]},{"group":"Insurance coverage","pages":[{"title":"List coverages","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/coverages","href":"/api-reference/coverages/list-coverages"},{"title":"Create a coverage","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/coverages","href":"/api-reference/coverages/create-a-coverage"},{"title":"Get a coverage","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/coverages/{coverage_id}","href":"/api-reference/coverages/get-a-coverage"},{"title":"Update or end a coverage","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/coverages/{coverage_id}","href":"/api-reference/coverages/update-or-end-a-coverage"}]},{"group":"HMO insurance","pages":[{"title":"List insurer enrollees","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/enrollees","href":"/api-reference/hmo-insurance/list-insurer-enrollees"},{"title":"Get an insurer enrollee","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/enrollees/{enrollee_id}","href":"/api-reference/hmo-insurance/get-an-insurer-enrollee"},{"title":"List insurer plans","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/plans","href":"/api-reference/hmo-insurance/list-insurer-plans"},{"title":"Get an insurer plan","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/plans/{plan_id}","href":"/api-reference/hmo-insurance/get-an-insurer-plan"},{"title":"List insurer claims","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/claims","href":"/api-reference/hmo-insurance/list-insurer-claims"},{"title":"Submit an insurance claim","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/claims","href":"/api-reference/hmo-insurance/submit-an-insurance-claim"},{"title":"Get an insurer claim","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/claims/{claim_id}","href":"/api-reference/hmo-insurance/get-an-insurer-claim"},{"title":"Vet an insurance claim","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/claims/{claim_id}/adjudication","href":"/api-reference/hmo-insurance/vet-an-insurance-claim"},{"title":"List pre-authorization requests","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/pre-authorizations","href":"/api-reference/hmo-insurance/list-pre-authorization-requests"},{"title":"Send a pre-authorization request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/pre-authorizations","href":"/api-reference/hmo-insurance/send-a-pre-authorization-request"},{"title":"Get a pre-authorization request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/pre-authorizations/{pa_id}","href":"/api-reference/hmo-insurance/get-a-pre-authorization-request"},{"title":"Decide a pre-authorization request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/pre-authorizations/{pa_id}/decision","href":"/api-reference/hmo-insurance/decide-a-pre-authorization-request"},{"title":"List payment advices","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/insurance/payment-advices","href":"/api-reference/hmo-insurance/list-payment-advices"},{"title":"Send a payment advice","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/payment-advices","href":"/api-reference/hmo-insurance/send-a-payment-advice"}]},{"group":"Inventory","pages":[{"title":"List stock locations","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/locations","href":"/api-reference/inventory/list-stock-locations"},{"title":"List catalogue items","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/items","href":"/api-reference/inventory/list-catalogue-items"},{"title":"Create a catalogue item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/items","href":"/api-reference/inventory/create-a-catalogue-item"},{"title":"Get a catalogue item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/items/{item_id}","href":"/api-reference/inventory/get-a-catalogue-item"},{"title":"Update a catalogue item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/inventory/items/{item_id}","href":"/api-reference/inventory/update-a-catalogue-item"},{"title":"Delete an unused item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml delete /v1/clinics/{clinic_id}/inventory/items/{item_id}","href":"/api-reference/inventory/delete-an-unused-item"},{"title":"Check item availability","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/availability","href":"/api-reference/inventory/check-item-availability"},{"title":"List stock quantities","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/stock","href":"/api-reference/inventory/list-stock-quantities"},{"title":"Upload an external stock batch","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/external-stock/batches","href":"/api-reference/inventory/upload-an-external-stock-batch"},{"title":"Get an external stock batch","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/external-stock/batches/{batch_id}","href":"/api-reference/inventory/get-an-external-stock-batch"},{"title":"Archive a catalogue item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/items/{item_id}/archive","href":"/api-reference/inventory/archive-a-catalogue-item"},{"title":"Restore a catalogue item","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/items/{item_id}/restore","href":"/api-reference/inventory/restore-a-catalogue-item"},{"title":"Write off a lot","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/lots/{lot_id}/write-off","href":"/api-reference/inventory/write-off-a-lot"},{"title":"Receive stock","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/receive","href":"/api-reference/inventory/receive-stock"},{"title":"Adjust stock","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/adjust","href":"/api-reference/inventory/adjust-stock"},{"title":"Transfer stock","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/transfer","href":"/api-reference/inventory/transfer-stock"},{"title":"List your medicine codes","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/codes","href":"/api-reference/inventory/list-your-medicine-codes"},{"title":"Upload medicine codes","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/inventory/codes","href":"/api-reference/inventory/upload-medicine-codes"},{"title":"Get a medicine code","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/codes/{code_entry_id}","href":"/api-reference/inventory/get-a-medicine-code"},{"title":"Delete a medicine code","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml delete /v1/clinics/{clinic_id}/inventory/codes/{code_entry_id}","href":"/api-reference/inventory/delete-a-medicine-code"}]},{"group":"Dispensing","pages":[{"title":"List dispensing history","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/dispensing/history","href":"/api-reference/dispensing/list-dispensing-history"},{"title":"List dispensing flags","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/dispensing/flags","href":"/api-reference/dispensing/list-dispensing-flags"}]},{"group":"Drug requests","pages":[{"title":"List drug requests","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/drug_requests","href":"/api-reference/drug-requests/list-drug-requests"},{"title":"Send a drug request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/drug_requests","href":"/api-reference/drug-requests/send-a-drug-request"},{"title":"Get a drug request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/drug_requests/{request_id}","href":"/api-reference/drug-requests/get-a-drug-request"},{"title":"Cancel a drug request","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/drug_requests/{request_id}/cancel","href":"/api-reference/drug-requests/cancel-a-drug-request"},{"title":"Answer a substitution","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/drug_requests/{request_id}/confirm_substitution","href":"/api-reference/drug-requests/answer-a-substitution"}]},{"group":"Pharmacy listings","pages":[{"title":"List reachable pharmacies","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/listings/pharmacies","href":"/api-reference/listing/list-reachable-pharmacies"},{"title":"Search listed pharmacies","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/listings/search","href":"/api-reference/listing/search-listed-pharmacies"},{"title":"Send search feedback","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/listings/feedback","href":"/api-reference/listing/send-search-feedback"},{"title":"List a pharmacy's listed items","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/listing/items","href":"/api-reference/listing/list-a-pharmacys-listed-items"},{"title":"Get a pharmacy's listing profile","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/listing/profile","href":"/api-reference/listing/get-a-pharmacys-listing-profile"}]},{"group":"CRM","pages":[{"title":"List pipelines","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/crm/pipelines","href":"/api-reference/crm/list-pipelines"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/crm/contacts","href":"/api-reference/crm/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/crm/contacts","href":"/api-reference/crm/create-a-contact"},{"title":"Search contacts","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/crm/contacts/search","href":"/api-reference/crm/search-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/crm/contacts/{contact_id}","href":"/api-reference/crm/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml patch /v1/clinics/{clinic_id}/crm/contacts/{contact_id}","href":"/api-reference/crm/update-a-contact"},{"title":"List a contact's activities","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/crm/contacts/{contact_id}/activities","href":"/api-reference/crm/list-a-contacts-activities"},{"title":"Log an activity","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/crm/contacts/{contact_id}/activities","href":"/api-reference/crm/log-an-activity"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/events","href":"/api-reference/events/list-events"}]},{"group":"FHIR","pages":[{"title":"Get the FHIR capability statement","deprecated":null,"version":null,"openapi":"/openapi/ehr-api.v1.yaml get /v1/metadata","href":"/api-reference/fhir/get-the-fhir-capability-statement"}]}]}]},"basePath":"","title":"Cancel an appointment - ClinikEHR API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}