These are the APIs to be utilized when initiating patient processing.These APIs are largely asynchronous, as patient data is not immediately returned
to the client. Please contact Connective Health if you have any questions.
All interactions with Connective Health must satisfy all HIPAA and other regulatory requirements. In particular, patient information
must always be encrypted while in transit to and from Connective Health.
All communication is required to utilize modern TLS version 1.2 or newer with a modern cipher.
If utilizing a Connective Health API, your system must be configured to work with these requirements. See this information for more guidance.
All API endpoints are authenticated using an API Key which will be provided to you upon initiation of a pilot.This key should be provided as an HTTP header with every request.
In general, Connective Health will impose rate limits on all API endpoints.This is for both your protection (avoiding unexpected costs) and ours (system instability).
These limits are not intended to impose undo restrictions on your system and we will work with you on appropriate values.
If you reach
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Connective Health","colors":{"primary":"#047DB5","light":"#1DBCEE","dark":"#0C6284"},"logo":{"light":"https://mintcdn.com/connectivehealth/kSH1bibM2s-P8WWF/logo/CH_horizontal.png?fit=max\u0026auto=format\u0026n=kSH1bibM2s-P8WWF\u0026q=85\u0026s=5d699b20eadfbd07e9b80e7a204bad26","dark":"https://mintcdn.com/connectivehealth/kSH1bibM2s-P8WWF/logo/dark.png?fit=max\u0026auto=format\u0026n=kSH1bibM2s-P8WWF\u0026q=85\u0026s=42fad22a3b3864f934485f39a8b473fa","href":"https://connectivehealth.io"},"favicon":"https://mintcdn.com/connectivehealth/kSH1bibM2s-P8WWF/cropped-favicon-192x192.png?fit=max\u0026auto=format\u0026n=kSH1bibM2s-P8WWF\u0026q=85\u0026s=df71cfefb856321c15a9ca0704827b01","api":{"openapi":["files/patient-appointment-api.json"]},"navbar":{"links":[{"href":"mailto:techsupport@connectivehealth.io","label":"Support"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/connective-health"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"connectivehealth","hasAudioNarration":false,"actualSubdomain":"connectivehealth","customDomains":["docs.connectivehealth.io"],"gitSource":{"type":"gitlab","owner":"connective-health/documentation","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":72223338,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbbe21530a464c9e74ec91","collectionId":"0d47d4b4-d04d-4e56-b247-46073b1c8bbf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbbe21530a464c9e74ec91"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adbbe21530a464c9e74ec91","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Documentation","count":47},{"language":"default","tag":"FHIR","count":22},{"language":"default","tag":"Resources","count":17},{"language":"default","tag":"APIs","count":12},{"language":"default","tag":"Implementation","count":6},{"language":"default","tag":"Clinical Data","count":5},{"language":"default","tag":"Product","count":5},{"language":"default","tag":"Welcome","count":3},{"language":"default","tag":"Medication History","count":3},{"language":"default","tag":"Response Options","count":3}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API Introduction","description":"Connective Health Patient Processing APIs","icon":"book","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Connective Health Patient Processing APIs\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`welcome`,children:`Welcome`}),`\n`,_jsx(_components.p,{children:`These are the APIs to be utilized when initiating patient processing.`}),`\n`,_jsx(_components.p,{children:`These APIs are largely asynchronous, as patient data is not immediately returned\nto the client. Please contact Connective Health if you have any questions.`}),`\n`,_jsx(Heading,{level:`2`,id:`openapi-specification`,children:`OpenAPI Specification`}),`\n`,_jsxs(_components.p,{children:[`Our full OpenAPI specification is `,_jsx(_components.a,{href:`/files/patient-appointment-api.json`,children:`available in JSON format`}),`.`]}),`\n`,_jsx(Heading,{level:`1`,id:`security`,children:`Security`}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`All interactions with Connective Health must satisfy all `,_jsx(_components.a,{href:`https://www.hhs.gov/hipaa/for-professionals/security/guidance/cybersecurity/index.html`,children:`HIPAA`}),` and other regulatory requirements. In particular, patient information\nmust always be encrypted while in transit to and from Connective Health.`]}),`\n`,_jsx(Heading,{level:`2`,id:`tls`,children:`TLS`}),`\n`,_jsxs(_components.p,{children:[`All communication is required to utilize modern TLS version 1.2 or newer with a modern cipher.\nIf utilizing a Connective Health API, your system must be configured to work with these requirements. See `,_jsx(_components.a,{href:`https://www.ssl.com/guide/tls-standards-compliance/#hipaa`,children:`this information`}),` for more guidance.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All API endpoints are authenticated using an API Key which will be provided to you upon initiation of a pilot.`}),`\n`,_jsx(_components.p,{children:`This key should be provided as an HTTP header with every request.`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`apiKey: \u003cyour key here>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`1`,id:`other-requirements`,children:`Other Requirements`}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsx(_components.p,{children:`In general, Connective Health will impose rate limits on all API endpoints.`}),`\n`,_jsx(_components.p,{children:`This is for both your protection (avoiding unexpected costs) and ours (system instability).\nThese limits are not intended to impose undo restrictions on your system and we will work with you on appropriate values.\nIf you reach`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Introduction","description":"Connective Health Patient Processing APIs","icon":"book","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":1,"children":[]},{"title":"OpenAPI Specification","slug":"openapi-specification","depth":2,"children":[]},{"title":"Security","slug":"security","depth":1,"children":[]},{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"TLS","slug":"tls","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Other Requirements","slug":"other-requirements","depth":1,"children":[]},{"title":"Rate Limits","slug":"rate-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"connectivehealth","siteName":"Connective Health","title":"API Introduction - Connective Health","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T16:08:59.745Z","originalFileLocation":"api-reference/introduction.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=\"Connective Health Patient Processing APIs\">\u003cmeta data-mint-head name=\"application-name\" content=\"Connective Health\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_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/connectivehealth/eW7DQFtqdpyY8sXf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Introduction - Connective Health\">\u003cmeta data-mint-head property=\"og:description\" content=\"Connective Health Patient Processing APIs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Connective Health\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.connectivehealth.io/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://connectivehealth.mintlify.app/_mintlify/api/og/v2?division=APIs\u0026amp;title=API+Introduction\u0026amp;description=Connective+Health+Patient+Processing+APIs\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=24f01ba7a9fbfb5c9c93c45ebd2caa9fc0a72089504871cce29cf5c524bbff94\">\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=\"API Introduction - Connective Health\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Connective Health Patient Processing APIs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://connectivehealth.mintlify.app/_mintlify/api/og/v2?division=APIs\u0026amp;title=API+Introduction\u0026amp;description=Connective+Health+Patient+Processing+APIs\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=24f01ba7a9fbfb5c9c93c45ebd2caa9fc0a72089504871cce29cf5c524bbff94\">\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/connectivehealth/eW7DQFtqdpyY8sXf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Connective Health\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#047DB5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.connectivehealth.io/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.connectivehealth.io/#organization\",\"name\":\"Connective Health\",\"url\":\"https://docs.connectivehealth.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/connectivehealth/kSH1bibM2s-P8WWF/logo/CH_horizontal.png?fit=max\u0026auto=format\u0026n=kSH1bibM2s-P8WWF\u0026q=85\u0026s=5d699b20eadfbd07e9b80e7a204bad26\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.connectivehealth.io#website\",\"name\":\"Connective Health\",\"url\":\"https://docs.connectivehealth.io\",\"publisher\":{\"@id\":\"https://docs.connectivehealth.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.connectivehealth.io/api-reference/introduction#webpage\",\"url\":\"https://docs.connectivehealth.io/api-reference/introduction\",\"name\":\"API Introduction\",\"description\":\"Connective Health Patient Processing APIs\",\"dateModified\":\"2026-09-29T16:08:59.745Z\",\"isPartOf\":{\"@id\":\"https://docs.connectivehealth.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.connectivehealth.io/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.connectivehealth.io/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connective Health\",\"item\":\"https://docs.connectivehealth.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Introduction\",\"item\":\"https://docs.connectivehealth.io/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.connectivehealth.io/api-reference/introduction#article\",\"headline\":\"API Introduction\",\"name\":\"API Introduction\",\"description\":\"Connective Health Patient Processing APIs\",\"url\":\"https://docs.connectivehealth.io/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.connectivehealth.io/api-reference/introduction#webpage\"},\"dateModified\":\"2026-09-29T16:08:59.745Z\",\"publisher\":{\"@id\":\"https://docs.connectivehealth.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.connectivehealth.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Connective Health\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Connective Health","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Welcome","pages":[{"title":"Product Introduction","icon":"house","href":"/product/introduction"},{"title":"Pilot Process","icon":"paper-plane","href":"/implementation/pilot-process"}]},{"group":"Product","pages":[{"title":"Patient Care Summary","icon":"file-medical","href":"/product/patient-care-summary"},{"title":"Risk Adjustment Suspecting","icon":"magnifying-glass-chart","href":"/product/risk-adjustment"},{"title":"Quality Gap Closure","icon":"star","href":"/product/quality-gap-closure"},{"title":"Structured Reports","icon":"database","href":"/product/structured-reports"},{"title":"Webhooks","icon":"webhook","href":"/product/webhooks"}]},{"group":"FHIR","pages":[{"title":"FHIR Overview","icon":"fire-flame-curved","href":"/fhir/overview"},{"title":"Patient Everything","icon":"notes-medical","href":"/fhir/patient-everything-bundle"},{"title":"Patient Summary","icon":"file-medical","href":"/fhir/patient-summary-bundle"},{"title":"Bulk Medication History","icon":"prescription-bottle-medical","href":"/fhir/bulk-medication-history-bundle"},{"title":"Code Systems","icon":"table-list","href":"/fhir/code-systems"},{"group":"Resources","pages":[{"title":"Patient","icon":"user","href":"/fhir/resources/patient"},{"title":"AllergyIntolerance","icon":"hand-dots","href":"/fhir/resources/allergy-intolerance"},{"title":"CarePlan","icon":"clipboard-list","href":"/fhir/resources/care-plan"},{"title":"Condition","icon":"stethoscope","href":"/fhir/resources/condition"},{"title":"DiagnosticReport","icon":"file-waveform","href":"/fhir/resources/diagnostic-report"},{"title":"DocumentReference","icon":"file-lines","href":"/fhir/resources/document-reference"},{"title":"Encounter","icon":"hospital","href":"/fhir/resources/encounter"},{"title":"Immunization","icon":"syringe","href":"/fhir/resources/immunization"},{"title":"Observation","icon":"chart-line","href":"/fhir/resources/observation"},{"title":"Procedure","icon":"kit-medical","href":"/fhir/resources/procedure"},{"title":"Medication","icon":"pills","href":"/fhir/resources/medication"},{"title":"MedicationRequest","icon":"prescription","href":"/fhir/resources/medication-request"},{"title":"MedicationDispense","icon":"prescription-bottle","href":"/fhir/resources/medication-dispense"},{"title":"Practitioner","icon":"user-doctor","href":"/fhir/resources/practitioner"},{"title":"PractitionerRole","icon":"id-badge","href":"/fhir/resources/practitioner-role"},{"title":"Location","icon":"location-dot","href":"/fhir/resources/location"},{"title":"OperationOutcome","icon":"triangle-exclamation","href":"/fhir/resources/operation-outcome"}]}]},{"group":"Implementation","pages":[{"title":"Timeline","href":"/implementation/sample-project-steps"},{"group":"Request Options","pages":[{"title":"EHR Integration","icon":"link","href":"/implementation/ehr-integration"},{"title":"API Integration","icon":"code","href":"/implementation/api-integration"}]},{"group":"Response Options","pages":[{"title":"Clinical Messaging","icon":"envelope-open","href":"/responses/clinical-direct-messaging"},{"title":"Cloud Storage","icon":"cloud-arrow-up","href":"/responses/cloud-storage"},{"title":"EHR API Integration","description":"Delivery to the customer EHR using native integration with the EHR","icon":"hospital","href":"/responses/ehr-integration"}]}]},{"group":"APIs","pages":[{"title":"API Introduction","icon":"book","href":"/api-reference/introduction"},{"title":"Patient Data v2 Upgrade Guide","sidebarTitle":"API Upgrade Guide","description":"Upgrading from Scheduled Appointment API to Patient Data","icon":"arrow-up-right-dots","href":"/api-reference/patient-data-v2-upgrade-guide"},{"title":"Release Notes","icon":"gears","href":"/api-reference/release-notes"},{"group":"Clinical Data","pages":[{"openapi":"post /v2/patient-data/process","title":"Patient Data v2","href":"/clinical-data/patient-data-v2"},{"openapi":"post /v2/patient-data/validate","title":"Patient Data v2 Validate","href":"/clinical-data/patient-data-v2-validate"},{"openapi":"post /v1/scheduled-appointment","title":"Patient Data v1","href":"/clinical-data/patient-data-processing-v1"},{"openapi":"post /v2/patient-record","title":"Share Patient Record","href":"/clinical-data-sharing/patient-record"},{"openapi":"post /v1/encounter-summary","title":"Create Encounter Summary","href":"/clinical-data-sharing/encounter-summary"}]},{"group":"ADT Patient Panel","pages":[{"openapi":"post /v1/patient-panel","title":"Panel Registration","href":"/adt-patient-panel/panel-registration"}]},{"group":"Medication History","pages":[{"openapi":"post /v1/medication-history/patient-panel","title":"Medication History Patient Panel Load v1","href":"/medication-history/patient-panel-load"},{"openapi":"post /v1/medication-history/patient-panel/validate","title":"Medication History Patient Panel Load v1 Validate","href":"/medication-history/patient-panel-load-v1-validate"},{"openapi":"post /v1/medication-history/load-file","title":"Bulk Patient Panel File Load","href":"/medication-history/bulk-patient-panel-file-load"}]}]}]},{"anchor":"Home","icon":"house-user","pages":[{"title":"Home","href":"/introduction"}]}]},"title":"API Introduction - Connective Health","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}
