{
"message": "Internal server error",
"statusCode": 500
}
Patients
Match Patient
Find a patient at the practice from identifying details.
Which fields are required depends on the practice’s match rules. If the request doesn’t have enough fields, the response has status: "insufficient-information" and lists the fields each rule needs.
On status: "matched", patient.patient_id is the ID to pass to GET /patient/{id}/chart.
How Clarion handled several records that look like the same patient. Present only when more than one record matched equally well.
Available options:
selected-upcoming,
undecided-multiple-upcoming,
selected-past,
undecided-multiple-past,
undecided-no-history,
not-duplicates,
warning,
error
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Clarion API","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://d2d1vpa6c3q6ni.cloudfront.net/clarion-logo-light.png","dark":"https://d2d1vpa6c3q6ni.cloudfront.net/clarion-logo-dark.png"},"favicon":"https://mintcdn.com/clarion/LohR-Vtn8idHO0Sy/logo/clarion-favicon.png?fit=max\u0026auto=format\u0026n=LohR-Vtn8idHO0Sy\u0026q=85\u0026s=2ad90c0c9ebe52f7e24aef996609c388","api":{"openapi":["api-reference/openapi.json"]},"navbar":{"links":[{"href":"mailto:support@clarionhealth.com","label":"Support"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/98996497"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clarion","hasAudioNarration":false,"actualSubdomain":"clarion","customDomains":["docs.clarionhealth.com"],"gitSource":{"type":"github","owner":"clarion-health","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ace485232c0121d67d67ffb","collectionId":"74015fc5-6cbf-4835-bbdb-d8c1f023417d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ace485232c0121d67d67ffb"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0db7b9eb684fb68b79711","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"Verification of Benefits","count":4},{"language":"default","tag":"Sequences","count":4},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Calls","count":3},{"language":"default","tag":"Patients","count":2},{"language":"default","tag":"Phone Numbers","count":2},{"language":"default","tag":"Sequence Definitions","count":2},{"language":"default","tag":"Health","count":1},{"language":"default","tag":"Quickstart","count":1}]},"assistantConfig":{},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/patient/match","slug":"/api-reference/patient/match","pageMetadata":{"title":"Match Patient","openapi":"POST /patient/match","description":"Find a patient at the practice from identifying details.\n\nWhich fields are required depends on the practice's match rules. If the request doesn't have enough fields, the response has `status: \"insufficient-information\"` and lists the fields each rule needs.\n\nOn `status: \"matched\"`, `patient.patient_id` is the ID to pass to `GET /patient/{id}/chart`.","href":"/api-reference/patient/match"},"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 ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Find a patient at the practice from identifying details.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Which fields are required depends on the practice’s match rules. If the request doesn’t have enough fields, the response has \", _jsx(_components.code, {\n children: \"status: \\\"insufficient-information\\\"\"\n }), \" and lists the fields each rule needs.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"On \", _jsx(_components.code, {\n children: \"status: \\\"matched\\\"\"\n }), \", \", _jsx(_components.code, {\n children: \"patient.patient_id\"\n }), \" is the ID to pass to \", _jsx(_components.code, {\n children: \"GET /patient/{id}/chart\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Match Patient","openapi":"POST /patient/match","description":"Find a patient at the practice from identifying details.\n\nWhich fields are required depends on the practice's match rules. If the request doesn't have enough fields, the response has `status: \"insufficient-information\"` and lists the fields each rule needs.\n\nOn `status: \"matched\"`, `patient.patient_id` is the ID to pass to `GET /patient/{id}/chart`.","href":"/api-reference/patient/match"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Find a patient at the practice from identifying details.\n\nWhich fields are required depends on the practice's match rules. If the request doesn't have enough fields, the response has `status: \"insufficient-information\"` and lists the fields each rule needs.\n\nOn `status: \"matched\"`, `patient.patient_id` is the ID to pass to `GET /patient/{id}/chart`.","requestBody":"3052368f-49bd-44dd-aa6e-ce548c85b548","responses":{"201":"62e14362-5000-4870-8b20-a41287ea984e","400":"f0024e82-3895-438d-ab04-be3b4241bbac","500":"e5e54224-2452-4d5c-9eee-187161f10e26"},"method":"post","type":"path","servers":["39f0e6bd-674f-4cd5-a6bf-bd46a30985c4"],"security":["ca6f5ff3-3188-448f-b82b-843c7c03a996"],"path":"/patient/match","baseUrlOptions":["https://api.clarionhealth.com/v1"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"first_name":{"type":"string","description":"Patient's first name","example":"Jane","uniqueKey":"first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Patient's last name","example":"Doe","uniqueKey":"last_name","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"date_of_birth","typeLabel":"string\u003cdate>"},"phone_number":{"type":"string","description":"Patient's phone number. US numbers in any common format are accepted.","example":"(555) 555-0123","uniqueKey":"phone_number","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"first_name":"Jane","last_name":"Doe","date_of_birth":"1990-01-01","phone_number":"(555) 555-0123"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"62e14362-5000-4870-8b20-a41287ea984e":{"description":"The match outcome","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Matched","description":"The outcome of a patient match. Branch on `status`.","required":["status","patient"],"properties":{"status":{"type":"string","enum":["matched"],"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"patient":{"type":"object","description":"A Clarion patient record returned by a patient match.","properties":{"patient_id":{"type":"integer","description":"Clarion's ID for the patient. Use it with `GET /patient/{id}/chart`.","example":12345,"uniqueKey":"oneOf.0.patient.patient_id","typeLabel":"integer"},"confidence":{"oneOf":[{"type":"number","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.0.patient.confidence.oneOf.0","typeLabel":"number"},{"type":"null","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.0.patient.confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.confidence","typeLabel":"number | null"},"scores":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.0.patient.scores.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.0.patient.scores.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.scores","typeLabel":"object | null"},"scored_fields":{"oneOf":[{"type":"object","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.0.patient.scored_fields.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.0.patient.scored_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.scored_fields","typeLabel":"object | null"},"first_name":{"oneOf":[{"type":"string","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.0.patient.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.0.patient.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.first_name","typeLabel":"string | null"},"secondary_first_name":{"oneOf":[{"type":"string","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.0.patient.secondary_first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.0.patient.secondary_first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.secondary_first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.0.patient.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.0.patient.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.last_name","typeLabel":"string | null"},"mrn":{"oneOf":[{"type":"string","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.0.patient.mrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.0.patient.mrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.mrn","typeLabel":"string | null"},"date_of_birth":{"oneOf":[{"type":"string","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.0.patient.date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.0.patient.date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.date_of_birth","typeLabel":"string\u003cdate> | null"},"cell_number":{"oneOf":[{"type":"string","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.0.patient.cell_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.0.patient.cell_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.cell_number","typeLabel":"string | null"},"home_number":{"oneOf":[{"type":"string","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.0.patient.home_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.0.patient.home_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.home_number","typeLabel":"string | null"},"work_number":{"oneOf":[{"type":"string","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.0.patient.work_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.0.patient.work_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.work_number","typeLabel":"string | null"},"last_called_from_number":{"oneOf":[{"type":"string","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.0.patient.last_called_from_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.0.patient.last_called_from_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.patient.last_called_from_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.patient","typeLabel":"object"},"indistinguishable_resolution":{"type":"string","description":"How Clarion handled several records that look like the same patient. Present only when more than one record matched equally well.","enum":["selected-upcoming","undecided-multiple-upcoming","selected-past","undecided-multiple-past","undecided-no-history","not-duplicates","warning","error"],"uniqueKey":"oneOf.0.indistinguishable_resolution","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0","typeLabel":"Matched · object"},{"type":"object","title":"Ambiguous","description":"The outcome of a patient match. Branch on `status`.","required":["status","candidates"],"properties":{"status":{"type":"string","enum":["ambiguous"],"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"candidates":{"type":"array","items":{"type":"object","description":"A Clarion patient record returned by a patient match.","properties":{"patient_id":{"type":"integer","description":"Clarion's ID for the patient. Use it with `GET /patient/{id}/chart`.","example":12345,"uniqueKey":"oneOf.1.candidates.items.[INDEX].patient_id","typeLabel":"integer"},"confidence":{"oneOf":[{"type":"number","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.1.candidates.items.[INDEX].confidence.oneOf.0","typeLabel":"number"},{"type":"null","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.1.candidates.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].confidence","typeLabel":"number | null"},"scores":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.1.candidates.items.[INDEX].scores.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.1.candidates.items.[INDEX].scores.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].scores","typeLabel":"object | null"},"scored_fields":{"oneOf":[{"type":"object","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.1.candidates.items.[INDEX].scored_fields.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.1.candidates.items.[INDEX].scored_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].scored_fields","typeLabel":"object | null"},"first_name":{"oneOf":[{"type":"string","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.1.candidates.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.1.candidates.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].first_name","typeLabel":"string | null"},"secondary_first_name":{"oneOf":[{"type":"string","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.1.candidates.items.[INDEX].secondary_first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.1.candidates.items.[INDEX].secondary_first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].secondary_first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.1.candidates.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.1.candidates.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].last_name","typeLabel":"string | null"},"mrn":{"oneOf":[{"type":"string","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.1.candidates.items.[INDEX].mrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.1.candidates.items.[INDEX].mrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].mrn","typeLabel":"string | null"},"date_of_birth":{"oneOf":[{"type":"string","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.1.candidates.items.[INDEX].date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.1.candidates.items.[INDEX].date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate> | null"},"cell_number":{"oneOf":[{"type":"string","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.1.candidates.items.[INDEX].cell_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.1.candidates.items.[INDEX].cell_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].cell_number","typeLabel":"string | null"},"home_number":{"oneOf":[{"type":"string","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].home_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].home_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].home_number","typeLabel":"string | null"},"work_number":{"oneOf":[{"type":"string","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].work_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].work_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].work_number","typeLabel":"string | null"},"last_called_from_number":{"oneOf":[{"type":"string","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].last_called_from_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.1.candidates.items.[INDEX].last_called_from_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.candidates.items.[INDEX].last_called_from_number","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.candidates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.candidates","typeLabel":"object[]"}},"uniqueKey":"oneOf.1","typeLabel":"Ambiguous · object"},{"type":"object","title":"Indistinguishable","description":"The outcome of a patient match. Branch on `status`.","required":["status","candidates"],"properties":{"status":{"type":"string","enum":["indistinguishable"],"isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"candidates":{"type":"array","items":{"type":"object","description":"A Clarion patient record returned by a patient match.","properties":{"patient_id":{"type":"integer","description":"Clarion's ID for the patient. Use it with `GET /patient/{id}/chart`.","example":12345,"uniqueKey":"oneOf.2.candidates.items.[INDEX].patient_id","typeLabel":"integer"},"confidence":{"oneOf":[{"type":"number","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.2.candidates.items.[INDEX].confidence.oneOf.0","typeLabel":"number"},{"type":"null","description":"Overall match confidence, from 0 to 100","example":100,"uniqueKey":"oneOf.2.candidates.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].confidence","typeLabel":"number | null"},"scores":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.2.candidates.items.[INDEX].scores.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Per-field match scores","uniqueKey":"oneOf.2.candidates.items.[INDEX].scores.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].scores","typeLabel":"object | null"},"scored_fields":{"oneOf":[{"type":"object","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.2.candidates.items.[INDEX].scored_fields.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"The fields that contributed to the match score","uniqueKey":"oneOf.2.candidates.items.[INDEX].scored_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].scored_fields","typeLabel":"object | null"},"first_name":{"oneOf":[{"type":"string","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.2.candidates.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's first name","example":"Jane","uniqueKey":"oneOf.2.candidates.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].first_name","typeLabel":"string | null"},"secondary_first_name":{"oneOf":[{"type":"string","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.2.candidates.items.[INDEX].secondary_first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's preferred or alternate first name","uniqueKey":"oneOf.2.candidates.items.[INDEX].secondary_first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].secondary_first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.2.candidates.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's last name","example":"Doe","uniqueKey":"oneOf.2.candidates.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].last_name","typeLabel":"string | null"},"mrn":{"oneOf":[{"type":"string","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.2.candidates.items.[INDEX].mrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's medical record number in the practice's EHR","example":"MRN-001","uniqueKey":"oneOf.2.candidates.items.[INDEX].mrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].mrn","typeLabel":"string | null"},"date_of_birth":{"oneOf":[{"type":"string","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.2.candidates.items.[INDEX].date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Patient's date of birth in YYYY-MM-DD format","example":"1990-01-01","uniqueKey":"oneOf.2.candidates.items.[INDEX].date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate> | null"},"cell_number":{"oneOf":[{"type":"string","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.2.candidates.items.[INDEX].cell_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's cell phone number in E.164 format","example":"+15555550123","uniqueKey":"oneOf.2.candidates.items.[INDEX].cell_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].cell_number","typeLabel":"string | null"},"home_number":{"oneOf":[{"type":"string","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].home_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's home phone number in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].home_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].home_number","typeLabel":"string | null"},"work_number":{"oneOf":[{"type":"string","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].work_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Patient's work phone number in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].work_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].work_number","typeLabel":"string | null"},"last_called_from_number":{"oneOf":[{"type":"string","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].last_called_from_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number the patient last called Clarion from, in E.164 format","uniqueKey":"oneOf.2.candidates.items.[INDEX].last_called_from_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.candidates.items.[INDEX].last_called_from_number","typeLabel":"string | null"}},"uniqueKey":"oneOf.2.candidates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.2.candidates","typeLabel":"object[]"},"indistinguishable_resolution":{"type":"string","description":"How Clarion handled several records that look like the same patient. Present only when more than one record matched equally well.","enum":["selected-upcoming","undecided-multiple-upcoming","selected-past","undecided-multiple-past","undecided-no-history","not-duplicates","warning","error"],"uniqueKey":"oneOf.2.indistinguishable_resolution","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2","typeLabel":"Indistinguishable · object"},{"type":"object","title":"Insufficient information","description":"The outcome of a patient match. Branch on `status`.","required":["status","missingFields"],"properties":{"status":{"type":"string","enum":["insufficient-information"],"isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"enum\u003cstring>"},"missingFields":{"type":"array","description":"For each of the practice's match rules, the fields that rule still needs. Supplying every field in any one group makes the match possible.","items":{"type":"array","items":{"type":"string","enum":["first_name","last_name","date_of_birth","phone_number"],"uniqueKey":"oneOf.3.missingFields.items.[INDEX].items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"oneOf.3.missingFields.items.[INDEX]","typeLabel":"enum\u003cstring>[]"},"example":[["first_name","last_name","date_of_birth"]],"isRequired":true,"uniqueKey":"oneOf.3.missingFields","typeLabel":"enum\u003cstring>[][]"}},"uniqueKey":"oneOf.3","typeLabel":"Insufficient information · object"},{"type":"object","title":"No match","description":"The outcome of a patient match. Branch on `status`.","required":["status"],"properties":{"status":{"type":"string","enum":["no-match"],"isRequired":true,"uniqueKey":"oneOf.4.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4","typeLabel":"No match · object"}],"uniqueKey":"","typeLabel":"Matched · object | Ambiguous · object | Indistinguishable · object | Insufficient information · object | No match · object"},"examples":{"Example":{"title":"Example","value":{"status":"matched","patient":{"patient_id":12345,"confidence":100,"scores":{},"scored_fields":{},"first_name":"Jane","secondary_first_name":"\u003cstring>","last_name":"Doe","mrn":"MRN-001","date_of_birth":"1990-01-01","cell_number":"+15555550123","home_number":"\u003cstring>","work_number":"\u003cstring>","last_called_from_number":"\u003cstring>"},"indistinguishable_resolution":"selected-upcoming"}}},"exampleType":"generated"}},"exampleType":"generated"},"f0024e82-3895-438d-ab04-be3b4241bbac":{"description":"Invalid request, such as an unknown field or a malformed phone number or date","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","example":"Invalid phone number","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","description":"Error code identifying the type of error","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Invalid phone number","statusCode":400,"error":"Bad Request"}}},"exampleType":"generated"}},"exampleType":"generated"},"e5e54224-2452-4d5c-9eee-187161f10e26":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"}},"required":["message","statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error","statusCode":500}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ca6f5ff3-3188-448f-b82b-843c7c03a996":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"39f0e6bd-674f-4cd5-a6bf-bd46a30985c4":{"url":"https://api.clarionhealth.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"clarion","siteName":"Clarion API","title":"Match Patient - Clarion API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T17:13:15.121Z","originalFileLocation":"api-reference/patient/match.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=\"Find a patient at the practice from identifying details. Which fields are required depends on the practice\u0026#x27;s match rules. If the request doesn\u0026#x27;t have enough fields, the response has status: \u0026quot;insufficient-information\u0026quot; and lists the fields each rule needs. On status: \u0026quot;matched\u0026quot;, patient.patient_id is the ID to pass to GET /patient/{id}/chart.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Clarion 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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_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/clarion/-oCv51D8vmwyqWTE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Match Patient - Clarion API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Find a patient at the practice from identifying details. Which fields are required depends on the practice\u0026#x27;s match rules. If the request doesn\u0026#x27;t have enough fields, the response has status: \u0026quot;insufficient-information\u0026quot; and lists the fields each rule needs. On status: \u0026quot;matched\u0026quot;, patient.patient_id is the ID to pass to GET /patient/{id}/chart.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Clarion API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clarionhealth.com/api-reference/patient/match\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clarion.mintlify.app/_mintlify/api/og/v2?division=Patients\u0026amp;title=Match+Patient\u0026amp;description=Find+a+patient+at+the+practice+from+identifying+details.%0A%0AWhich+fields+are+required+depends+on+the+practice%27s+match+rules.+If+the+request+doesn%27t+have+enough+fi\u0026amp;theme=61607d75af0ea8460b4dbbb5\u0026amp;signature=ce99f188bb44e4b61b11994675f8d656d681898d082671023877f571633078f2\">\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=\"Match Patient - Clarion API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Find a patient at the practice from identifying details. Which fields are required depends on the practice\u0026#x27;s match rules. If the request doesn\u0026#x27;t have enough fields, the response has status: \u0026quot;insufficient-information\u0026quot; and lists the fields each rule needs. On status: \u0026quot;matched\u0026quot;, patient.patient_id is the ID to pass to GET /patient/{id}/chart.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clarion.mintlify.app/_mintlify/api/og/v2?division=Patients\u0026amp;title=Match+Patient\u0026amp;description=Find+a+patient+at+the+practice+from+identifying+details.%0A%0AWhich+fields+are+required+depends+on+the+practice%27s+match+rules.+If+the+request+doesn%27t+have+enough+fi\u0026amp;theme=61607d75af0ea8460b4dbbb5\u0026amp;signature=ce99f188bb44e4b61b11994675f8d656d681898d082671023877f571633078f2\">\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/clarion/-oCv51D8vmwyqWTE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Clarion API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clarionhealth.com/api-reference/patient/match\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/patient/match.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clarionhealth.com/#organization\",\"name\":\"Clarion API\",\"url\":\"https://docs.clarionhealth.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://d2d1vpa6c3q6ni.cloudfront.net/clarion-logo-light.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clarionhealth.com#website\",\"name\":\"Clarion API\",\"url\":\"https://docs.clarionhealth.com\",\"publisher\":{\"@id\":\"https://docs.clarionhealth.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clarionhealth.com/api-reference/patient/match#webpage\",\"url\":\"https://docs.clarionhealth.com/api-reference/patient/match\",\"name\":\"Match Patient\",\"description\":\"Find a patient at the practice from identifying details. Which fields are required depends on the practice's match rules. If the request doesn't have enough fields, the response has status: \\\"insufficient-information\\\" and lists the fields each rule needs. On status: \\\"matched\\\", patient.patient_id is the ID to pass to GET /patient/{id}/chart.\",\"dateModified\":\"2026-10-27T17:13:15.121Z\",\"isPartOf\":{\"@id\":\"https://docs.clarionhealth.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clarionhealth.com/api-reference/patient/match#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clarionhealth.com/api-reference/patient/match#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Clarion API\",\"item\":\"https://docs.clarionhealth.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Match Patient\",\"item\":\"https://docs.clarionhealth.com/api-reference/patient/match\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clarionhealth.com/api-reference/patient/match#apireference\",\"headline\":\"Match Patient\",\"name\":\"Match Patient\",\"description\":\"Find a patient at the practice from identifying details. Which fields are required depends on the practice's match rules. If the request doesn't have enough fields, the response has status: \\\"insufficient-information\\\" and lists the fields each rule needs. On status: \\\"matched\\\", patient.patient_id is the ID to pass to GET /patient/{id}/chart.\",\"url\":\"https://docs.clarionhealth.com/api-reference/patient/match\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clarionhealth.com/api-reference/patient/match#webpage\"},\"dateModified\":\"2026-10-27T17:13:15.121Z\",\"publisher\":{\"@id\":\"https://docs.clarionhealth.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clarionhealth.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Clarion API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Clarion API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Quickstart","pages":[{"title":"Quickstart","href":"/api-reference/introduction"}]},{"group":"Health","pages":[{"title":"Get Health","openapi":"GET /health","href":"/api-reference/health/get"}]},{"group":"Calls","pages":[{"title":"Get Call","openapi":"GET /call/{callId}","href":"/api-reference/call/get-single"},{"title":"List Calls","openapi":"GET /call","href":"/api-reference/call/get"},{"title":"Delete Call Record","openapi":"DELETE /call/{callId}","description":"Deletes a single call based on the callId supplied","href":"/api-reference/call/delete"}]},{"group":"Patients","pages":[{"title":"Match Patient","openapi":"POST /patient/match","href":"/api-reference/patient/match"},{"title":"Get Patient Chart","openapi":"GET /patient/{id}/chart","description":"Get basic facts from a patient's chart: name, date of birth, sex, MRN, and whether the patient is active or inactive at the practice.\n\nGet the patient ID from `POST /patient/match`.\n\n**Rate limit:** 60 requests per minute per practice, shared across all API keys calling it. Requests over the limit get a `429`.","href":"/api-reference/patient/get-chart"}]},{"group":"Sequences","pages":[{"title":"Get Sequence","openapi":"GET /sequence-manager/sequences/{id}","href":"/api-reference/sequences/get-single"},{"title":"Get Sequence Metrics","openapi":"GET /sequence-manager/sequences/metrics","href":"/api-reference/sequences/get-metrics"},{"title":"Batch Upload Sequences","openapi":"POST /sequence-manager/sequences/batch","href":"/api-reference/sequences/batch-upload"},{"title":"Stop Sequence","openapi":"POST /sequence-manager/sequences/{id}/stop","href":"/api-reference/sequences/stop"}]},{"group":"Sequence Definitions","pages":[{"title":"Get Sequence Definition","openapi":"GET /sequence-manager/sequence-definitions/{id}","href":"/api-reference/sequence-definitions/get-single"},{"title":"Get Sequence Definitions","openapi":"GET /sequence-manager/sequence-definitions","href":"/api-reference/sequence-definitions/get"}]},{"group":"Phone Numbers","pages":[{"title":"Get Phone Number","openapi":"GET /phone-number/{id}","href":"/api-reference/phone-number/get"},{"title":"List Phone Numbers","openapi":"GET /phone-number","href":"/api-reference/phone-number/list"}]},{"group":"Webhooks","pages":[{"title":"Webhook Configuration","href":"/api-reference/webhooks/organization-webhook"},{"title":"End of Call","href":"/api-reference/webhooks/end-of-call"},{"title":"End of Sequence Report","href":"/api-reference/webhooks/end-of-sequence-report"},{"title":"Verifying Webhook Signatures","href":"/api-reference/webhooks/verifying-webhook-signatures"}]},{"group":"Verification of Benefits","pages":[{"title":"Supported Plans","href":"/api-reference/eligibility/plan-list"},{"title":"List Eligibility Checks","openapi":"GET /eligibility","href":"/api-reference/eligibility/list"},{"title":"Get Eligibility Check","openapi":"GET /eligibility/{id}","href":"/api-reference/eligibility/get"},{"title":"Submit Eligibility Check","openapi":"POST /eligibility","href":"/api-reference/eligibility/create"}]}]}]},"title":"Match Patient - Clarion API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}