{
"code": "server_unresponsive",
"message": "EHR integration is not available for this note",
"trace_id": "550e8400-e29b-41d4-a716-446655440000"
}
Patients
Create a patient
Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.
Client-generated UUID, honoured for 24 hours. Fails closed: if the idempotency store is unreachable the write is refused with 503 idempotency_unavailable and nothing reaches the EHR, rather than proceeding with the guarantee silently withdrawn. Omit the header to accept at-least-once instead.
Facility UUID from GET /facilities (fac_… also accepted on v3+). Send the same value to GET /payers?newChart=true to pick this chart's payers before creating it.
Ask the EHR to dedupe-check before committing. When candidates are found the write is WITHHELD and the response is 409 duplicate_candidates — surfacing that is what stops a booking flow creating duplicate charts.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Max AI Developer Docs","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#6D28D9"},"logo":{"light":"https://mintcdn.com/maxaiinc-02a56fd1/3kDaJXdVQ62Q_li2/logo/logo.png?fit=max\u0026auto=format\u0026n=3kDaJXdVQ62Q_li2\u0026q=85\u0026s=593e8b0c409b58f620609de6e29ebb79","dark":"https://mintcdn.com/maxaiinc-02a56fd1/3kDaJXdVQ62Q_li2/logo/logo.png?fit=max\u0026auto=format\u0026n=3kDaJXdVQ62Q_li2\u0026q=85\u0026s=593e8b0c409b58f620609de6e29ebb79"},"favicon":"https://mintcdn.com/maxaiinc-02a56fd1/3kDaJXdVQ62Q_li2/logo/logo.png?fit=max\u0026auto=format\u0026n=3kDaJXdVQ62Q_li2\u0026q=85\u0026s=593e8b0c409b58f620609de6e29ebb79","api":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"maxaiinc-02a56fd1","hasAudioNarration":false,"actualSubdomain":"maxaiinc-02a56fd1","customDomains":["docs.maxcare.ai"],"gitSource":{"type":"github","owner":"maxcare-ai","repo":"monorepo","deployBranch":"staging","contentDirectory":"workloads/api-docs-mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aedf59db961f3bf48d52094","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":914},{"language":"default","tag":"Patients","count":74},{"language":"default","tag":"Schedule","count":40},{"language":"default","tag":"EHR live reads","count":30},{"language":"default","tag":"Appointments","count":28},{"language":"default","tag":"Inventory","count":28},{"language":"default","tag":"Notes","count":28},{"language":"default","tag":"Tasks","count":28},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"Payers","count":20}]},"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":"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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/patients/create-a-patient","slug":"/api-reference/v2/patients/create-a-patient","pageMetadata":{"title":"Create a patient","description":"Creates a patient chart in the EHR. With `checkForDuplicates: true`, a dedupe hit WITHHOLDS the write and returns 409 `duplicate_candidates` with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an `Idempotency-Key` header to protect retries for 24 hours. An uncertain vendor outcome returns 409 `ehr_write_uncertain` with `requiresReconciliation: true`; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients","href":"/api-reference/v2/patients/create-a-patient","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a patient chart in the EHR. With \", _jsx(_components.code, {\n children: \"checkForDuplicates: true\"\n }), \", a dedupe hit WITHHOLDS the write and returns 409 \", _jsx(_components.code, {\n children: \"duplicate_candidates\"\n }), \" with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" header to protect retries for 24 hours. An uncertain vendor outcome returns 409 \", _jsx(_components.code, {\n children: \"ehr_write_uncertain\"\n }), \" with \", _jsx(_components.code, {\n children: \"requiresReconciliation: true\"\n }), \"; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\"]\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":{"title":"Create a patient","description":"Creates a patient chart in the EHR. With `checkForDuplicates: true`, a dedupe hit WITHHOLDS the write and returns 409 `duplicate_candidates` with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an `Idempotency-Key` header to protect retries for 24 hours. An uncertain vendor outcome returns 409 `ehr_write_uncertain` with `requiresReconciliation: true`; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients","href":"/api-reference/v2/patients/create-a-patient","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Creates a patient chart in the EHR. With `checkForDuplicates: true`, a dedupe hit WITHHOLDS the write and returns 409 `duplicate_candidates` with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an `Idempotency-Key` header to protect retries for 24 hours. An uncertain vendor outcome returns 409 `ehr_write_uncertain` with `requiresReconciliation: true`; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.","operationId":"PatientsPublicController_createPatient","parameters":["cafd0bc9-d47a-4ab9-b55d-0fc08f577cb3","1d7b6e07-822b-4294-8c3f-85ac63afc4cb"],"requestBody":"adf1b587-b368-484d-a7f2-43f52f6269b6","responses":{"201":"59f2edfe-1dfc-4379-b4c3-92114d38d1bd","400":"e32fb458-d37d-4a17-8de1-6c3879c462b2","401":"2ef4aaf5-fb37-4ac2-9166-4b0b7b95a898","403":"3150b8b8-0666-4364-9cc4-3f0848ab1191","409":"dc026f5a-9d2e-4880-9756-02a261884abb","429":"dbcb4b0f-d844-4b71-9e79-9c1f8bc88cc1","502":"a8e1d0d6-b4e0-4a48-b53b-bafe33ac62d5","503":"4cae4ddf-281c-4686-bb3f-6a78bd96d2bf"},"security":["a85b8de3-295c-453f-a601-e894cda1752e"],"summary":"Create a patient","tags":["Patients"],"method":"post","type":"path","servers":["bda469ab-e693-49f0-97b1-e1f5f0dcb0ee"],"path":"/patients","baseUrlOptions":["https://api.maxcare.ai/v2"],"title":"Create a patient","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cafd0bc9-d47a-4ab9-b55d-0fc08f577cb3":{"name":"idempotency-key","required":false,"in":"header","description":"Client-generated UUID, honoured for 24 hours. Fails closed: if the idempotency store is unreachable the write is refused with 503 `idempotency_unavailable` and nothing reaches the EHR, rather than proceeding with the guarantee silently withdrawn. Omit the header to accept at-least-once instead.","schema":{"type":"string","isRequired":false,"description":"Client-generated UUID, honoured for 24 hours. Fails closed: if the idempotency store is unreachable the write is refused with 503 `idempotency_unavailable` and nothing reaches the EHR, rather than proceeding with the guarantee silently withdrawn. Omit the header to accept at-least-once instead.","uniqueKey":"","typeLabel":"string"}},"1d7b6e07-822b-4294-8c3f-85ac63afc4cb":{"name":"X-Organization-Id","in":"header","required":true,"schema":{"type":"string","isRequired":true,"description":"Target clinic organization ID","uniqueKey":"","typeLabel":"string"},"description":"Target clinic organization ID"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","example":"Jane","isRequired":true,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","example":"Doe","isRequired":true,"uniqueKey":"lastName","typeLabel":"string"},"dateOfBirth":{"type":"string","description":"YYYY-MM-DD","example":"1984-02-11","isRequired":true,"uniqueKey":"dateOfBirth","typeLabel":"string"},"middleName":{"type":"string","example":"Marie","uniqueKey":"middleName","typeLabel":"string"},"sex":{"type":"string","description":"`MALE` | `FEMALE` | vendor value; the adapter maps it","example":"FEMALE","uniqueKey":"sex","typeLabel":"string"},"email":{"type":"string","example":"jane@example.com","uniqueKey":"email","typeLabel":"string"},"phones":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Contact point type — the same enum the EHR adapter layer uses","enum":["CELL_PHONE","HOME_PHONE","WORK_PHONE","EMAIL_ADDRESS"],"example":"CELL_PHONE","isRequired":true,"uniqueKey":"phones.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","example":"+13135550123","isRequired":true,"uniqueKey":"phones.items.[INDEX].value","typeLabel":"string"},"preferred":{"type":"boolean","description":"Unsupported. Omit this field; preferred-contact updates are not available.","deprecated":true,"uniqueKey":"phones.items.[INDEX].preferred","typeLabel":"boolean"}},"required":["type","value"],"uniqueKey":"phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"phones","typeLabel":"object[]"},"address":{"type":"object","properties":{"line1":{"type":"string","example":"1200 Miller Rd","isRequired":true,"uniqueKey":"address.line1","typeLabel":"string"},"city":{"type":"string","example":"Flint","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state code. The adapters translate to each vendor's form (EZDerm `FLORIDA`, ModMed `FL`).","example":"MI","isRequired":true,"uniqueKey":"address.state","typeLabel":"string"},"zip":{"type":"string","example":"48507","isRequired":true,"uniqueKey":"address.zip","typeLabel":"string"},"line2":{"type":"string","example":"Apt 4","uniqueKey":"address.line2","typeLabel":"string"},"country":{"type":"string","example":"US","uniqueKey":"address.country","typeLabel":"string"}},"required":["line1","city","state","zip"],"uniqueKey":"address","typeLabel":"object"},"primaryFacilityId":{"type":"string","description":"Facility UUID from `GET /facilities` (`fac_…` also accepted on v3+). Send the same value to `GET /payers?newChart=true` to pick this chart's payers before creating it.","uniqueKey":"primaryFacilityId","typeLabel":"string"},"checkForDuplicates":{"type":"boolean","description":"Ask the EHR to dedupe-check before committing. When candidates are found the write is WITHHELD and the response is 409 `duplicate_candidates` — surfacing that is what stops a booking flow creating duplicate charts.","example":true,"uniqueKey":"checkForDuplicates","typeLabel":"boolean"},"insurance":{"type":"object","properties":{"payerName":{"type":"string","example":"BCBS of Michigan","isRequired":true,"uniqueKey":"insurance.payerName","typeLabel":"string"},"memberId":{"type":"string","example":"XYZ123456","isRequired":true,"uniqueKey":"insurance.memberId","typeLabel":"string"},"groupNumber":{"type":"string","example":"0009","uniqueKey":"insurance.groupNumber","typeLabel":"string"},"subscriberRelationship":{"type":"string","description":"The policyholder's relationship to the patient. `SELF` (the default) means the patient is the policyholder. Anything else — `SPOUSE`, `CHILD`, … — REQUIRES the `subscriber*` fields below; without them the request is rejected with `subscriber_required` rather than writing a policy whose policyholder is unknown.","example":"SELF","uniqueKey":"insurance.subscriberRelationship","typeLabel":"string"},"subscriberFirstName":{"type":"string","description":"Policyholder's first name. Required when `subscriberRelationship` is not `SELF`.","example":"Robert","uniqueKey":"insurance.subscriberFirstName","typeLabel":"string"},"subscriberLastName":{"type":"string","description":"Policyholder's last name. Required when `subscriberRelationship` is not `SELF`.","example":"Doe","uniqueKey":"insurance.subscriberLastName","typeLabel":"string"},"subscriberDateOfBirth":{"type":"string","description":"Policyholder's date of birth, YYYY-MM-DD. Required when `subscriberRelationship` is not `SELF` — a claim identifies the subscriber by name AND date of birth, so a name alone still sends the biller back to the patient.","example":"1968-03-14","uniqueKey":"insurance.subscriberDateOfBirth","typeLabel":"string"},"subscriberSex":{"type":"string","description":"Policyholder's sex, as the payer knows it. A professional claim's 2010BA loop carries the subscriber's `DMG` demographics — date of birth AND gender — so omitting it leaves a correctable rejection on the table. NOT required: unlike name and date of birth, a missing gender does not make the policyholder unidentifiable, so it is never a reason to refuse the write.","enum":["M","F","U"],"example":"M","uniqueKey":"insurance.subscriberSex","typeLabel":"enum\u003cstring>"},"subscriberAddress":{"type":"object","description":"Policyholder's address, for the claim's 2010BA `N3`/`N4` segments. Omit and set `subscriberAddressSameAsPatient` instead when the policyholder lives with the patient — the common case for a spouse or dependant, and the one ModMed models natively.","required":["line1","city","state","zip"],"properties":{"line1":{"type":"string","example":"1200 Miller Rd","isRequired":true,"uniqueKey":"insurance.subscriberAddress.line1","typeLabel":"string"},"city":{"type":"string","example":"Flint","isRequired":true,"uniqueKey":"insurance.subscriberAddress.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state code. The adapters translate to each vendor's form (EZDerm `FLORIDA`, ModMed `FL`).","example":"MI","isRequired":true,"uniqueKey":"insurance.subscriberAddress.state","typeLabel":"string"},"zip":{"type":"string","example":"48507","isRequired":true,"uniqueKey":"insurance.subscriberAddress.zip","typeLabel":"string"},"line2":{"type":"string","example":"Apt 4","uniqueKey":"insurance.subscriberAddress.line2","typeLabel":"string"},"country":{"type":"string","example":"US","uniqueKey":"insurance.subscriberAddress.country","typeLabel":"string"}},"uniqueKey":"insurance.subscriberAddress","typeLabel":"object"},"subscriberAddressSameAsPatient":{"type":"boolean","description":"`true` when the policyholder lives at the patient's address. Maps to ModMed's own `policyHolderAddressSameAsPatients`, so the EHR resolves the address itself rather than us copying it and creating a second copy that can drift. Mutually exclusive with `subscriberAddress`; supplying both is rejected.","example":true,"uniqueKey":"insurance.subscriberAddressSameAsPatient","typeLabel":"boolean"},"planName":{"type":"string","description":"Plan name as printed on the card (e.g. `PPO Gold`). Previously always written as null; supply it when the card shows it.","example":"PPO Gold","uniqueKey":"insurance.planName","typeLabel":"string"}},"required":["payerName","memberId"],"uniqueKey":"insurance","typeLabel":"object"},"consents":{"type":"object","properties":{"callTextConsent":{"type":"boolean","description":"Patient consented to calls/texts","example":true,"isRequired":true,"uniqueKey":"consents.callTextConsent","typeLabel":"boolean"},"consentCapturedAt":{"type":"string","description":"When consent was captured (ISO-8601)","example":"2026-07-26T13:00:00Z","isRequired":true,"uniqueKey":"consents.consentCapturedAt","typeLabel":"string"}},"required":["callTextConsent","consentCapturedAt"],"uniqueKey":"consents","typeLabel":"object"}},"required":["firstName","lastName","dateOfBirth"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"firstName":"Jane","lastName":"Doe","dateOfBirth":"1984-02-11","middleName":"Marie","sex":"FEMALE","email":"jane@example.com","phones":[{"type":"CELL_PHONE","value":"+13135550123","preferred":true}],"primaryFacilityId":"\u003cstring>","checkForDuplicates":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"59f2edfe-1dfc-4379-b4c3-92114d38d1bd":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Response code","example":"success","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","properties":{"patient":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Max AI patient ID. `null` when the chart exists in the EHR but has not been mirrored yet — use `externalId` until the next patient sync lands.","example":"pat_c56103bcd39c46d39f3138dd2b5e05f6","isRequired":true,"uniqueKey":"data.patient.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Max AI patient ID. `null` when the chart exists in the EHR but has not been mirrored yet — use `externalId` until the next patient sync lands.","example":"pat_c56103bcd39c46d39f3138dd2b5e05f6","isRequired":true,"uniqueKey":"data.patient.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.patient.id","typeLabel":"string | null"},"externalId":{"type":"string","description":"The EHR's own patient identifier","example":"882731","isRequired":true,"uniqueKey":"data.patient.externalId","typeLabel":"string"},"instanceId":{"type":"string","description":"The EHR instance the chart was created in, as a raw UUID on every API version. Equal to instanceId on GET /payers records. Set even when id is null.","example":"3a7b9c1d-2e4f-45a6-8b0c-1d2e3f4a5b6c","isRequired":true,"uniqueKey":"data.patient.instanceId","typeLabel":"string"},"mrn":{"oneOf":[{"type":"string","example":"MM0000123456","isRequired":true,"uniqueKey":"data.patient.mrn.oneOf.0","typeLabel":"string"},{"type":"null","example":"MM0000123456","isRequired":true,"uniqueKey":"data.patient.mrn.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.patient.mrn","typeLabel":"string | null"},"created":{"type":"boolean","description":"Always `true` on a 2xx: this endpoint either creates a chart or refuses. When the EHR flags possible duplicates the request fails with 409 `duplicate_candidates` and the candidate ids, rather than returning an existing chart with `created: false` — so do not branch on this expecting a match case.","example":true,"isRequired":true,"uniqueKey":"data.patient.created","typeLabel":"boolean"},"insuranceAttached":{"oneOf":[{"type":"boolean","description":"Outcome of the optional `insurance` block. `null` when none was submitted, `true` when it reached the EHR, `false` when the chart was created but the coverage write failed — the chart is real and bookable either way, but on `false` the coverage is NOT on file and must be retried via POST /patients/{id}/insurance.","example":null,"isRequired":true,"uniqueKey":"data.patient.insuranceAttached.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Outcome of the optional `insurance` block. `null` when none was submitted, `true` when it reached the EHR, `false` when the chart was created but the coverage write failed — the chart is real and bookable either way, but on `false` the coverage is NOT on file and must be retried via POST /patients/{id}/insurance.","example":null,"isRequired":true,"uniqueKey":"data.patient.insuranceAttached.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.patient.insuranceAttached","typeLabel":"boolean | null"}},"required":["id","externalId","instanceId","mrn","created","insuranceAttached"],"isRequired":true,"uniqueKey":"data.patient","typeLabel":"object"},"duplicateCandidateIds":{"description":"Existing charts the EHR flagged as possible duplicates. Empty on a clean create.","example":[],"type":"array","items":{"type":"string","uniqueKey":"data.duplicateCandidateIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.duplicateCandidateIds","typeLabel":"string[]"}},"required":["patient","duplicateCandidateIds"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["code","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"success","data":{"patient":{"id":"pat_c56103bcd39c46d39f3138dd2b5e05f6","externalId":"882731","instanceId":"3a7b9c1d-2e4f-45a6-8b0c-1d2e3f4a5b6c","mrn":"MM0000123456","created":true,"insuranceAttached":null},"duplicateCandidateIds":[]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e32fb458-d37d-4a17-8de1-6c3879c462b2":{"description":"Missing or invalid request parameter","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"'id' must be a valid UUID","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"'id' must be a valid UUID","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"2ef4aaf5-fb37-4ac2-9166-4b0b7b95a898":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"unauthorized","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Invalid or missing API key","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unauthorized","message":"Invalid or missing API key","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"3150b8b8-0666-4364-9cc4-3f0848ab1191":{"description":"Insufficient scope","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"forbidden","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Insufficient scope","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"Insufficient scope","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"dc026f5a-9d2e-4880-9756-02a261884abb":{"description":"Resource conflict (e.g. editing a signed note)","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"conflict","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Cannot edit a signed note","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"conflict","message":"Cannot edit a signed note","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"dbcb4b0f-d844-4b71-9e79-9c1f8bc88cc1":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"rate_limit_exceeded","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Rate limit exceeded. Maximum 1000 requests per 60 seconds.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"rate_limit_exceeded","message":"Rate limit exceeded. Maximum 1000 requests per 60 seconds.","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"a8e1d0d6-b4e0-4a48-b53b-bafe33ac62d5":{"description":"EHR sync failed","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"unexpected_integration_error","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"EHR sync failed","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unexpected_integration_error","message":"EHR sync failed","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"},"4cae4ddf-281c-4686-bb3f-6a78bd96d2bf":{"description":"EHR integration unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Error code","example":"server_unresponsive","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"EHR integration is not available for this note","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"trace_id":{"type":"string","description":"Trace ID for debugging","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"trace_id","typeLabel":"string"}},"required":["code","message","trace_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"server_unresponsive","message":"EHR integration is not available for this note","trace_id":"550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a85b8de3-295c-453f-a601-e894cda1752e":{"api-key":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Marketplace API key","scopes":[],"schemeName":"api-key"}}},"servers":{"bda469ab-e693-49f0-97b1-e1f5f0dcb0ee":{"url":"https://api.maxcare.ai/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Marketplace API key","scopes":[],"schemeName":"api-key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Marketplace API key","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api-key","name":"Authorization"}],"title":"api-key"}]},"originalFileLocation":"openapi-v2.json"},"subdomain":"maxaiinc-02a56fd1","siteName":"Max AI Developer Docs","title":"Create a patient - Max AI Developer Docs","navMaps":{"firstHrefInVersion":{"v4":{"href":"/api-reference/v4/patients/create-a-patient","matchLevel":1},"v3":{"href":"/api-reference/v3/patients/create-a-patient","matchLevel":1},"v2":{"href":"/api-reference/v2/patients/create-a-patient","matchLevel":0},"v1":{"href":"/api-reference/v1/patients/create-a-patient","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T15:43:53.278Z","originalFileLocation":"api-reference/v2/patients/create-a-patient.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=\"Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Max AI Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a patient - Max AI Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Max AI Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://maxaiinc-02a56fd1.mintlify.site/_mintlify/api/og/v2?division=Patients\u0026amp;title=Create+a+patient\u0026amp;description=Creates+a+patient+chart+in+the+EHR.+With+%60checkForDuplicates%3A+true%60%2C+a+dedupe+hit+WITHHOLDS+the+write+and+returns+409+%60duplicate_candidates%60+with+the+candidate+\u0026amp;theme=02e0b3646d3b285707db65d5\u0026amp;signature=0536f3ec793ab466b5f864fc8d94291d64c3614e0628dc322460d461da06cfda\">\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=\"Create a patient - Max AI Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://maxaiinc-02a56fd1.mintlify.site/_mintlify/api/og/v2?division=Patients\u0026amp;title=Create+a+patient\u0026amp;description=Creates+a+patient+chart+in+the+EHR.+With+%60checkForDuplicates%3A+true%60%2C+a+dedupe+hit+WITHHOLDS+the+write+and+returns+409+%60duplicate_candidates%60+with+the+candidate+\u0026amp;theme=02e0b3646d3b285707db65d5\u0026amp;signature=0536f3ec793ab466b5f864fc8d94291d64c3614e0628dc322460d461da06cfda\">\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/maxaiinc-02a56fd1/qw7ccI6uMOHd5Iws/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Max AI Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/patients/create-a-patient.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.maxcare.ai/#organization\",\"name\":\"Max AI Developer Docs\",\"url\":\"https://docs.maxcare.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/maxaiinc-02a56fd1/3kDaJXdVQ62Q_li2/logo/logo.png?fit=max\u0026auto=format\u0026n=3kDaJXdVQ62Q_li2\u0026q=85\u0026s=593e8b0c409b58f620609de6e29ebb79\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.maxcare.ai#website\",\"name\":\"Max AI Developer Docs\",\"url\":\"https://docs.maxcare.ai\",\"publisher\":{\"@id\":\"https://docs.maxcare.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient#webpage\",\"url\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient\",\"name\":\"Create a patient\",\"description\":\"Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\",\"dateModified\":\"2026-11-06T15:43:53.278Z\",\"isPartOf\":{\"@id\":\"https://docs.maxcare.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.maxcare.ai/api-reference/v2/appointment-types/list-appointment-types\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Patients\",\"item\":\"https://docs.maxcare.ai/api-reference/v2/patients/where-each-document-category-is-filed\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a patient\",\"item\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient#apireference\",\"headline\":\"Create a patient\",\"name\":\"Create a patient\",\"description\":\"Creates a patient chart in the EHR. With checkForDuplicates: true, a dedupe hit WITHHOLDS the write and returns 409 duplicate_candidates with the candidate ids — review them and either book against an existing chart or retry without the flag. Send an Idempotency-Key header to protect retries for 24 hours. An uncertain vendor outcome returns 409 ehr_write_uncertain with requiresReconciliation: true; verify the chart in the EHR before attempting another create. The same key remains protected during that retention period.\",\"url\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient\",\"mainEntityOfPage\":{\"@id\":\"https://docs.maxcare.ai/api-reference/v2/patients/create-a-patient#webpage\"},\"dateModified\":\"2026-11-06T15:43:53.278Z\",\"publisher\":{\"@id\":\"https://docs.maxcare.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.maxcare.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Max AI Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Max AI Developer Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"API Reference","versions":[{"version":"v4","tag":"Latest","pages":[{"title":"v4","href":"/api-reference/v4/patients/create-a-patient"}]},{"version":"v3","pages":[{"title":"v3","href":"/api-reference/v3/patients/create-a-patient"}]},{"version":"v2","groups":[{"group":"API Reference","pages":[{"group":"Appointment Types","pages":[{"title":"List appointment types","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /appointment-types","href":"/api-reference/v2/appointment-types/list-appointment-types"}]},{"group":"Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /appointments","href":"/api-reference/v2/appointments/list-appointments"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /appointments","href":"/api-reference/v2/appointments/book-an-appointment"},{"title":"List cancellation reasons","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /appointments/cancel-reasons","href":"/api-reference/v2/appointments/list-cancellation-reasons"},{"title":"List appointment statuses","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /appointments/statuses","href":"/api-reference/v2/appointments/list-appointment-statuses"},{"title":"Get appointment by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /appointments/{id}","href":"/api-reference/v2/appointments/get-appointment-by-id"},{"title":"Reschedule an appointment","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /appointments/{id}","href":"/api-reference/v2/appointments/reschedule-an-appointment"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /appointments/{id}/cancel","href":"/api-reference/v2/appointments/cancel-an-appointment"}]},{"group":"Bills","pages":[{"title":"List bills","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /bills","href":"/api-reference/v2/bills/list-bills"},{"title":"Get bill by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /bills/{id}","href":"/api-reference/v2/bills/get-bill-by-id"}]},{"group":"Cancel Reasons","pages":[{"title":"List appointment cancellation reasons","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /cancel-reasons","href":"/api-reference/v2/cancel-reasons/list-appointment-cancellation-reasons"}]},{"group":"Claims","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /claims","href":"/api-reference/v2/claims/list-claims"},{"title":"Get claim by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /claims/{id}","href":"/api-reference/v2/claims/get-claim-by-id"}]},{"group":"Patients","pages":[{"title":"Where each document category is filed","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /documents/categories","href":"/api-reference/v2/patients/where-each-document-category-is-filed"},{"title":"List patients","description":"Returns a paginated list of patients. Requires read:patients scope.","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients","href":"/api-reference/v2/patients/list-patients"},{"title":"Create a patient","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients","href":"/api-reference/v2/patients/create-a-patient"},{"title":"Match a patient by demographics","description":"Scores existing charts against submitted demographics and returns ranked candidates. Use this before creating a chart: `GET /patients?search=` matches name or MRN only, so matching from a booking form otherwise means paging every candidate surname — which either exhausts the rate budget or truncates, and a truncated match creates a duplicate chart. Candidates are found by `dateOfBirth`, `phone` (at least 7 digits) or `email` — at least one is required, otherwise 400. Names and postal code are scored but never used alone to find candidates. Send `matchOn` (e.g. `[\"lastName\", \"dateOfBirth\"]`) to require those fields to agree instead of matching any one identifier. `truncated: true` means the candidate set was capped and MUST NOT be read as 'no match'.","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/match","href":"/api-reference/v2/patients/match-a-patient-by-demographics"},{"title":"Get patient by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients/{id}","href":"/api-reference/v2/patients/get-patient-by-id"},{"title":"Update a patient","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /patients/{id}","href":"/api-reference/v2/patients/update-a-patient"},{"title":"List a patient's allergies","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients/{id}/allergies","href":"/api-reference/v2/patients/list-a-patients-allergies"},{"title":"List a patient's chart documents","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients/{id}/documents","href":"/api-reference/v2/patients/list-a-patients-chart-documents"},{"title":"File a document on a patient's chart","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/documents","href":"/api-reference/v2/patients/file-a-document-on-a-patients-chart"},{"title":"Refresh a patient's chart-document list","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/documents/refresh","href":"/api-reference/v2/patients/refresh-a-patients-chart-document-list"},{"title":"Download one chart document's bytes","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients/{id}/documents/{documentId}/content","href":"/api-reference/v2/patients/download-one-chart-documents-bytes"},{"title":"Pull one chart document's bytes from the EHR","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/documents/{documentId}/fetch","href":"/api-reference/v2/patients/pull-one-chart-documents-bytes-from-the-ehr"},{"title":"Attach insurance to an existing patient","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/insurance","href":"/api-reference/v2/patients/attach-insurance-to-an-existing-patient"},{"title":"Attach an insurance card image","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/insurance/cards","href":"/api-reference/v2/patients/attach-an-insurance-card-image"},{"title":"Attach insurance with an exact payer","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /patients/{id}/insurance:exact","href":"/api-reference/v2/patients/attach-insurance-with-an-exact-payer"},{"title":"List a patient's lab / pathology results","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /patients/{id}/lab-results","href":"/api-reference/v2/patients/list-a-patients-lab-pathology-results"},{"title":"Set a patient's referring provider","deprecated":null,"version":null,"openapi":"/openapi-v2.json put /patients/{id}/referring-provider","href":"/api-reference/v2/patients/set-a-patients-referring-provider"},{"title":"Change an insurance policy's type","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /patients/{patientId}/insurance-policies/{policyId}","href":"/api-reference/v2/patients/change-an-insurance-policys-type"}]},{"group":"Eligibility Checks","pages":[{"title":"List eligibility checks","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /eligibility-checks","href":"/api-reference/v2/eligibility-checks/list-eligibility-checks"},{"title":"Run an eligibility check","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /eligibility-checks","href":"/api-reference/v2/eligibility-checks/run-an-eligibility-check"},{"title":"Get eligibility check by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /eligibility-checks/{id}","href":"/api-reference/v2/eligibility-checks/get-eligibility-check-by-id"}]},{"group":"Emails","pages":[{"title":"List sent emails","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /emails","href":"/api-reference/v2/emails/list-sent-emails"},{"title":"Send emails","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /emails/send","href":"/api-reference/v2/emails/send-emails"},{"title":"Get email by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /emails/{id}","href":"/api-reference/v2/emails/get-email-by-id"}]},{"group":"ERA Service Lines","pages":[{"title":"List ERA service lines","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /era-service-lines","href":"/api-reference/v2/era-service-lines/list-era-service-lines"},{"title":"Get ERA service line by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /era-service-lines/{id}","href":"/api-reference/v2/era-service-lines/get-era-service-line-by-id"}]},{"group":"Facilities","pages":[{"title":"List facilities","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /facilities","href":"/api-reference/v2/facilities/list-facilities"},{"title":"Get facility by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /facilities/{id}","href":"/api-reference/v2/facilities/get-facility-by-id"}]},{"group":"Faxes","pages":[{"title":"List faxes","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /faxes","href":"/api-reference/v2/faxes/list-faxes"},{"title":"Send a fax","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /faxes/send","href":"/api-reference/v2/faxes/send-a-fax"},{"title":"List fax cover-page templates","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /faxes/templates","href":"/api-reference/v2/faxes/list-fax-cover-page-templates"},{"title":"Get fax by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /faxes/{id}","href":"/api-reference/v2/faxes/get-fax-by-id"}]},{"group":"Insurance Policies","pages":[{"title":"List insurance policies","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /insurance-policies","href":"/api-reference/v2/insurance-policies/list-insurance-policies"},{"title":"Get insurance policy by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /insurance-policies/{id}","href":"/api-reference/v2/insurance-policies/get-insurance-policy-by-id"},{"title":"List a policy's insurance card images","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /insurance-policies/{id}/attachments","href":"/api-reference/v2/insurance-policies/list-a-policys-insurance-card-images"}]},{"group":"Inventory","pages":[{"title":"List inventory changes","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/changes","href":"/api-reference/v2/inventory/list-inventory-changes"},{"title":"Get inventory change by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/changes/{id}","href":"/api-reference/v2/inventory/get-inventory-change-by-id"},{"title":"List products in an inventory change","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/changes/{id}/products","href":"/api-reference/v2/inventory/list-products-in-an-inventory-change"},{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/products","href":"/api-reference/v2/inventory/list-products"},{"title":"Get product by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/products/{id}","href":"/api-reference/v2/inventory/get-product-by-id"},{"title":"Get stock levels","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/stock-levels","href":"/api-reference/v2/inventory/get-stock-levels"},{"title":"Get stock levels with per-lot breakdown","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /inventory/stock-levels/detail","href":"/api-reference/v2/inventory/get-stock-levels-with-per-lot-breakdown"}]},{"group":"Marketplace","pages":[{"title":"List this app's installations","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /marketplace/installations","href":"/api-reference/v2/marketplace/list-this-apps-installations"},{"title":"Get current app context","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /marketplace/me","href":"/api-reference/v2/marketplace/get-current-app-context"},{"title":"List the organization's members","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /marketplace/members","href":"/api-reference/v2/marketplace/list-the-organizations-members"},{"title":"Verify a session token and resolve its organization","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /marketplace/verify-session","href":"/api-reference/v2/marketplace/verify-a-session-token-and-resolve-its-organization"}]},{"group":"Notes","pages":[{"title":"List patient notes","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /notes","href":"/api-reference/v2/notes/list-patient-notes"},{"title":"Get note by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /notes/{id}","href":"/api-reference/v2/notes/get-note-by-id"},{"title":"Edit SOAP note fields","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /notes/{noteId}","href":"/api-reference/v2/notes/edit-soap-note-fields"},{"title":"Upload image to note","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /notes/{noteId}/images","href":"/api-reference/v2/notes/upload-image-to-note"},{"title":"Delete image from note","deprecated":null,"version":null,"openapi":"/openapi-v2.json delete /notes/{noteId}/images/{imageId}","href":"/api-reference/v2/notes/delete-image-from-note"},{"title":"Get signed URL for a note image","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /notes/{noteId}/images/{imageId}/url","href":"/api-reference/v2/notes/get-signed-url-for-a-note-image"},{"title":"Edit impression fields","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /notes/{noteId}/impressions/{impressionId}","href":"/api-reference/v2/notes/edit-impression-fields"}]},{"group":"OAuth","pages":[{"title":"Exchange authorization code for user info","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /oauth/token","href":"/api-reference/v2/oauth/exchange-authorization-code-for-user-info"}]},{"group":"Organization","pages":[{"title":"List the organization's members","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /org/members","href":"/api-reference/v2/organization/list-the-organizations-members"}]},{"group":"Payers","pages":[{"title":"Search payers","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /payers","href":"/api-reference/v2/payers/search-payers"},{"title":"Add a directory payer to the practice","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /payers","href":"/api-reference/v2/payers/add-a-directory-payer-to-the-practice"},{"title":"Payer capabilities","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /payers/capabilities","href":"/api-reference/v2/payers/payer-capabilities"},{"title":"Search the EHR's national payer directory","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /payers/directory","href":"/api-reference/v2/payers/search-the-ehrs-national-payer-directory"},{"title":"Get payer by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /payers/{id}","href":"/api-reference/v2/payers/get-payer-by-id"}]},{"group":"Phone Numbers","pages":[{"title":"List organization phone numbers","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /phone-numbers","href":"/api-reference/v2/phone-numbers/list-organization-phone-numbers"}]},{"group":"Prior Authorizations","pages":[{"title":"List prior authorizations","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /prior-authorizations","href":"/api-reference/v2/prior-authorizations/list-prior-authorizations"},{"title":"Get prior authorization by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /prior-authorizations/{id}","href":"/api-reference/v2/prior-authorizations/get-prior-authorization-by-id"},{"title":"List source documents for a prior authorization","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /prior-authorizations/{id}/documents","href":"/api-reference/v2/prior-authorizations/list-source-documents-for-a-prior-authorization"}]},{"group":"Providers","pages":[{"title":"List providers","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /providers","href":"/api-reference/v2/providers/list-providers"},{"title":"Get provider by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /providers/{id}","href":"/api-reference/v2/providers/get-provider-by-id"}]},{"group":"Schedule","pages":[{"title":"List appointment types","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/appointment-types","href":"/api-reference/v2/schedule/list-appointment-types"},{"title":"List availability templates","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/availability-templates","href":"/api-reference/v2/schedule/list-availability-templates"},{"title":"List calendar events","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/calendar-events","href":"/api-reference/v2/schedule/list-calendar-events"},{"title":"What this organization's EHR supports","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/capabilities","href":"/api-reference/v2/schedule/what-this-organizations-ehr-supports"},{"title":"Search the EHR's appointment finder","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/finder","href":"/api-reference/v2/schedule/search-the-ehrs-appointment-finder"},{"title":"Providers and facilities that take an appointment type","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/finder/provider-locations","href":"/api-reference/v2/schedule/providers-and-facilities-that-take-an-appointment-type"},{"title":"Hold a slot","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /schedule/holds","href":"/api-reference/v2/schedule/hold-a-slot"},{"title":"Release a slot hold","deprecated":null,"version":null,"openapi":"/openapi-v2.json delete /schedule/holds/{holdId}","href":"/api-reference/v2/schedule/release-a-slot-hold"},{"title":"Find bookable slots","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /schedule/slots","href":"/api-reference/v2/schedule/find-bookable-slots"},{"title":"List visit reasons","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /visit-reasons","href":"/api-reference/v2/schedule/list-visit-reasons"}]},{"group":"Sync Requests","pages":[{"title":"Request a re-sync of a resource with the EHR","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /sync-requests","href":"/api-reference/v2/sync-requests/request-a-re-sync-of-a-resource-with-the-ehr"},{"title":"Request a re-sync of several resources in one call","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /sync-requests/batch","href":"/api-reference/v2/sync-requests/request-a-re-sync-of-several-resources-in-one-call"},{"title":"Get a sync request by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /sync-requests/{id}","href":"/api-reference/v2/sync-requests/get-a-sync-request-by-id"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /tasks","href":"/api-reference/v2/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi-v2.json post /tasks","href":"/api-reference/v2/tasks/create-a-task"},{"title":"List task assignee groups","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /tasks/assignee-groups","href":"/api-reference/v2/tasks/list-task-assignee-groups"},{"title":"List task assignees","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /tasks/assignees","href":"/api-reference/v2/tasks/list-task-assignees"},{"title":"Task capabilities","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /tasks/capabilities","href":"/api-reference/v2/tasks/task-capabilities"},{"title":"Get task by ID","deprecated":null,"version":null,"openapi":"/openapi-v2.json get /tasks/{id}","href":"/api-reference/v2/tasks/get-task-by-id"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"/openapi-v2.json patch /tasks/{id}","href":"/api-reference/v2/tasks/update-task-status"}]}]}]},{"version":"v1","pages":[{"title":"v1","href":"/api-reference/v1/patients/create-a-patient"}]}]}]},"basePath":"","title":"Create a patient - Max AI Developer Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}