Identifier which can be used to logically group requests together. Do not populate if you do not need to group requests together. Will default if not populated
Response details about each individual request in the panel
Show child attributes
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/patient-data-v2-validate","slug":"/clinical-data/patient-data-v2-validate","pageMetadata":{"openapi":"post /v2/patient-data/validate","title":"Patient Data v2 Validate","description":"Validates the request without doing any processing","href":"/clinical-data/patient-data-v2-validate"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Validates the request without doing any processing\"\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-data/validate","title":"Patient Data v2 Validate","description":"Validates the request without doing any processing","href":"/clinical-data/patient-data-v2-validate"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Patient Processing Panel"],"summary":"Validate Patient Processing Panel","description":"Validates the request without doing any processing","operationId":"validPatientProcessingPanel","requestBody":"d9287b8f-2cfa-424c-8902-058a62398a4d","responses":{"200":"ed6a7d33-9f5f-4c18-8c94-8d6b3369266a","400":"e4523e45-09e7-4f73-8ef1-8af11b8679ae","401":"f5fff6d8-6eed-4570-a314-b126dc1b2a4d"},"method":"post","type":"path","servers":["f1195cf7-5ccf-48e6-b41c-edc7dbe59101","613be36f-3905-4e4e-8af6-bc550976c423"],"security":["dd6caace-fddc-40e6-9d8d-401b27a1d76f"],"path":"/v2/patient-data/validate","baseUrlOptions":["https://processing-request-staging.connectivehealth.io/","https://processing-request-production.connectivehealth.io/"],"title":"Validate Patient Processing Panel","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"required":["patientProcessingRequests"],"type":"object","properties":{"patientProcessingRequests":{"maxItems":2500,"minItems":1,"type":"array","items":{"required":["patient","requestingProvider"],"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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.mrn.extension","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].patient.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].patient.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].patient.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].patient.name","typeLabel":"object"},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER","UNKNOWN"],"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.addresses.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.addresses.items.[INDEX].state","typeLabel":"string"}},"example":{"lines":["123 Main St","Suite 517"],"city":"Minneapolis","state":"MN","zip":"55401"},"uniqueKey":"patientProcessingRequests.items.[INDEX].patient.addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.contactPoints.items.[INDEX].value","typeLabel":"string"},"contactPointSystem":{"type":"string","description":"Type of contact","enum":["PHONE","EMAIL"],"example":"PHONE","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].patient.contactPoints.items.[INDEX].contactPointUse","typeLabel":"enum\u003cstring>"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].patient.contactPoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].patient.contactPoints","typeLabel":"object[]"}},"description":"Patient to be processed","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].patient","typeLabel":"object"},"requestingProvider":{"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":"patientProcessingRequests.items.[INDEX].requestingProvider.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":"patientProcessingRequests.items.[INDEX].requestingProvider.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":"patientProcessingRequests.items.[INDEX].requestingProvider.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].requestingProvider.name.given","typeLabel":"string[]"},"prefix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name prefix","example":"Mr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].requestingProvider.name.prefix","typeLabel":"string"},"suffix":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name suffix","example":"Jr.","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].requestingProvider.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].requestingProvider.name","typeLabel":"object"}},"description":"A medical provider","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].requestingProvider","typeLabel":"object"},"upcomingAppointmentDate":{"type":"string","description":"Date of the appointment in ISO-8601 format yyyy-MM-dd","format":"date","example":"2025-11-05","uniqueKey":"patientProcessingRequests.items.[INDEX].upcomingAppointmentDate","typeLabel":"string\u003cdate>"},"enrollmentDate":{"type":"string","description":"Date of the patient enrollment in ISO-8601 format yyyy-MM-dd. This field is informational only.","format":"date","example":"2025-11-05","uniqueKey":"patientProcessingRequests.items.[INDEX].enrollmentDate","typeLabel":"string\u003cdate>"},"clinicName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Name of the clinic the patient is being seen at, or the organization requesting the data. Customer name will be used if not populated","example":"Simple Clinic Name","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].clinicName","typeLabel":"string"},"clinicNpi":{"maxLength":10,"minLength":10,"type":"string","description":"Facility's NPI if known","example":"1414912117","x-size-message":"NPI must be exactly 10 characters","uniqueKey":"patientProcessingRequests.items.[INDEX].clinicNpi","typeLabel":"string"},"responseDirectAddress":{"type":"string","description":"Direct Address to return documents to. Typically, populate this OR responseFaxNumber","format":"email","example":"contact@yourdomain.com","x-pattern-message":"response direct address must be a valid format","uniqueKey":"patientProcessingRequests.items.[INDEX].responseDirectAddress","typeLabel":"string\u003cemail>"},"responseFriendlyName":{"pattern":"[^\u003c>\"%;+@]*$","type":"string","description":"Human-readable name to send response message to","example":"Heart Clinic","x-pattern-message":"Should not contain special characters","uniqueKey":"patientProcessingRequests.items.[INDEX].responseFriendlyName","typeLabel":"string"},"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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].displayName","typeLabel":"string"},"active":{"type":"boolean","description":"Whether the diagnosis is still active or not","example":true,"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].active","typeLabel":"boolean"},"date":{"type":"string","description":"Date of the problem (onset or diagnosed)","format":"date","example":"2022-12-12","uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].provider.name","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX].facility","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement.details","typeLabel":"object[]"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX].diseaseManagement","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].diagnoses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].code.displayName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].performer.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].performer.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].performer.name","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].targetSite.displayName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].targetSite","typeLabel":"object"},"note":{"type":"string","description":"Additional narrative information about the procedure","example":"Procedure was well tolerated","uniqueKey":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX].note","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].procedures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].code.displayName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].performer.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].performer.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].performer.name","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX].facility","typeLabel":"object"}},"description":"An immunization that was administered to, or refused/not given to, the patient","uniqueKey":"patientProcessingRequests.items.[INDEX].immunizations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].nameCode.codeSystemName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].classCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].scheduleCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].code.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].form.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].route.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].facility","typeLabel":"object"},"initialFillQuantity":{"type":"number","description":"Quantity initially filled for the medication","format":"double","example":10,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.strengthUnit","typeLabel":"string"},"strengthValue":{"type":"number","description":"Value of the dosage strength","format":"double","example":100,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountUnit","typeLabel":"string"},"amountValue":{"type":"number","description":"Value of a single dose","format":"double","example":2,"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountValue","typeLabel":"number\u003cdouble>"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX].medicationRequests","typeLabel":"object[]"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].medications","typeLabel":"object[]"},"clinicalNotes":{"type":"array","description":"Additional information provided about the patient","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":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].lines.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].author.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].author.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].author.name","typeLabel":"object"}},"description":"A medical provider","uniqueKey":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].author","typeLabel":"object"},"date":{"type":"string","description":"Date the note was recorded or written.","format":"date","example":"2022-12-12","uniqueKey":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].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":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].code.displayName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX].code","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].clinicalNotes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].clinicalNotes","typeLabel":"object[]"},"adtEventData":{"type":"object","description":"ADT event information about the patient; populating this field requires ADT feature authorization enabled on customer account","required":["adtEvents"],"properties":{"adtEvents":{"maxItems":300,"minItems":1,"type":"array","description":"ADT events for the patient, at least one of which should have classification of MAIN","items":{"required":["classification","eventType","messageId","sendingFacilityName","timestamp"],"type":"object","properties":{"classification":{"type":"string","description":"Reason why this event is included on request","enum":["MAIN","SUPPLEMENTAL"],"example":"MAIN","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].classification","typeLabel":"enum\u003cstring>"},"messageId":{"minLength":1,"type":"string","description":"Message Control ID from MSH.10","example":"5125745967","externalDocs":{"description":"See MSH segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/MSH"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].messageId","typeLabel":"string"},"eventType":{"type":"string","description":"ADT event type, generally from MSH.9.2 (EVN.1 in older messages)","enum":["A01","A02","A03","A04","A05","A06","A07","A08","A09","A10","A11","A12","A13","A14","A15","A16","A17","A18","A19","A20","A21","A22","A23","A24","A25","A26","A27","A28","A29","A30","A31","A32","A33","A34","A35","A36","A37","A38","A39","A40","A41","A42","A43","A44","A45","A46","A47","A48","A49","A50","A51","A52","A53","A54","A55","A60","A61","A62"],"example":"A03","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].eventType","typeLabel":"enum\u003cstring>"},"sendingFacilityName":{"minLength":1,"type":"string","description":"Name of the facility that sent the ADT, generally mapped from MSH.4; very important for matching admit/discharge pairs","example":"First Memorial Hospital","externalDocs":{"description":"See MSH segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/MSH"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].sendingFacilityName","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when this ADT event was received/processed; used to help establish chronological order of incoming events","format":"date-time","example":"2024-11-01T20:25:16.907342Z","externalDocs":{"description":"See EVN segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/EVN"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"},"sendingFacilityPatientId":{"type":"object","description":"Sending facility's ID for the patient, helpful to provider in case of follow-up contact, generally from PID.2, PID.3, or PID.4","example":{"root":"2.16.840.1.113883.3.9359.0","extension":"FMH-12345"},"properties":{"root":{"type":"string","description":"Identifier's root","example":"ACME_HEALTH","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].sendingFacilityPatientId.root","typeLabel":"string"},"extension":{"type":"string","description":"Identifier value or extension","example":"123456","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].sendingFacilityPatientId.extension","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].sendingFacilityPatientId","typeLabel":"object"},"patientClass":{"type":"string","description":"Patient class from PV1.2","example":"E","externalDocs":{"description":"See PV1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].patientClass","typeLabel":"string"},"visitNumber":{"type":"object","description":"Visit number from PV1.19","example":{"root":"FirstMemHosp","extension":"987654321"},"properties":{"root":{"type":"string","description":"Identifier's root","example":"ACME_HEALTH","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].visitNumber.root","typeLabel":"string"},"extension":{"type":"string","description":"Identifier value or extension","example":"123456","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].visitNumber.extension","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].visitNumber","typeLabel":"object"},"admitDate":{"type":"string","description":"Date portion of admit timestamp from PV1.44","format":"date","example":"2024-10-31","externalDocs":{"description":"See PV1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitDate","typeLabel":"string\u003cdate>"},"dischargeDate":{"type":"string","description":"Date portion of (first) discharge timestamp from PV1.45","format":"date","example":"2024-11-01","externalDocs":{"description":"See PV1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].dischargeDate","typeLabel":"string\u003cdate>"},"dischargeDisposition":{"type":"string","description":"Discharge disposition from PV1.36","example":"02","externalDocs":{"description":"See PV1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].dischargeDisposition","typeLabel":"string"},"dischargedToLocation":{"type":"string","description":"Discharged to location from PV1.37","example":"Home","externalDocs":{"description":"See PV1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].dischargedToLocation","typeLabel":"string"},"admitReason":{"type":"object","description":"Admit reason from PV2.3","example":{"displayName":"Stomach ache"},"properties":{"code":{"type":"string","description":"The specific code from a code system","example":"N0000175497","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitReason.code","typeLabel":"string"},"codeSystem":{"type":"string","description":"Code system OID. Must be populated if known","example":"2.16.840.1.113883.6.345","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitReason.codeSystem","typeLabel":"string"},"codeSystemName":{"type":"string","description":"Human-readable name of the code system name if known","example":"MED-RT","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitReason.codeSystemName","typeLabel":"string"},"displayName":{"type":"string","description":"Human-readable description of the code","example":"Penicillin-class Antibacterial","uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitReason.displayName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].admitReason","typeLabel":"object"},"diagnoses":{"maxItems":500,"minItems":0,"type":"array","description":"Diagnoses, one for each DG1 segment; any diagnosis without a valid ICD-10 code is ignored","example":[{"code":"R10.13","codeSystem":"I10","type":"Final"}],"externalDocs":{"description":"See DG1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/DG1"},"items":{"required":["code"],"type":"object","properties":{"code":{"minLength":1,"type":"string","description":"Diagnosis Code Identifier from DG1.3.1","example":"R10.13","externalDocs":{"description":"See DG1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/DG1"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].diagnoses.items.[INDEX].code","typeLabel":"string"},"codeSystem":{"type":"string","description":"Diagnosis Code System from DG1.3.3","example":"I10","externalDocs":{"description":"See DG1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/DG1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].diagnoses.items.[INDEX].codeSystem","typeLabel":"string"},"type":{"type":"string","description":"Diagnosis Type from DG1.6","example":"Final","externalDocs":{"description":"See DG1 segment","url":"https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/DG1"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].diagnoses.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].diagnoses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX].diagnoses","typeLabel":"object[]"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData.adtEvents","typeLabel":"object[]"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].adtEventData","typeLabel":"object"},"directives":{"type":"object","description":"Directives which may influence how the data is processed","properties":{"newPatient":{"type":"boolean","description":"Whether patient is new to the clinic (first time patient)","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.newPatient","typeLabel":"boolean"},"useCase":{"type":"string","description":"Use case to change processing options for how this request should be processed. Must be created by Connective Health prior to use.","example":"HIGH_RISK","uniqueKey":"patientProcessingRequests.items.[INDEX].directives.useCase","typeLabel":"string"},"diagnosticCategories":{"type":"object","description":"Diagnostic categories of interest regarding the patient","properties":{"autoimmune":{"type":"boolean","description":"Autoimmune diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.autoimmune","typeLabel":"boolean"},"bariatric":{"type":"boolean","description":"Bariatric diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.bariatric","typeLabel":"boolean"},"behavioral":{"type":"boolean","description":"Behavioral Health diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.behavioral","typeLabel":"boolean"},"cardiovascular":{"type":"boolean","description":"Cardiovascular diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.cardiovascular","typeLabel":"boolean"},"dental":{"type":"boolean","description":"Dental diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.dental","typeLabel":"boolean"},"dermatological":{"type":"boolean","description":"Dermatological/Integumentary diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.dermatological","typeLabel":"boolean"},"endocrinological":{"type":"boolean","description":"Endocrinological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.endocrinological","typeLabel":"boolean"},"gastroenterological":{"type":"boolean","description":"Gastroenterological/Gastrointestinal/Hepatobiliary diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.gastroenterological","typeLabel":"boolean"},"generalInformation":{"type":"boolean","description":"General diagnostic information is desired for the patient; use in conjunction with medicalSummaryPeriod to limit the data normally returned","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.generalInformation","typeLabel":"boolean"},"generalSurgery":{"type":"boolean","description":"General Surgery diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.generalSurgery","typeLabel":"boolean"},"hematological":{"type":"boolean","description":"Hematological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.hematological","typeLabel":"boolean"},"infectious":{"type":"boolean","description":"Infectious disease diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.infectious","typeLabel":"boolean"},"lymphatic":{"type":"boolean","description":"Lymphatic diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.lymphatic","typeLabel":"boolean"},"mens":{"type":"boolean","description":"Men's Health diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.mens","typeLabel":"boolean"},"metabolic":{"type":"boolean","description":"Metabolic diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.metabolic","typeLabel":"boolean"},"musculoskeletal":{"type":"boolean","description":"Musculoskeletal diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.musculoskeletal","typeLabel":"boolean"},"neonatological":{"type":"boolean","description":"Neonatological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.neonatological","typeLabel":"boolean"},"neurological":{"type":"boolean","description":"Neurological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.neurological","typeLabel":"boolean"},"nutritional":{"type":"boolean","description":"Nutritional diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.nutritional","typeLabel":"boolean"},"oncological":{"type":"boolean","description":"Oncological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.oncological","typeLabel":"boolean"},"ophthalmic":{"type":"boolean","description":"Ophthalmic diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.ophthalmic","typeLabel":"boolean"},"otolaryngological":{"type":"boolean","description":"Otolaryngological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.otolaryngological","typeLabel":"boolean"},"pain":{"type":"boolean","description":"Chronic pain-related diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.pain","typeLabel":"boolean"},"postSurgery":{"type":"boolean","description":"Post-surgery diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.postSurgery","typeLabel":"boolean"},"pulmonary":{"type":"boolean","description":"Pulmonary diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.pulmonary","typeLabel":"boolean"},"renal":{"type":"boolean","description":"Renal diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.renal","typeLabel":"boolean"},"spinal":{"type":"boolean","description":"Spinal diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.spinal","typeLabel":"boolean"},"stroke":{"type":"boolean","description":"Stroke diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.stroke","typeLabel":"boolean"},"toxicological":{"type":"boolean","description":"Toxicological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.toxicological","typeLabel":"boolean"},"urological":{"type":"boolean","description":"Urological diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.urological","typeLabel":"boolean"},"womens":{"type":"boolean","description":"Women's Health diagnostic information is desired for the patient","example":false,"default":false,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories.womens","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.diagnosticCategories","typeLabel":"object"},"medicationsOfInterest":{"type":"array","description":"Medications of interest regarding the patient. Include MedicationRequest details if known. \nThese may be displayed on documents to direct the reader's attention.\n\n**For medication filtering to work correctly**, medication request codes must be 11-digit NDCs. Therefore the code system must be \neither http://hl7.org/fhir/sid/ndc (the NDC URI) or 2.16.840.1.113883.6.69 (the NDC OID), and the code value must be an 11-digit NDC,\nwith or without dashes.","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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].nameCode.codeSystemName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].classCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].scheduleCode.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].code.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].form.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].route.codeSystemName","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.given.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name.suffix","typeLabel":"string"}},"example":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."},"isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].prescriber.name","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].facility.address.lines.items.[INDEX]","typeLabel":"string"},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].facility.address.state","typeLabel":"string"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].facility.address","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].facility","typeLabel":"object"},"initialFillQuantity":{"type":"number","description":"Quantity initially filled for the medication","format":"double","example":10,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.strengthUnit","typeLabel":"string"},"strengthValue":{"type":"number","description":"Value of the dosage strength","format":"double","example":100,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.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":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountUnit","typeLabel":"string"},"amountValue":{"type":"number","description":"Value of a single dose","format":"double","example":2,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction.amountValue","typeLabel":"number\u003cdouble>"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX].dosageInstruction","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX].medicationRequests","typeLabel":"object[]"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest.items.[INDEX]","typeLabel":"object"},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicationsOfInterest","typeLabel":"object[]"},"riskAdjustmentConfiguration":{"type":"object","description":"Chronic conditions (Risk adjustment) configuration options. If omitted, defaults to the customer default configuration.","properties":{"asthma":{"type":"object","description":"Asthma configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.asthma.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.asthma","typeLabel":"object"},"amyotrophicLateralSclerosis":{"type":"object","description":"Amyotrophic Lateral Sclerosis configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.amyotrophicLateralSclerosis.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.amyotrophicLateralSclerosis","typeLabel":"object"},"acuteStroke":{"type":"object","description":"Acute Stroke configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.acuteStroke.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.acuteStroke","typeLabel":"object"},"cancerSolidTumor":{"type":"object","description":"Cancer Solid Tumor configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.cancerSolidTumor.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.cancerSolidTumor","typeLabel":"object"},"chronicKidneyDisease":{"type":"object","description":"Chronic Kidney Disease configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.chronicKidneyDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.chronicKidneyDisease","typeLabel":"object"},"chronicObstructivePulmonaryDisease":{"type":"object","description":"Chronic Obstructive Pulmonary Disease configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.chronicObstructivePulmonaryDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.chronicObstructivePulmonaryDisease","typeLabel":"object"},"cirrhosisOfLiver":{"type":"object","description":"Cirrhosis Of Liver configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.cirrhosisOfLiver.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.cirrhosisOfLiver","typeLabel":"object"},"dementia":{"type":"object","description":"Dementia configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.dementia.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.dementia","typeLabel":"object"},"diabetes":{"type":"object","description":"Diabetes configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.diabetes.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.diabetes","typeLabel":"object"},"heartArrhythmia":{"type":"object","description":"Heart Arrhythmia configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.heartArrhythmia.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.heartArrhythmia","typeLabel":"object"},"heartFailure":{"type":"object","description":"Heart Failure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.heartFailure.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.heartFailure","typeLabel":"object"},"majorDepression":{"type":"object","description":"Major Depression configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.majorDepression.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.majorDepression","typeLabel":"object"},"morbidObesity":{"type":"object","description":"Morbid Obesity configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.morbidObesity.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.morbidObesity","typeLabel":"object"},"parkinsonsDisease":{"type":"object","description":"Parkinson's configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.parkinsonsDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.parkinsonsDisease","typeLabel":"object"},"rheumatoidArthritis":{"type":"object","description":"Rheumatoid Arthritis configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.rheumatoidArthritis.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.rheumatoidArthritis","typeLabel":"object"},"seizureDisorder":{"type":"object","description":"Seizure Disorders and Convulsions configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.seizureDisorder.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.seizureDisorder","typeLabel":"object"},"spinalCord":{"type":"object","description":"Spinal Cord Disorders and Injuries configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.spinalCord.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.spinalCord","typeLabel":"object"},"thrombocytopenia":{"type":"object","description":"Thrombocytopenia configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.thrombocytopenia.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.thrombocytopenia","typeLabel":"object"},"resolvedConditions":{"type":"object","description":"Resolved Conditions configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.resolvedConditions.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.resolvedConditions","typeLabel":"object"},"suspectedConditions":{"type":"object","description":"Suspected Conditions configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this risk adjustment insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.suspectedConditions.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration.suspectedConditions","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.riskAdjustmentConfiguration","typeLabel":"object"},"careManagementConfiguration":{"type":"object","description":"Care management configuration options. If omitted, defaults to the customer default configuration.","properties":{"amyotrophicLateralSclerosis":{"type":"object","description":"Amyotrophic Lateral Sclerosis configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.amyotrophicLateralSclerosis.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.amyotrophicLateralSclerosis","typeLabel":"object"},"chronicKidneyDisease":{"type":"object","description":"Chronic Kidney Disease configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.chronicKidneyDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.chronicKidneyDisease","typeLabel":"object"},"chronicObstructivePulmonaryDisease":{"type":"object","description":"Chronic Obstructive Pulmonary Disease configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.chronicObstructivePulmonaryDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.chronicObstructivePulmonaryDisease","typeLabel":"object"},"cirrhosisOfLiver":{"type":"object","description":"Cirrhosis Of Liver configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.cirrhosisOfLiver.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.cirrhosisOfLiver","typeLabel":"object"},"dementia":{"type":"object","description":"Dementia configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.dementia.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.dementia","typeLabel":"object"},"diabetes":{"type":"object","description":"Diabetes configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.diabetes.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.diabetes","typeLabel":"object"},"heartArrhythmia":{"type":"object","description":"Heart Arrhythmia configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.heartArrhythmia.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.heartArrhythmia","typeLabel":"object"},"heartFailure":{"type":"object","description":"Heart Failure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.heartFailure.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.heartFailure","typeLabel":"object"},"majorDepression":{"type":"object","description":"Major Depression configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.majorDepression.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.majorDepression","typeLabel":"object"},"parkinsonsDisease":{"type":"object","description":"Parkinson's configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.parkinsonsDisease.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.parkinsonsDisease","typeLabel":"object"},"rheumatoidArthritis":{"type":"object","description":"Rheumatoid Arthritis configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.rheumatoidArthritis.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.rheumatoidArthritis","typeLabel":"object"},"seizureDisorder":{"type":"object","description":"Seizure Disorders and Convulsions configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.seizureDisorder.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.seizureDisorder","typeLabel":"object"},"spinalCord":{"type":"object","description":"Spinal Cord Disorders and Injuries configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.spinalCord.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.spinalCord","typeLabel":"object"},"general":{"type":"object","description":"General configuration. Special configuration for when patient has no known conditions that require care management but is, nonetheless, a care management patient. Speak with customer success before using this feature to understand how this affects processing.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this care management insight is enabled for care summary","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.general.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration.general","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.careManagementConfiguration","typeLabel":"object"},"qualityMeasureConfiguration":{"type":"object","description":"Quality measure configuration options. If omitted, defaults to the customer default configuration.","properties":{"asOfDateOverride":{"type":"string","description":"Date to process quality rules for. \nAllows for processing rules as if the patient were being processed in a prior year (generally the previous year). \nIt is recommended to use December 31st for prior years. If specified, this must be either a current or prior year.\nThe system default is to simply use current date.","format":"date","example":"2025-12-31","uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.asOfDateOverride","typeLabel":"string\u003cdate>"},"annualWellnessVisit":{"type":"object","description":"Annual Wellness Visit measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.annualWellnessVisit.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.annualWellnessVisit","typeLabel":"object"},"cardiovascularBloodPressure":{"type":"object","description":"Blood Pressure Control measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.cardiovascularBloodPressure.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.cardiovascularBloodPressure","typeLabel":"object"},"diabeticBloodPressure":{"type":"object","description":"Blood Pressure Control for Diabetics measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticBloodPressure.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticBloodPressure","typeLabel":"object"},"diabeticEyeExam":{"type":"object","description":"Diabetic Eye Exam measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticEyeExam.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticEyeExam","typeLabel":"object"},"diabeticHba1c":{"type":"object","description":"Diabetic HbA1c measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticHba1c.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticHba1c","typeLabel":"object"},"diabeticKidneyHealth":{"type":"object","description":"Kidney Health measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticKidneyHealth.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.diabeticKidneyHealth","typeLabel":"object"},"medAdherenceBloodPressure":{"type":"object","description":"Blood Pressure Medications adherence measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceBloodPressure.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceBloodPressure","typeLabel":"object"},"medAdherenceCholesterol":{"type":"object","description":"Cholesterol Medications adherence measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceCholesterol.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceCholesterol","typeLabel":"object"},"medAdherenceDiabetes":{"type":"object","description":"Diabetes Medications adherence measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceDiabetes.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.medAdherenceDiabetes","typeLabel":"object"},"screeningBreastCancer":{"type":"object","description":"Breast Cancer Screening measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningBreastCancer.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningBreastCancer","typeLabel":"object"},"screeningCervicalCancer":{"type":"object","description":"Cervical Cancer Screening measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningCervicalCancer.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningCervicalCancer","typeLabel":"object"},"screeningColorectal":{"type":"object","description":"Colorectal Screening measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningColorectal.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningColorectal","typeLabel":"object"},"screeningDepression":{"type":"object","description":"Depression Screening measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningDepression.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningDepression","typeLabel":"object"},"vaccineFlu":{"type":"object","description":"Flu Vaccine measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.vaccineFlu.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.vaccineFlu","typeLabel":"object"},"vaccinePneumococcal":{"type":"object","description":"Pneumococcal Vaccine measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.vaccinePneumococcal.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.vaccinePneumococcal","typeLabel":"object"},"screeningTobaccoUse":{"type":"object","description":"Tobacco Use screening measure configuration","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the measure is enabled for quality reporting","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningTobaccoUse.enabled","typeLabel":"boolean"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration.screeningTobaccoUse","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.qualityMeasureConfiguration","typeLabel":"object"},"medicalSummaryPeriod":{"type":"object","description":"Processing hint which influences the inclusive date range for data returned on the medical summary. If this is used, at least one diagnostic category must also be enabled.","required":["startDate"],"properties":{"startDate":{"type":"string","description":"Beginning of the period, inclusive","format":"date","example":"2022-12-12","isRequired":true,"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicalSummaryPeriod.startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","description":"End of the period, inclusive","format":"date","example":"2022-12-14","uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicalSummaryPeriod.endDate","typeLabel":"string\u003cdate>"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives.medicalSummaryPeriod","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX].directives","typeLabel":"object"}},"uniqueKey":"patientProcessingRequests.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"patientProcessingRequests","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 if not populated","example":"BATCH-123","x-pattern-message":"Should not contain special characters","uniqueKey":"batchId","typeLabel":"string"},"patientPanelDirectives":{"type":"object","description":"Directives which may influence how the data is processed. Applies to all requests in this panel.","properties":{"requestMedicationHistory":{"type":"boolean","description":"Whether pharmacy medication history information should be requested prior to any further processing.\nNote: only a limited number of batches are allowed per day with this flag set to true.\nMake sure patients are batched together in groups.\nContact your customer success representative for more details on usage of this feature.","example":true,"default":false,"uniqueKey":"patientPanelDirectives.requestMedicationHistory","typeLabel":"boolean"},"deliverableDocuments":{"type":"array","description":"Created documents to be potentially delivered. Do not populate unless overriding the customer defaults is necessary. An empty list means no documents should be delivered.","items":{"type":"string","enum":["PATIENT_CARE_SUMMARY","QUALITY_MEASURES_SUMMARY"],"uniqueKey":"patientPanelDirectives.deliverableDocuments.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["PATIENT_CARE_SUMMARY","QUALITY_MEASURES_SUMMARY"],"uniqueKey":"patientPanelDirectives.deliverableDocuments","typeLabel":"enum\u003cstring>[]"},"principalOid":{"type":"string","description":"OID of the organization which is the principal entity in the health care transaction. e.g. 2.16.840.1.113883.3.9359.1","uniqueKey":"patientPanelDirectives.principalOid","typeLabel":"string"}},"uniqueKey":"patientPanelDirectives","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"patientProcessingRequests":[{"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"}]},"requestingProvider":{"npi":"1414912117","name":{"family":"Johnson","given":["John","Aaron"],"prefix":"Mr.","suffix":"Jr."}},"upcomingAppointmentDate":"2025-11-05","enrollmentDate":"2025-11-05","clinicName":"Simple Clinic Name","clinicNpi":"1414912117","responseDirectAddress":"contact@yourdomain.com","responseFriendlyName":"Heart Clinic","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"}}],"directives":{"newPatient":false,"useCase":"HIGH_RISK","diagnosticCategories":{"autoimmune":false,"bariatric":false,"behavioral":false,"cardiovascular":false,"dental":false,"dermatological":false,"endocrinological":false,"gastroenterological":false,"generalInformation":false,"generalSurgery":false,"hematological":false,"infectious":false,"lymphatic":false,"mens":false,"metabolic":false,"musculoskeletal":false,"neonatological":false,"neurological":false,"nutritional":false,"oncological":false,"ophthalmic":false,"otolaryngological":false,"pain":false,"postSurgery":false,"pulmonary":false,"renal":false,"spinal":false,"stroke":false,"toxicological":false,"urological":false,"womens":false},"medicationsOfInterest":[{"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}}]}],"riskAdjustmentConfiguration":{},"careManagementConfiguration":{},"qualityMeasureConfiguration":{"asOfDateOverride":"2025-12-31"}}}],"batchId":"BATCH-123","patientPanelDirectives":{"requestMedicationHistory":true,"deliverableDocuments":["PATIENT_CARE_SUMMARY","QUALITY_MEASURES_SUMMARY"],"principalOid":"\u003cstring>"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"ed6a7d33-9f5f-4c18-8c94-8d6b3369266a":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique overall Connective Health identifier to correlate subsequent processing or troubleshooting","example":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","uniqueKey":"correlationId","typeLabel":"string"},"responses":{"type":"array","description":"Response details about each individual request in the panel","items":{"type":"object","properties":{"sequenceNumber":{"type":"integer","description":"Zero-based sequence number for which element in the original request this response is for","format":"int32","example":0,"uniqueKey":"responses.items.[INDEX].sequenceNumber","typeLabel":"integer\u003cint32>"},"correlationId":{"type":"string","description":"Unique Connective Health identifier to correlate subsequent processing or troubleshooting","example":"e5c3310a-6cb4-4755-a5c2-35b99d946181","uniqueKey":"responses.items.[INDEX].correlationId","typeLabel":"string"}},"uniqueKey":"responses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"responses","typeLabel":"object[]"}},"example":{"correlationId":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","responses":[{"sequenceNumber":0,"correlationId":"4b0b3bdc-d007-4274-b1c7-f89fbb2fd775"},{"sequenceNumber":1,"correlationId":"e82a9cfb-a6cd-4194-a0fd-9882b3a4e76b"},{"sequenceNumber":2,"correlationId":"e5c3310a-6cb4-4755-a5c2-35b99d946181"}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"correlationId":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","responses":[{"sequenceNumber":0,"correlationId":"4b0b3bdc-d007-4274-b1c7-f89fbb2fd775"},{"sequenceNumber":1,"correlationId":"e82a9cfb-a6cd-4194-a0fd-9882b3a4e76b"},{"sequenceNumber":2,"correlationId":"e5c3310a-6cb4-4755-a5c2-35b99d946181"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e4523e45-09e7-4f73-8ef1-8af11b8679ae":{"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"},"f5fff6d8-6eed-4570-a314-b126dc1b2a4d":{"description":"Missing or invalid apikey","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique overall Connective Health identifier to correlate subsequent processing or troubleshooting","example":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","uniqueKey":"correlationId","typeLabel":"string"},"responses":{"type":"array","description":"Response details about each individual request in the panel","items":{"type":"object","properties":{"sequenceNumber":{"type":"integer","description":"Zero-based sequence number for which element in the original request this response is for","format":"int32","example":0,"uniqueKey":"responses.items.[INDEX].sequenceNumber","typeLabel":"integer\u003cint32>"},"correlationId":{"type":"string","description":"Unique Connective Health identifier to correlate subsequent processing or troubleshooting","example":"e5c3310a-6cb4-4755-a5c2-35b99d946181","uniqueKey":"responses.items.[INDEX].correlationId","typeLabel":"string"}},"uniqueKey":"responses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"responses","typeLabel":"object[]"}},"example":{"correlationId":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","responses":[{"sequenceNumber":0,"correlationId":"4b0b3bdc-d007-4274-b1c7-f89fbb2fd775"},{"sequenceNumber":1,"correlationId":"e82a9cfb-a6cd-4194-a0fd-9882b3a4e76b"},{"sequenceNumber":2,"correlationId":"e5c3310a-6cb4-4755-a5c2-35b99d946181"}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"correlationId":"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89","responses":[{"sequenceNumber":0,"correlationId":"4b0b3bdc-d007-4274-b1c7-f89fbb2fd775"},{"sequenceNumber":1,"correlationId":"e82a9cfb-a6cd-4194-a0fd-9882b3a4e76b"},{"sequenceNumber":2,"correlationId":"e5c3310a-6cb4-4755-a5c2-35b99d946181"}]}}},"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":"Patient Data v2 Validate - Connective Health","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T17:28:54.317Z","originalFileLocation":"clinical-data/patient-data-v2-validate.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=\"Validates the request without doing any processing\">\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=\"Patient Data v2 Validate - Connective Health\">\u003cmeta data-mint-head property=\"og:description\" content=\"Validates the request without doing any processing\">\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/patient-data-v2-validate\">\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=Patient+Data+v2+Validate\u0026amp;description=Validates+the+request+without+doing+any+processing\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=8b6800a1494d5edfc7656f57187f6cc1d61ffcaf2ebadcb9862c52a5f5f5873c\">\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=\"Patient Data v2 Validate - Connective Health\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validates the request without doing any processing\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://connectivehealth.mintlify.app/_mintlify/api/og/v2?division=Clinical+Data\u0026amp;title=Patient+Data+v2+Validate\u0026amp;description=Validates+the+request+without+doing+any+processing\u0026amp;theme=388cf9209d0d35b2cfc9a9d5\u0026amp;signature=8b6800a1494d5edfc7656f57187f6cc1d61ffcaf2ebadcb9862c52a5f5f5873c\">\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/patient-data-v2-validate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/clinical-data/patient-data-v2-validate.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/patient-data-v2-validate#webpage\",\"url\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate\",\"name\":\"Patient Data v2 Validate\",\"description\":\"Validates the request without doing any processing\",\"dateModified\":\"2026-01-23T17:28:54.317Z\",\"isPartOf\":{\"@id\":\"https://docs.connectivehealth.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate#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\":\"Patient Data v2 Validate\",\"item\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate#apireference\",\"headline\":\"Patient Data v2 Validate\",\"name\":\"Patient Data v2 Validate\",\"description\":\"Validates the request without doing any processing\",\"url\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.connectivehealth.io/clinical-data/patient-data-v2-validate#webpage\"},\"dateModified\":\"2026-01-23T17:28:54.317Z\",\"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","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-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","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":"Patient Data v2 Validate - 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"]}