Populate all known data. It is required for processing that as much information as possible is supplied.
All active clinical information for a patient should be supplied in every API request.
That information is used to satisfy reciprocity requirements of the various health information exchanges
that Connective Health participates in. Failure to populate known clinical information for a patient is
a violation of health information exchange reciprocity rules, and may result in the termination of information exchange.
Overview
Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.
Provider responsible for this patient's care. This can be the Primary Care Physician (PCP), most recent provider, or a provider assigned for future care.
Identifier which can be used to logically group requests together. Do not populate if you do not need to group requests together. Will default to a UUID if not populated
Unique Connective Health identifier to correlate subsequent processing or troubleshooting
Example:
"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
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":"clinical-data-sharing/patient-record","slug":"/clinical-data-sharing/patient-record","pageMetadata":{"openapi":"post /v2/patient-record","title":"Share Patient Record","description":"\n# Data Requirements\n\n**Populate all known data**. It is required for processing that as much information as possible is supplied.\n\nAll active clinical information for a patient should be supplied in every API request.\nThat information is used to satisfy reciprocity requirements of the various health information exchanges\nthat Connective Health participates in. Failure to populate known clinical information for a patient is\na violation of health information exchange reciprocity rules, and may result in the termination of information exchange.\n\n## Overview\nClinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.","href":"/clinical-data-sharing/patient-record"},"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 h1: \"h1\",\n h2: \"h2\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h1, {\n children: \"Data Requirements\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Populate all known data\"\n }), \". It is required for processing that as much information as possible is supplied.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"All active clinical information for a patient should be supplied in every API request.\\nThat information is used to satisfy reciprocity requirements of the various health information exchanges\\nthat Connective Health participates in. Failure to populate known clinical information for a patient is\\na violation of health information exchange reciprocity rules, and may result in the termination of information exchange.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Overview\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v2/patient-record","title":"Share Patient Record","description":"\n# Data Requirements\n\n**Populate all known data**. It is required for processing that as much information as possible is supplied.\n\nAll active clinical information for a patient should be supplied in every API request.\nThat information is used to satisfy reciprocity requirements of the various health information exchanges\nthat Connective Health participates in. Failure to populate known clinical information for a patient is\na violation of health information exchange reciprocity rules, and may result in the termination of information exchange.\n\n## Overview\nClinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.","href":"/clinical-data-sharing/patient-record"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Patient Data Sharing"],"summary":"Share Patient Record","description":"\n# Data Requirements\n\n**Populate all known data**. It is required for processing that as much information as possible is supplied.\n\nAll active clinical information for a patient should be supplied in every API request.\nThat information is used to satisfy reciprocity requirements of the various health information exchanges\nthat Connective Health participates in. Failure to populate known clinical information for a patient is\na violation of health information exchange reciprocity rules, and may result in the termination of information exchange.\n\n## Overview\nClinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.","operationId":"sharePatientRecord","requestBody":"ebc6144f-d1f5-48bb-b228-2af1afca71f1","responses":{"200":"ea727209-bb66-4aaf-8913-d803dbd20459","400":"0dc57df6-e5ef-4e9a-9203-69688556d1cc","401":"7f3839f1-987c-4384-a011-04aef88cfa66","403":"5806f19e-3d85-4c35-a2fe-9bd545cfd19d"},"method":"post","type":"path","servers":["f1195cf7-5ccf-48e6-b41c-edc7dbe59101","613be36f-3905-4e4e-8af6-bc550976c423"],"security":["dd6caace-fddc-40e6-9d8d-401b27a1d76f"],"path":"/v2/patient-record","baseUrlOptions":["https://processing-request-staging.connectivehealth.io/","https://processing-request-production.connectivehealth.io/"],"title":"Share Patient Record","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"required":["patient","responsibleProvider"],"type":"object","properties":{"patient":{"required":["addresses","birthDate","gender","mrn","name"],"type":"object","properties":{"mrn":{"type":"object","description":"Patient's Medical Record Number. Populated with the clinic HL7 OID home community ID and the local patient ID. Must be unique per patient","required":["extension","root"],"properties":{"root":{"minLength":1,"type":"string","description":"Identifier's root, generally an OID","example":"1.2.3.4","isRequired":true,"uniqueKey":"patient.mrn.root","typeLabel":"string"},"extension":{"minLength":1,"pattern":"[^()\u003c>\"%;+@]*$","type":"string","description":"Identifier value or extension","example":"ABC123","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"patient.mrn.extension","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patient.mrn","typeLabel":"object"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"patient.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"patient.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patient.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patient.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patient.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patient.name","typeLabel":"object"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"isRequired":true,"uniqueKey":"patient.gender","typeLabel":"enum\u003cstring>"},"birthDate":{"type":"string","description":"Birth date of the patient in ISO-8601 format yyyy-MM-dd","format":"date","example":"1992-04-09","isRequired":true,"uniqueKey":"patient.birthDate","typeLabel":"string\u003cdate>"},"addresses":{"maxItems":3,"minItems":1,"type":"array","items":{"required":["zip"],"type":"object","properties":{"zip":{"pattern":"^(?!^00000$)\\d{5}$","type":"string","description":"5-digit zip code","example":"55401","x-pattern-message":"Zip must be a valid five-digit postal code","x-not-null-message":"Zip must not be null","isRequired":true,"uniqueKey":"patient.addresses.items.[INDEX].zip","typeLabel":"string"},"lines":{"pattern":"[^\u003c>\"%;+@]*$","type":"array","description":"Street lines of the address","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"patient.addresses.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patient.addresses.items.[INDEX].lines","typeLabel":"string[]"},"city":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The city","example":"Minneapolis","x-pattern-message":"Should not contain special characters","uniqueKey":"patient.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"pattern":"^[A-Za-z]{2}$|\\s*","type":"string","description":"State code abbreviation","example":"MN","x-pattern-message":"State code must be two character postal abbreviation or blank","uniqueKey":"patient.addresses.items.[INDEX].state","typeLabel":"string"}},"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"uniqueKey":"patient.addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"patient.addresses","typeLabel":"object[]"},"contactPoints":{"type":"array","items":{"required":["contactPointSystem","contactPointUse","value"],"type":"object","properties":{"value":{"minLength":1,"type":"string","description":"Phone number or email address","example":"9525551234","isRequired":true,"uniqueKey":"patient.contactPoints.items.[INDEX].value","typeLabel":"string"},"contactPointSystem":{"type":"string","description":"Type of contact","enum":["PHONE","EMAIL"],"example":"PHONE","isRequired":true,"uniqueKey":"patient.contactPoints.items.[INDEX].contactPointSystem","typeLabel":"enum\u003cstring>"},"contactPointUse":{"type":"string","description":"Use for the contact","enum":["HOME","WORK","MOBILE"],"example":"HOME","isRequired":true,"uniqueKey":"patient.contactPoints.items.[INDEX].contactPointUse","typeLabel":"enum\u003cstring>"}},"uniqueKey":"patient.contactPoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patient.contactPoints","typeLabel":"object[]"}},"description":"Patient to be processed","isRequired":true,"uniqueKey":"patient","typeLabel":"object"},"responsibleProvider":{"type":"object","description":"Provider responsible for this patient's care. This can be the Primary Care Physician (PCP), most recent provider, or a provider assigned for future care.","required":["name","npi"],"properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"responsibleProvider.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"responsibleProvider.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"responsibleProvider.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"responsibleProvider.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"responsibleProvider.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"responsibleProvider.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"responsibleProvider.name","typeLabel":"object"}},"isRequired":true,"uniqueKey":"responsibleProvider","typeLabel":"object"},"diagnoses":{"type":"array","description":"All diagnoses (problems) known about the patient. If the patient is an existing patient then this list should be populated with all known diagnoses","items":{"required":["active","code","codeSystem","displayName"],"type":"object","properties":{"code":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The diagnosis code including punctuation","example":"E66.01","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].code","typeLabel":"string"},"codeSystem":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The diagnosis code system - should be an HL7 OID","example":"2.16.840.1.113883.6.90","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].codeSystem","typeLabel":"string"},"displayName":{"minLength":1,"type":"string","description":"The display value for the diagnosis","example":"Morbid (severe) obesity due to excess calories","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].displayName","typeLabel":"string"},"active":{"type":"boolean","description":"Whether the diagnosis is still active or not","example":true,"isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].active","typeLabel":"boolean"},"date":{"type":"string","description":"Date of the problem (onset or diagnosed)","format":"date","example":"2022-12-12","uniqueKey":"diagnoses.items.[INDEX].date","typeLabel":"string\u003cdate>"},"diseaseManagement":{"type":"object","description":"Risk adjustment disease management information. This information is only applicable for risk adjustment patient processing.","required":["details"],"properties":{"details":{"maxItems":10,"minItems":1,"type":"array","items":{"required":["addressedDate"],"type":"object","properties":{"addressedDate":{"type":"string","description":"The date when the provider documented/addressed the diagnosis for the given year","format":"date","example":"2023-08-15","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].addressedDate","typeLabel":"string\u003cdate>"},"provider":{"type":"object","description":"Provider who documented the recapture","required":["name","npi"],"properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name","typeLabel":"object"}},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider","typeLabel":"object"},"facility":{"type":"object","description":"Facility or clinic where the recapture was performed","required":["name"],"properties":{"name":{"minLength":1,"type":"string","description":"Facility Name","example":"ABC Clinic","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.name","typeLabel":"string"},"address":{"type":"object","description":"Facility Address","required":["zip"],"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"properties":{"zip":{"pattern":"^(?!^00000$)\\d{5}$","type":"string","description":"5-digit zip code","example":"55401","x-pattern-message":"Zip must be a valid five-digit postal code","x-not-null-message":"Zip must not be null","isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.zip","typeLabel":"string"},"lines":{"pattern":"[^\u003c>\"%;+@]*$","type":"array","description":"Street lines of the address","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.lines","typeLabel":"string[]"},"city":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The city","example":"Minneapolis","x-pattern-message":"Should not contain special characters","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.city","typeLabel":"string"},"state":{"pattern":"^[A-Za-z]{2}$|\\s*","type":"string","description":"State code abbreviation","example":"MN","x-pattern-message":"State code must be two character postal abbreviation or blank","uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility","typeLabel":"object"}},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement.details","typeLabel":"object[]"}},"uniqueKey":"diagnoses.items.[INDEX].diseaseManagement","typeLabel":"object"}},"uniqueKey":"diagnoses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"diagnoses","typeLabel":"object[]"},"procedures":{"type":"array","description":"All known procedures for the patient","items":{"required":["code","date","status"],"type":"object","properties":{"date":{"type":"string","description":"Date the procedure was performed","format":"date","example":"2022-12-12","isRequired":true,"uniqueKey":"procedures.items.[INDEX].date","typeLabel":"string\u003cdate>"},"code":{"type":"object","description":"The procedure code. Should come from CPT, HCPCS, ICD-10-PCS, CDT, or SNOMED CT","required":["code","codeSystem","codeSystemName","displayName"],"example":{"code":"44970","codeSystem":"2.16.840.1.113883.6.12","codeSystemName":"CPT","displayName":"Laparoscopy, surgical, appendectomy"},"properties":{"code":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].code.code","typeLabel":"string"},"codeSystem":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].code.codeSystem","typeLabel":"string"},"codeSystemName":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].code.codeSystemName","typeLabel":"string"},"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"procedures.items.[INDEX].code.displayName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"procedures.items.[INDEX].code","typeLabel":"object"},"status":{"type":"string","description":"Status of the procedure","enum":["preparation","in-progress","not-done","on-hold","stopped","completed","entered-in-error","unknown"],"x-enum-varnames":["PREPARATION","IN_PROGRESS","NOT_DONE","ON_HOLD","STOPPED","COMPLETED","ENTERED_IN_ERROR","UNKNOWN"],"isRequired":true,"uniqueKey":"procedures.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"performer":{"type":"object","description":"The provider who performed the procedure","required":["name","npi"],"properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].performer.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].performer.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"procedures.items.[INDEX].performer.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"procedures.items.[INDEX].performer.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"procedures.items.[INDEX].performer.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"procedures.items.[INDEX].performer.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"procedures.items.[INDEX].performer.name","typeLabel":"object"}},"uniqueKey":"procedures.items.[INDEX].performer","typeLabel":"object"},"facility":{"type":"object","description":"The facility where the procedure was performed","required":["name"],"properties":{"name":{"minLength":1,"type":"string","description":"Facility Name","example":"ABC Clinic","isRequired":true,"uniqueKey":"procedures.items.[INDEX].facility.name","typeLabel":"string"},"address":{"type":"object","description":"Facility Address","required":["zip"],"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"properties":{"zip":{"pattern":"^(?!^00000$)\\d{5}$","type":"string","description":"5-digit zip code","example":"55401","x-pattern-message":"Zip must be a valid five-digit postal code","x-not-null-message":"Zip must not be null","isRequired":true,"uniqueKey":"procedures.items.[INDEX].facility.address.zip","typeLabel":"string"},"lines":{"pattern":"[^\u003c>\"%;+@]*$","type":"array","description":"Street lines of the address","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"procedures.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"procedures.items.[INDEX].facility.address.lines","typeLabel":"string[]"},"city":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The city","example":"Minneapolis","x-pattern-message":"Should not contain special characters","uniqueKey":"procedures.items.[INDEX].facility.address.city","typeLabel":"string"},"state":{"pattern":"^[A-Za-z]{2}$|\\s*","type":"string","description":"State code abbreviation","example":"MN","x-pattern-message":"State code must be two character postal abbreviation or blank","uniqueKey":"procedures.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"procedures.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"procedures.items.[INDEX].facility","typeLabel":"object"},"targetSite":{"type":"object","description":"The anatomical location on the body where the procedure was performed, if applicable. Should be a SNOMED CT code","required":["code","codeSystem","codeSystemName","displayName"],"example":{"code":"66754008","codeSystem":"2.16.840.1.113883.6.96","codeSystemName":"SNOMED CT","displayName":"Appendix structure"},"properties":{"code":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].targetSite.code","typeLabel":"string"},"codeSystem":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].targetSite.codeSystem","typeLabel":"string"},"codeSystemName":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"procedures.items.[INDEX].targetSite.codeSystemName","typeLabel":"string"},"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"procedures.items.[INDEX].targetSite.displayName","typeLabel":"string"}},"uniqueKey":"procedures.items.[INDEX].targetSite","typeLabel":"object"},"note":{"type":"string","description":"Additional narrative information about the procedure","example":"Procedure was well tolerated","uniqueKey":"procedures.items.[INDEX].note","typeLabel":"string"}},"uniqueKey":"procedures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"procedures","typeLabel":"object[]"},"immunizations":{"type":"array","description":"All known immunizations for the patient, including historical (reported) and not-given immunizations","items":{"required":["code","date","status"],"type":"object","properties":{"date":{"type":"string","description":"Date the immunization was administered (or, if not given, the date it was declined/deferred) in ISO-8601 format yyyy-MM-dd. Must not be in the future","format":"date","example":"2024-10-01","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].date","typeLabel":"string\u003cdate>"},"code":{"type":"object","description":"The vaccine administered. Must be a CVX code (code system 2.16.840.1.113883.12.292)","required":["code","codeSystem","codeSystemName","displayName"],"example":{"code":"150","codeSystem":"2.16.840.1.113883.12.292","codeSystemName":"CVX","displayName":"Influenza, injectable, quadrivalent, preservative free"},"properties":{"code":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].code.code","typeLabel":"string"},"codeSystem":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].code.codeSystem","typeLabel":"string"},"codeSystemName":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].code.codeSystemName","typeLabel":"string"},"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].code.displayName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"immunizations.items.[INDEX].code","typeLabel":"object"},"status":{"type":"string","description":"Status of the immunization","enum":["completed","not-done"],"x-enum-varnames":["COMPLETED","NOT_DONE"],"isRequired":true,"uniqueKey":"immunizations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"statusReason":{"type":"string","description":"Reason the immunization was not given. Required when status is not-done and not allowed otherwise","enum":["IMMUNE","MEDPREC","OSTOCK","PATOBJ","PHILISOP","RELIG","VACEFF","VACSAF"],"uniqueKey":"immunizations.items.[INDEX].statusReason","typeLabel":"enum\u003cstring>"},"performer":{"type":"object","description":"The provider who administered the immunization, or for not-done who recorded that it was not given","required":["name","npi"],"properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].performer.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].performer.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"immunizations.items.[INDEX].performer.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"immunizations.items.[INDEX].performer.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"immunizations.items.[INDEX].performer.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"immunizations.items.[INDEX].performer.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"immunizations.items.[INDEX].performer.name","typeLabel":"object"}},"uniqueKey":"immunizations.items.[INDEX].performer","typeLabel":"object"},"facility":{"type":"object","description":"The facility where the immunization was administered, or for not-done where it was declined or deferred","required":["name"],"properties":{"name":{"minLength":1,"type":"string","description":"Facility Name","example":"ABC Clinic","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].facility.name","typeLabel":"string"},"address":{"type":"object","description":"Facility Address","required":["zip"],"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"properties":{"zip":{"pattern":"^(?!^00000$)\\d{5}$","type":"string","description":"5-digit zip code","example":"55401","x-pattern-message":"Zip must be a valid five-digit postal code","x-not-null-message":"Zip must not be null","isRequired":true,"uniqueKey":"immunizations.items.[INDEX].facility.address.zip","typeLabel":"string"},"lines":{"pattern":"[^\u003c>\"%;+@]*$","type":"array","description":"Street lines of the address","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"immunizations.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"immunizations.items.[INDEX].facility.address.lines","typeLabel":"string[]"},"city":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The city","example":"Minneapolis","x-pattern-message":"Should not contain special characters","uniqueKey":"immunizations.items.[INDEX].facility.address.city","typeLabel":"string"},"state":{"pattern":"^[A-Za-z]{2}$|\\s*","type":"string","description":"State code abbreviation","example":"MN","x-pattern-message":"State code must be two character postal abbreviation or blank","uniqueKey":"immunizations.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"immunizations.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"immunizations.items.[INDEX].facility","typeLabel":"object"}},"description":"An immunization that was administered to, or refused/not given to, the patient","uniqueKey":"immunizations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"immunizations","typeLabel":"object[]"},"medications":{"type":"array","description":"All known medications about the patient","items":{"required":["active","nameCode"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether this medication is being actively used by the patient","example":true,"isRequired":true,"uniqueKey":"medications.items.[INDEX].active","typeLabel":"boolean"},"nameCode":{"type":"object","description":"Medication name code. Code system should be RxNorm if possible","required":["displayName"],"example":{"code":"6809","codeSystem":"2.16.840.1.113883.6.88","codeSystemName":"RxNorm","displayName":"metFORMIN"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].nameCode.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].nameCode.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].nameCode.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].nameCode.codeSystemName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"medications.items.[INDEX].nameCode","typeLabel":"object"},"classCode":{"type":"object","description":"Medication class code. Code system should be MED-RT if possible","required":["displayName"],"example":{"code":"N0000175565","codeSystem":"2.16.840.1.113883.6.345","codeSystemName":"MED-RT","displayName":"Biguanide"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].classCode.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].classCode.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].classCode.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].classCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].classCode","typeLabel":"object"},"scheduleCode":{"type":"object","description":"Medication schedule code.","required":["displayName"],"example":{"code":"IV","codeSystem":"2.16.840.1.113883.12.477","codeSystemName":"Controlled Substance Schedule","displayName":"Schedule IV"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].scheduleCode.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].scheduleCode.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].scheduleCode.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].scheduleCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].scheduleCode","typeLabel":"object"},"medicationRequests":{"type":"array","items":{"type":"object","properties":{"code":{"type":"object","description":"Medication code. This is the specific medication including form. Code system should be NDC or RxNorm if possible. NDC codes are strongly encouraged to be 11-digit if possible, otherwise 10-digit with dashes.","required":["displayName"],"example":{"code":"861007","codeSystem":"2.16.840.1.113883.6.88","codeSystemName":"RxNorm","displayName":"metFORMIN hydrochloride 500 MG Oral Tablet"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].code.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].code.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].code.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].code.codeSystemName","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].code","typeLabel":"object"},"form":{"type":"object","description":"Form the medication is in. Code system should be NCI Thesaurus if possible","required":["displayName"],"example":{"code":"C42998","codeSystem":"2.16.840.1.113883.3.26.1.1","codeSystemName":"NCI Thesaurus","displayName":"tablet"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].form.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].form.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].form.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].form.codeSystemName","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].form","typeLabel":"object"},"route":{"type":"object","description":"Route by which the medication is administered","required":["displayName"],"example":{"code":"C38288","codeSystem":"2.16.840.1.113883.3.26.1.1","codeSystemName":"NCI Thesaurus","displayName":"oral"},"properties":{"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].route.displayName","typeLabel":"string"},"code":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].route.code","typeLabel":"string"},"codeSystem":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].route.codeSystem","typeLabel":"string"},"codeSystemName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].route.codeSystemName","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].route","typeLabel":"object"},"prescribedDate":{"type":"string","description":"Date the medication was prescribed, in ISO-8601 format yyyy-MM-dd","format":"date","example":"2023-12-02","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescribedDate","typeLabel":"string\u003cdate>"},"prescriber":{"type":"object","description":"Prescriber of the medication","required":["name","npi"],"properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name","typeLabel":"object"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber","typeLabel":"object"},"facility":{"type":"object","description":"Facility where the medication was prescribed","required":["name"],"properties":{"name":{"minLength":1,"type":"string","description":"Facility Name","example":"ABC Clinic","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.name","typeLabel":"string"},"address":{"type":"object","description":"Facility Address","required":["zip"],"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"properties":{"zip":{"pattern":"^(?!^00000$)\\d{5}$","type":"string","description":"5-digit zip code","example":"55401","x-pattern-message":"Zip must be a valid five-digit postal code","x-not-null-message":"Zip must not be null","isRequired":true,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.zip","typeLabel":"string"},"lines":{"pattern":"[^\u003c>\"%;+@]*$","type":"array","description":"Street lines of the address","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.lines","typeLabel":"string[]"},"city":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The city","example":"Minneapolis","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.city","typeLabel":"string"},"state":{"pattern":"^[A-Za-z]{2}$|\\s*","type":"string","description":"State code abbreviation","example":"MN","x-pattern-message":"State code must be two character postal abbreviation or blank","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].facility","typeLabel":"object"},"initialFillQuantity":{"type":"number","description":"Quantity initially filled for the medication","format":"double","example":10,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].initialFillQuantity","typeLabel":"number\u003cdouble>"},"numberOfRefillsAllowed":{"type":"integer","description":"Number of refills allowed for this prescription","format":"int32","example":0,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].numberOfRefillsAllowed","typeLabel":"integer\u003cint32>"},"timingEvent":{"type":"string","description":"Timing of medication administration, taken from https://www.hl7.org/fhir/R4/valueset-timing-abbreviation.html (OID 2.16.840.1.113883.4.642.3.78). Should be consistent with frequency if both populated","enum":["BID","TID","QID","AM","PM","QD","QOD","Q1H","Q2H","Q3H","Q4H","Q6H","Q8H","BED","WK","MO"],"example":"QD","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].timingEvent","typeLabel":"enum\u003cstring>"},"frequencyUnit":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Unit of time as defined by http://hl7.org/fhir/ValueSet/units-of-time. Should be consistent with timingEvent if both populated","example":"d","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].frequencyUnit","typeLabel":"string"},"frequencyValue":{"type":"number","description":"Frequency at which the medication should be taken. Should be consistent with timingEvent if both populated","format":"double","example":1,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].frequencyValue","typeLabel":"number\u003cdouble>"},"dosageInstruction":{"type":"object","properties":{"text":{"type":"string","description":"Prescriber's sig, or directions for taking the medication","example":"take 1 tablet by mouth once daily","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.text","typeLabel":"string"},"strengthUnit":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Unit of the dosage strength","example":"mg","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.strengthUnit","typeLabel":"string"},"strengthValue":{"type":"number","description":"Value of the dosage strength","format":"double","example":100,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.strengthValue","typeLabel":"number\u003cdouble>"},"amountUnit":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Unit of a single dose","example":"puffs","x-pattern-message":"Should not contain special characters","uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountUnit","typeLabel":"string"},"amountValue":{"type":"number","description":"Value of a single dose","format":"double","example":2,"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountValue","typeLabel":"number\u003cdouble>"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction","typeLabel":"object"}},"uniqueKey":"medications.items.[INDEX].medicationRequests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"medications.items.[INDEX].medicationRequests","typeLabel":"object[]"}},"uniqueKey":"medications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"medications","typeLabel":"object[]"},"clinicalNotes":{"type":"array","description":"All known clinical notes about the patient which are not related to a specific encounter","items":{"required":["lines"],"type":"object","properties":{"lines":{"minItems":1,"type":"array","description":"text of the clinical note, each line will be distinctly separated on CCDA output","example":["The patient was pleasant","Recommend following up in 2 weeks"],"items":{"minLength":1,"type":"string","uniqueKey":"clinicalNotes.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].lines","typeLabel":"string[]"},"author":{"required":["name","npi"],"type":"object","properties":{"npi":{"maxLength":10,"minLength":10,"type":"string","description":"NPI value","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].author.npi","typeLabel":"string"},"name":{"required":["family","given"],"type":"object","properties":{"family":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Family name (last name)","example":"Johnson","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].author.name.family","typeLabel":"string"},"given":{"pattern":"[^\u003c>\"%;+@]*$","minItems":1,"type":"array","description":"First and middle names. First name (at least) is required","items":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","x-pattern-message":"Should not contain special characters","uniqueKey":"clinicalNotes.items.[INDEX].author.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].author.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"clinicalNotes.items.[INDEX].author.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"clinicalNotes.items.[INDEX].author.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].author.name","typeLabel":"object"}},"description":"A medical provider","uniqueKey":"clinicalNotes.items.[INDEX].author","typeLabel":"object"},"date":{"type":"string","description":"Date the note was recorded or written.","format":"date","example":"2022-12-12","uniqueKey":"clinicalNotes.items.[INDEX].date","typeLabel":"string\u003cdate>"},"code":{"type":"object","description":"Type of note content. Should come from https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.68/expansion/Latest","required":["code","codeSystem","codeSystemName","displayName"],"example":{"code":"11506-3","codeSystem":"2.16.840.1.113883.6.1","codeSystemName":"LOINC","displayName":"Progress Note"},"properties":{"code":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"The specific code from a code system","example":"N0000175497","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].code.code","typeLabel":"string"},"codeSystem":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].code.codeSystem","typeLabel":"string"},"codeSystemName":{"minLength":1,"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","x-pattern-message":"Should not contain special characters","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].code.codeSystemName","typeLabel":"string"},"displayName":{"minLength":1,"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","isRequired":true,"uniqueKey":"clinicalNotes.items.[INDEX].code.displayName","typeLabel":"string"}},"uniqueKey":"clinicalNotes.items.[INDEX].code","typeLabel":"object"}},"uniqueKey":"clinicalNotes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"clinicalNotes","typeLabel":"object[]"},"batchId":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Identifier which can be used to logically group requests together. Do not populate if you do not need to group requests together. Will default to a UUID if not populated","example":"BATCH-123","x-pattern-message":"Should not contain special characters","uniqueKey":"batchId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"patient":{"mrn":{"root":"1.2.3.4","extension":"ABC123"},"name":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"birthDate":"1992-04-09","addresses":[{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"}],"contactPoints":[{"value":"9525551234","contactPointSystem":"PHONE","contactPointUse":"HOME"}]},"responsibleProvider":{"npi":"1414912117","name":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."}},"diagnoses":[{"code":"E66.01","codeSystem":"2.16.840.1.113883.6.90","displayName":"Morbid (severe) obesity due to excess calories","active":true,"date":"2022-12-12"}],"procedures":[{"date":"2022-12-12","code":{"code":"44970","codeSystem":"2.16.840.1.113883.6.12","codeSystemName":"CPT","displayName":"Laparoscopy, surgical, appendectomy"},"targetSite":{"code":"66754008","codeSystem":"2.16.840.1.113883.6.96","codeSystemName":"SNOMED CT","displayName":"Appendix structure"},"note":"Procedure was well tolerated"}],"immunizations":[{"date":"2024-10-01","code":{"code":"150","codeSystem":"2.16.840.1.113883.12.292","codeSystemName":"CVX","displayName":"Influenza, injectable, quadrivalent, preservative free"}}],"medications":[{"active":true,"nameCode":{"code":"6809","codeSystem":"2.16.840.1.113883.6.88","codeSystemName":"RxNorm","displayName":"metFORMIN"},"classCode":{"code":"N0000175565","codeSystem":"2.16.840.1.113883.6.345","codeSystemName":"MED-RT","displayName":"Biguanide"},"scheduleCode":{"code":"IV","codeSystem":"2.16.840.1.113883.12.477","codeSystemName":"Controlled Substance Schedule","displayName":"Schedule IV"},"medicationRequests":[{"code":{"code":"861007","codeSystem":"2.16.840.1.113883.6.88","codeSystemName":"RxNorm","displayName":"metFORMIN hydrochloride 500 MG Oral Tablet"},"form":{"code":"C42998","codeSystem":"2.16.840.1.113883.3.26.1.1","codeSystemName":"NCI Thesaurus","displayName":"tablet"},"route":{"code":"C38288","codeSystem":"2.16.840.1.113883.3.26.1.1","codeSystemName":"NCI Thesaurus","displayName":"oral"},"prescribedDate":"2023-12-02","initialFillQuantity":10,"numberOfRefillsAllowed":0,"timingEvent":"QD","frequencyUnit":"d","frequencyValue":1,"dosageInstruction":{"text":"take 1 tablet by mouth once daily","strengthUnit":"mg","strengthValue":100,"amountUnit":"puffs","amountValue":2}}]}],"clinicalNotes":[{"lines":["The patient was pleasant","Recommend following up in 2 weeks"],"date":"2022-12-12","code":{"code":"11506-3","codeSystem":"2.16.840.1.113883.6.1","codeSystemName":"LOINC","displayName":"Progress Note"}}],"batchId":"BATCH-123"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"ea727209-bb66-4aaf-8913-d803dbd20459":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique Connective Health identifier to correlate subsequent processing or troubleshooting","example":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0","uniqueKey":"correlationId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"correlationId":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"}}},"exampleType":"generated"}},"exampleType":"generated"},"0dc57df6-e5ef-4e9a-9203-69688556d1cc":{"description":"Validation problems","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"_links":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"_links.additionalProperties","typeLabel":"object"},"uniqueKey":"_links","typeLabel":"object"},"_embedded":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"empty":{"type":"boolean","uniqueKey":"_embedded.additionalProperties.items.[INDEX]._links.empty","typeLabel":"boolean"}},"uniqueKey":"_embedded.additionalProperties.items.[INDEX]._links","typeLabel":"object"},"_embedded":{"type":"object","properties":{"empty":{"type":"boolean","uniqueKey":"_embedded.additionalProperties.items.[INDEX]._embedded.empty","typeLabel":"boolean"}},"uniqueKey":"_embedded.additionalProperties.items.[INDEX]._embedded","typeLabel":"object"}},"uniqueKey":"_embedded.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"_embedded.additionalProperties","typeLabel":"object[]"},"uniqueKey":"_embedded","typeLabel":"object"},"logref":{"oneOf":[{"$circularRef":"74f8f953-88c4-4a9e-8b43-c6dcc13e452e"}],"uniqueKey":"logref","typeLabel":"any"},"path":{"oneOf":[{"$circularRef":"74f8f953-88c4-4a9e-8b43-c6dcc13e452e"}],"uniqueKey":"path","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","_links":{},"_embedded":{},"logref":"\u003cunknown>","path":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7f3839f1-987c-4384-a011-04aef88cfa66":{"description":"Missing or invalid apikey","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique Connective Health identifier to correlate subsequent processing or troubleshooting","example":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0","uniqueKey":"correlationId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"correlationId":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"}}},"exampleType":"generated"}},"exampleType":"generated"},"5806f19e-3d85-4c35-a2fe-9bd545cfd19d":{"description":"Missing permission","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique Connective Health identifier to correlate subsequent processing or troubleshooting","example":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0","uniqueKey":"correlationId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"correlationId":"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dd6caace-fddc-40e6-9d8d-401b27a1d76f":{"apiKey":{"type":"apiKey","description":"API Key","name":"apiKey","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"f1195cf7-5ccf-48e6-b41c-edc7dbe59101":{"url":"https://processing-request-staging.connectivehealth.io/","description":"Customer testing site. Test data only. No PHI."},"613be36f-3905-4e4e-8af6-bc550976c423":{"url":"https://processing-request-production.connectivehealth.io/","description":"Customer production site. Real patient information is only supported here."}},"schemas":{"74f8f953-88c4-4a9e-8b43-c6dcc13e452e":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true},"_links":{"type":"object","additionalProperties":{"type":"object"}},"_embedded":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"empty":{"type":"boolean"}}},"_embedded":{"type":"object","properties":{"empty":{"type":"boolean"}}}}}}},"logref":{"oneOf":[{}]},"path":{"oneOf":[{}]}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API Key","name":"apiKey","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"apiKey","type":"string","description":"API Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"apiKey"}],"title":"apiKey"}]},"originalFileLocation":"files/patient-appointment-api.json"},"subdomain":"connectivehealth","siteName":"Connective Health","title":"Share Patient Record - Connective Health","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-04T01:30:53.433Z","originalFileLocation":"clinical-data-sharing/patient-record.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=\"# Data Requirements Populate all known data. It is required for processing that as much information as possible is supplied. All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange. ## Overview Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\">\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=\"Share Patient Record - Connective Health\">\u003cmeta data-mint-head property=\"og:description\" content=\"# Data Requirements Populate all known data. It is required for processing that as much information as possible is supplied. All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange. ## Overview Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Connective Health\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record\">\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=Clinical+Data\u0026amp;title=Share+Patient+Record\u0026amp;description=%0A%23+Data+Requirements%0A%0A**Populate+all+known+data**.+It+is+required+for+processing+that+as+much+information+as+possible+is+supplied.%0A%0AAll+active+clinical+informat\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=7b5753050edb2d9a8a8960f141d0346bdc5554b08cc65ec69fb930fd614782c3\">\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=\"Share Patient Record - Connective Health\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"# Data Requirements Populate all known data. It is required for processing that as much information as possible is supplied. All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange. ## Overview Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://connectivehealth.mintlify.app/_mintlify/api/og/v2?division=Clinical+Data\u0026amp;title=Share+Patient+Record\u0026amp;description=%0A%23+Data+Requirements%0A%0A**Populate+all+known+data**.+It+is+required+for+processing+that+as+much+information+as+possible+is+supplied.%0A%0AAll+active+clinical+informat\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=7b5753050edb2d9a8a8960f141d0346bdc5554b08cc65ec69fb930fd614782c3\">\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/clinical-data-sharing/patient-record\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/clinical-data-sharing/patient-record.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/clinical-data-sharing/patient-record#webpage\",\"url\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record\",\"name\":\"Share Patient Record\",\"description\":\"# Data Requirements Populate all known data. It is required for processing that as much information as possible is supplied. All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange. ## Overview Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\",\"dateModified\":\"2026-06-04T01:30:53.433Z\",\"isPartOf\":{\"@id\":\"https://docs.connectivehealth.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.connectivehealth.io/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clinical Data\",\"item\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Share Patient Record\",\"item\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record#apireference\",\"headline\":\"Share Patient Record\",\"name\":\"Share Patient Record\",\"description\":\"# Data Requirements Populate all known data. It is required for processing that as much information as possible is supplied. All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange. ## Overview Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.\",\"url\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record\",\"mainEntityOfPage\":{\"@id\":\"https://docs.connectivehealth.io/clinical-data-sharing/patient-record#webpage\"},\"dateModified\":\"2026-06-04T01:30:53.433Z\",\"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","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","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","description":"\n# Data Requirements\n\n**Populate all known data**. It is required for processing that as much information as possible is supplied.\n \nAll active clinical information for a patient should be supplied in every API request. \nThat information is used to satisfy reciprocity requirements of the various health information exchanges \nthat Connective Health participates in. Failure to populate known clinical information for a patient is \na violation of health information exchange reciprocity rules, and may result in the termination of information exchange.\n\n## Overview\nStandard processing for clinical patient information, both summarized and complete information is supported.","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","description":"\n# Data Requirements\n\n**Populate all known data**. It is required for processing that as much information as possible is supplied. \n\n## Overview\nDetails of a patient encounter. These details are used to generate an Encounter Summary (Progress Note) CCDA document.\nEach encounter with a patient should generate a request to this endpoint.","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":"Share Patient Record - Connective Health","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}