> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectivehealth.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Patient Data v2

> 
# Data Requirements

**Populate all known data**. It is required for processing that as much information as possible is supplied.

All active clinical information for a patient should be supplied in every API request.
That information is used to satisfy reciprocity requirements of the various health information exchanges
that Connective Health participates in. Failure to populate known clinical information for a patient is
a violation of health information exchange reciprocity rules, and may result in the termination of information exchange.

## Overview
Standard processing for clinical patient information, both summarized and complete information is supported.



## OpenAPI

````yaml post /v2/patient-data/process
openapi: 3.0.1
info:
  title: Processing Request API
  description: API for processing of a patient
  termsOfService: https://connectivehealth.io/website-terms-of-use/
  contact:
    name: Connective Health Tech Support
    url: https://connectivehealth.io
    email: techsupport@connectivehealth.io
  version: 3.23.0
servers:
  - url: https://processing-request-staging.connectivehealth.io/
    description: Customer testing site. Test data only. No PHI.
  - url: https://processing-request-production.connectivehealth.io/
    description: Customer production site. Real patient information is only supported here.
security:
  - apiKey: []
paths:
  /v2/patient-data/process:
    post:
      tags:
        - Patient Processing Panel
      summary: Patient Processing Panel
      description: >-

        # Data Requirements


        **Populate all known data**. It is required for processing that as much
        information as possible is supplied.


        All active clinical information for a patient should be supplied in
        every API request.

        That information is used to satisfy reciprocity requirements of the
        various health information exchanges

        that Connective Health participates in. Failure to populate known
        clinical information for a patient is

        a violation of health information exchange reciprocity rules, and may
        result in the termination of information exchange.


        ## Overview

        Standard processing for clinical patient information, both summarized
        and complete information is supported.
      operationId: processPatientProcessingPanel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientProcessingPanel'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientProcessingPanelResponse'
        '400':
          description: Validation problems
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonError'
        '401':
          description: Missing or invalid apikey
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientProcessingPanelResponse'
        '403':
          description: Missing permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientProcessingPanelResponse'
components:
  schemas:
    PatientProcessingPanel:
      required:
        - patientProcessingRequests
      type: object
      properties:
        patientProcessingRequests:
          maxItems: 2500
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/PatientProcessingRequest'
        batchId:
          pattern: '[^<>"%;+@]*$'
          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
        patientPanelDirectives:
          description: >-
            Directives which may influence how the data is processed. Applies to
            all requests in this panel.
          allOf:
            - $ref: '#/components/schemas/PatientPanelDirectives'
    PatientProcessingPanelResponse:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            Unique overall Connective Health identifier to correlate subsequent
            processing or troubleshooting
          example: 10c7b080-76f2-4aff-beeb-a2f7b4ca7a89
        responses:
          type: array
          description: Response details about each individual request in the panel
          items:
            $ref: '#/components/schemas/PatientProcessingResponse'
      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
    JsonError:
      required:
        - message
      type: object
      allOf:
        - $ref: '#/components/schemas/AbstractResource_JsonError_'
        - type: object
          properties:
            message:
              type: string
            logref:
              $ref: '#/components/schemas/JsonError'
            path:
              $ref: '#/components/schemas/JsonError'
            _links:
              $ref: '#/components/schemas/OptionalMultiValues_Link_'
            _embedded:
              $ref: '#/components/schemas/OptionalMultiValues_Resource_'
    PatientProcessingRequest:
      required:
        - patient
        - requestingProvider
      type: object
      properties:
        patient:
          $ref: '#/components/schemas/Patient_1'
        upcomingAppointmentDate:
          type: string
          description: Date of the appointment in ISO-8601 format yyyy-MM-dd
          format: date
          example: '2025-11-05'
        requestingProvider:
          $ref: '#/components/schemas/Provider'
        clinicName:
          pattern: '[^<>"%;+@]*$'
          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
        clinicNpi:
          maxLength: 10
          minLength: 10
          type: string
          description: Facility's NPI if known
          example: '1414912117'
          x-size-message: NPI must be exactly 10 characters
        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
        responseFriendlyName:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Human-readable name to send response message to
          example: Heart Clinic
          x-pattern-message: Should not contain special characters
        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:
            $ref: '#/components/schemas/Diagnosis_1'
        medications:
          type: array
          description: All known medications about the patient
          items:
            $ref: '#/components/schemas/Medication'
        clinicalNotes:
          type: array
          description: Additional information provided about the patient
          items:
            $ref: '#/components/schemas/ClinicalNote'
        adtEventData:
          description: >-
            ADT event information about the patient; populating this field
            requires ADT feature authorization enabled on customer account
          allOf:
            - $ref: '#/components/schemas/AdtEventData'
        directives:
          description: Directives which may influence how the data is processed
          allOf:
            - $ref: '#/components/schemas/Directives'
    PatientPanelDirectives:
      type: object
      properties:
        requestMedicationHistory:
          type: boolean
          description: >-
            Whether pharmacy medication history information should be requested
            prior to any further processing.

            Note: only a limited number of batches are allowed per day with this
            flag set to true.

            Make sure patients are batched together in groups.

            Contact your customer success representative for more details on
            usage of this feature.
          example: true
          default: false
        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:
            $ref: '#/components/schemas/DeliverableDocumentType'
          default:
            - PATIENT_CARE_SUMMARY
            - QUALITY_MEASURES_SUMMARY
        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
      description: >-
        Directives which may influence how the data is processed. Applies to all
        requests in this panel.
    PatientProcessingResponse:
      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
        correlationId:
          type: string
          description: >-
            Unique Connective Health identifier to correlate subsequent
            processing or troubleshooting
          example: e5c3310a-6cb4-4755-a5c2-35b99d946181
    AbstractResource_JsonError_:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/OptionalMultiValues_Link_'
        _embedded:
          $ref: '#/components/schemas/OptionalMultiValues_Resource_'
    OptionalMultiValues_Link_:
      $ref: '#/components/schemas/OptionalValues_List_Link__'
    OptionalMultiValues_Resource_:
      $ref: '#/components/schemas/OptionalValues_List_Resource__'
    Patient_1:
      required:
        - addresses
        - birthDate
        - gender
        - mrn
        - name
      type: object
      properties:
        mrn:
          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
          allOf:
            - $ref: '#/components/schemas/PatientIdentifier'
        name:
          $ref: '#/components/schemas/Name'
        gender:
          $ref: '#/components/schemas/Gender'
        birthDate:
          type: string
          description: Birth date of the patient in ISO-8601 format yyyy-MM-dd
          format: date
          example: '1992-04-09'
        addresses:
          maxItems: 3
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/Address'
        contactPoints:
          type: array
          items:
            $ref: '#/components/schemas/ContactPoint'
      description: Patient to be processed
    Provider:
      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
        name:
          $ref: '#/components/schemas/Name'
      description: A medical provider
    Diagnosis_1:
      required:
        - active
        - code
        - codeSystem
        - displayName
      type: object
      properties:
        code:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          type: string
          description: The diagnosis code including punctuation
          example: E66.01
          x-pattern-message: Should not contain special characters
        codeSystem:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          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
        displayName:
          minLength: 1
          type: string
          description: The display value for the diagnosis
          example: Morbid (severe) obesity due to excess calories
        date:
          type: string
          description: Date of the problem (onset or diagnosed)
          format: date
          example: '2022-12-12'
        active:
          type: boolean
          description: Whether the diagnosis is still active or not
          example: true
        diseaseManagement:
          description: >-
            Risk adjustment disease management information. This information is
            only applicable for risk adjustment patient processing.
          allOf:
            - $ref: '#/components/schemas/DiseaseManagement'
    Medication:
      required:
        - active
        - nameCode
      type: object
      properties:
        active:
          type: boolean
          description: Whether this medication is being actively used by the patient
          example: true
        nameCode:
          description: Medication name code. Code system should be RxNorm if possible
          example:
            code: '6809'
            codeSystem: 2.16.840.1.113883.6.88
            codeSystemName: RxNorm
            displayName: metFORMIN
          allOf:
            - $ref: '#/components/schemas/Code'
        classCode:
          description: Medication class code. Code system should be MED-RT if possible
          example:
            code: N0000175565
            codeSystem: 2.16.840.1.113883.6.345
            codeSystemName: MED-RT
            displayName: Biguanide
          allOf:
            - $ref: '#/components/schemas/Code'
        scheduleCode:
          description: Medication schedule code.
          example:
            code: IV
            codeSystem: 2.16.840.1.113883.12.477
            codeSystemName: Controlled Substance Schedule
            displayName: Schedule IV
          allOf:
            - $ref: '#/components/schemas/Code'
        medicationRequests:
          type: array
          items:
            $ref: '#/components/schemas/MedicationRequest'
    ClinicalNote:
      required:
        - lines
      type: object
      properties:
        author:
          $ref: '#/components/schemas/Provider'
        date:
          type: string
          description: Date the note was recorded or written.
          format: date
          example: '2022-12-12'
        code:
          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
          example:
            code: 11506-3
            codeSystem: 2.16.840.1.113883.6.1
            codeSystemName: LOINC
            displayName: Progress Note
          allOf:
            - $ref: '#/components/schemas/FullyValidatedCode'
        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
    AdtEventData:
      type: object
      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:
            $ref: '#/components/schemas/AdtEvent'
      description: >-
        ADT event information about the patient; populating this field requires
        ADT feature authorization enabled on customer account
    Directives:
      type: object
      properties:
        newPatient:
          type: boolean
          description: Whether patient is new to the clinic (first time patient)
          example: false
          default: false
        diagnosticCategories:
          description: Diagnostic categories of interest regarding the patient
          allOf:
            - $ref: '#/components/schemas/DiagnosticCategories'
        medicationsOfInterest:
          type: array
          description: >-
            Medications of interest regarding the patient. Include
            MedicationRequest details if known. 

            These may be displayed on documents to direct the reader's
            attention.


            **For medication filtering to work correctly**, medication request
            codes must be 11-digit NDCs. Therefore the code system must be 

            either 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,

            with or without dashes.
          items:
            $ref: '#/components/schemas/Medication'
        riskAdjustmentConfiguration:
          description: >-
            Chronic conditions (Risk adjustment) configuration options. If
            omitted, defaults to the customer default configuration.
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentConfiguration'
        careManagementConfiguration:
          description: >-
            Care management configuration options. If omitted, defaults to the
            customer default configuration.
          allOf:
            - $ref: '#/components/schemas/CareManagementConfiguration'
        qualityMeasureConfiguration:
          description: >-
            Quality measure configuration options. If omitted, defaults to the
            customer default configuration.
          allOf:
            - $ref: '#/components/schemas/QualityMeasureConfiguration'
        medicalSummaryPeriod:
          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.
          allOf:
            - $ref: '#/components/schemas/Period'
      description: Directives which may influence how the data is processed
    DeliverableDocumentType:
      type: string
      enum:
        - PATIENT_CARE_SUMMARY
        - QUALITY_MEASURES_SUMMARY
    OptionalValues_List_Link__:
      type: object
      properties:
        empty:
          type: boolean
    OptionalValues_List_Resource__:
      type: object
      properties:
        empty:
          type: boolean
    PatientIdentifier:
      required:
        - extension
        - root
      type: object
      properties:
        root:
          minLength: 1
          type: string
          description: Identifier's root, generally an OID
          example: 1.2.3.4
        extension:
          minLength: 1
          pattern: '[^()<>"%;+@]*$'
          type: string
          description: Identifier value or extension
          example: ABC123
          x-pattern-message: Should not contain special characters
      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
    Name:
      required:
        - family
        - given
      type: object
      properties:
        family:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Family name (last name)
          example: Johnson
          x-pattern-message: Should not contain special characters
        given:
          pattern: '[^<>"%;+@]*$'
          minItems: 1
          type: array
          description: First and middle names. First name (at least) is required
          items:
            pattern: '[^<>"%;+@]*$'
            type: string
            x-pattern-message: Should not contain special characters
        prefix:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Name prefix
          example: Mr.
          x-pattern-message: Should not contain special characters
        suffix:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Name suffix
          example: Jr.
          x-pattern-message: Should not contain special characters
      example:
        family: Johnson
        given:
          - John
          - Aaron
        prefix: Mr.
        suffix: Jr.
    Gender:
      type: string
      enum:
        - MALE
        - FEMALE
        - OTHER
        - UNKNOWN
    Address:
      required:
        - zip
      type: object
      properties:
        lines:
          pattern: '[^<>"%;+@]*$'
          type: array
          description: Street lines of the address
          items:
            pattern: '[^<>"%;+@]*$'
            type: string
            x-pattern-message: Should not contain special characters
        city:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: The city
          example: Minneapolis
          x-pattern-message: Should not contain special characters
        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
        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
      example:
        lines:
          - 123 Main St
          - Suite 517
        city: Minneapolis
        state: MN
        zip: '55401'
    ContactPoint:
      required:
        - contactPointSystem
        - contactPointUse
        - value
      type: object
      properties:
        value:
          minLength: 1
          type: string
          description: Phone number or email address
          example: '9525551234'
        contactPointSystem:
          description: Type of contact
          example: PHONE
          allOf:
            - $ref: '#/components/schemas/ContactPointSystem'
        contactPointUse:
          description: Use for the contact
          example: HOME
          allOf:
            - $ref: '#/components/schemas/ContactPointUse'
    DiseaseManagement:
      required:
        - details
      type: object
      properties:
        details:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DiseaseManagementDetail'
      description: >-
        Risk adjustment disease management information. This information is only
        applicable for risk adjustment patient processing.
    Code:
      required:
        - displayName
      type: object
      properties:
        code:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: The specific code from a code system
          example: N0000175497
          x-pattern-message: Should not contain special characters
        codeSystem:
          pattern: '[^<>"%;+@]*$'
          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
        codeSystemName:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Human-readable name of the code system name if known
          example: MED-RT
          x-pattern-message: Should not contain special characters
        displayName:
          minLength: 1
          type: string
          description: Human-readable description of the code
          example: Penicillin-class Antibacterial
      description: A code value within a given code system, along with human-readable names
      example:
        code: '6809'
        codeSystem: 2.16.840.1.113883.6.88
        codeSystemName: RxNorm
        displayName: metFORMIN
    MedicationRequest:
      type: object
      properties:
        code:
          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.
          example:
            code: '861007'
            codeSystem: 2.16.840.1.113883.6.88
            codeSystemName: RxNorm
            displayName: metFORMIN hydrochloride 500 MG Oral Tablet
          allOf:
            - $ref: '#/components/schemas/Code'
        form:
          description: >-
            Form the medication is in. Code system should be NCI Thesaurus if
            possible
          example:
            code: C42998
            codeSystem: 2.16.840.1.113883.3.26.1.1
            codeSystemName: NCI Thesaurus
            displayName: tablet
          allOf:
            - $ref: '#/components/schemas/Code'
        route:
          description: Route by which the medication is administered
          example:
            code: C38288
            codeSystem: 2.16.840.1.113883.3.26.1.1
            codeSystemName: NCI Thesaurus
            displayName: oral
          allOf:
            - $ref: '#/components/schemas/Code'
        prescribedDate:
          type: string
          description: Date the medication was prescribed, in ISO-8601 format yyyy-MM-dd
          format: date
          example: '2023-12-02'
        prescriber:
          description: Prescriber of the medication
          allOf:
            - $ref: '#/components/schemas/Provider'
        facility:
          description: Facility where the medication was prescribed
          allOf:
            - $ref: '#/components/schemas/Facility'
        initialFillQuantity:
          type: number
          description: Quantity initially filled for the medication
          format: double
          example: 10
        numberOfRefillsAllowed:
          type: integer
          description: Number of refills allowed for this prescription
          format: int32
          example: 0
        timingEvent:
          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
          example: QD
          allOf:
            - $ref: '#/components/schemas/TimingEvent'
        frequencyUnit:
          pattern: '[^<>"%;+@]*$'
          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
        frequencyValue:
          type: number
          description: >-
            Frequency at which the medication should be taken. Should be
            consistent with timingEvent if both populated
          format: double
          example: 1
        dosageInstruction:
          $ref: '#/components/schemas/Dosage'
    FullyValidatedCode:
      required:
        - code
        - codeSystem
        - codeSystemName
        - displayName
      type: object
      properties:
        code:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          type: string
          description: The specific code from a code system
          example: N0000175497
          x-pattern-message: Should not contain special characters
        codeSystem:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          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
        codeSystemName:
          minLength: 1
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Human-readable name of the code system name if known
          example: MED-RT
          x-pattern-message: Should not contain special characters
        displayName:
          minLength: 1
          type: string
          description: Human-readable description of the code
          example: Penicillin-class Antibacterial
      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
      example:
        code: 11506-3
        codeSystem: 2.16.840.1.113883.6.1
        codeSystemName: LOINC
        displayName: Progress Note
    AdtEvent:
      required:
        - classification
        - eventType
        - messageId
        - sendingFacilityName
        - timestamp
      type: object
      properties:
        classification:
          description: Reason why this event is included on request
          example: MAIN
          allOf:
            - $ref: '#/components/schemas/AdtEventClassification'
        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
        eventType:
          description: ADT event type, generally from MSH.9.2 (EVN.1 in older messages)
          example: A03
          externalDocs:
            description: See MSH segment
            url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/MSH
          allOf:
            - $ref: '#/components/schemas/AdtEventType'
        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
        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.907Z'
          externalDocs:
            description: See EVN segment
            url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/EVN
        sendingFacilityPatientId:
          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
          externalDocs:
            description: See PID segment
            url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PID
          allOf:
            - $ref: '#/components/schemas/AdtIdentifier'
        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
        visitNumber:
          description: Visit number from PV1.19
          example:
            root: FirstMemHosp
            extension: '987654321'
          externalDocs:
            description: See PV1 segment
            url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV1
          allOf:
            - $ref: '#/components/schemas/AdtIdentifier'
        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
        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
        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
        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
        admitReason:
          description: Admit reason from PV2.3
          example:
            displayName: Stomach ache
          externalDocs:
            description: See PV2 segment
            url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV2
          allOf:
            - $ref: '#/components/schemas/AdtCode'
        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:
            $ref: '#/components/schemas/AdtEventDiagnosis'
    DiagnosticCategories:
      type: object
      properties:
        autoimmune:
          type: boolean
          description: Autoimmune diagnostic information is desired for the patient
          example: false
          default: false
        bariatric:
          type: boolean
          description: Bariatric diagnostic information is desired for the patient
          example: false
          default: false
        behavioral:
          type: boolean
          description: Behavioral Health diagnostic information is desired for the patient
          example: false
          default: false
        cardiovascular:
          type: boolean
          description: Cardiovascular diagnostic information is desired for the patient
          example: false
          default: false
        dental:
          type: boolean
          description: Dental diagnostic information is desired for the patient
          example: false
          default: false
        dermatological:
          type: boolean
          description: >-
            Dermatological/Integumentary diagnostic information is desired for
            the patient
          example: false
          default: false
        endocrinological:
          type: boolean
          description: Endocrinological diagnostic information is desired for the patient
          example: false
          default: false
        gastroenterological:
          type: boolean
          description: >-
            Gastroenterological/Gastrointestinal/Hepatobiliary diagnostic
            information is desired for the patient
          example: false
          default: false
        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
        generalSurgery:
          type: boolean
          description: General Surgery diagnostic information is desired for the patient
          example: false
          default: false
        hematological:
          type: boolean
          description: Hematological diagnostic information is desired for the patient
          example: false
          default: false
        infectious:
          type: boolean
          description: Infectious disease diagnostic information is desired for the patient
          example: false
          default: false
        lymphatic:
          type: boolean
          description: Lymphatic diagnostic information is desired for the patient
          example: false
          default: false
        mens:
          type: boolean
          description: Men's Health diagnostic information is desired for the patient
          example: false
          default: false
        metabolic:
          type: boolean
          description: Metabolic diagnostic information is desired for the patient
          example: false
          default: false
        musculoskeletal:
          type: boolean
          description: Musculoskeletal diagnostic information is desired for the patient
          example: false
          default: false
        neonatological:
          type: boolean
          description: Neonatological diagnostic information is desired for the patient
          example: false
          default: false
        neurological:
          type: boolean
          description: Neurological diagnostic information is desired for the patient
          example: false
          default: false
        nutritional:
          type: boolean
          description: Nutritional diagnostic information is desired for the patient
          example: false
          default: false
        oncological:
          type: boolean
          description: Oncological diagnostic information is desired for the patient
          example: false
          default: false
        ophthalmic:
          type: boolean
          description: Ophthalmic diagnostic information is desired for the patient
          example: false
          default: false
        otolaryngological:
          type: boolean
          description: Otolaryngological diagnostic information is desired for the patient
          example: false
          default: false
        pain:
          type: boolean
          description: >-
            Chronic pain-related diagnostic information is desired for the
            patient
          example: false
          default: false
        postSurgery:
          type: boolean
          description: Post-surgery diagnostic information is desired for the patient
          example: false
          default: false
        pulmonary:
          type: boolean
          description: Pulmonary diagnostic information is desired for the patient
          example: false
          default: false
        renal:
          type: boolean
          description: Renal diagnostic information is desired for the patient
          example: false
          default: false
        spinal:
          type: boolean
          description: Spinal diagnostic information is desired for the patient
          example: false
          default: false
        stroke:
          type: boolean
          description: Stroke diagnostic information is desired for the patient
          example: false
          default: false
        toxicological:
          type: boolean
          description: Toxicological diagnostic information is desired for the patient
          example: false
          default: false
        urological:
          type: boolean
          description: Urological diagnostic information is desired for the patient
          example: false
          default: false
        womens:
          type: boolean
          description: Women's Health diagnostic information is desired for the patient
          example: false
          default: false
      description: Diagnostic categories of interest regarding the patient
    RiskAdjustmentConfiguration:
      type: object
      properties:
        asthma:
          description: Asthma configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        amyotrophicLateralSclerosis:
          description: Amyotrophic Lateral Sclerosis configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        acuteStroke:
          description: Acute Stroke configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        cancerSolidTumor:
          description: Cancer Solid Tumor configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        chronicKidneyDisease:
          description: Chronic Kidney Disease configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        chronicObstructivePulmonaryDisease:
          description: Chronic Obstructive Pulmonary Disease configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        cirrhosisOfLiver:
          description: Cirrhosis Of Liver configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        dementia:
          description: Dementia configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        diabetes:
          description: Diabetes configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        heartArrhythmia:
          description: Heart Arrhythmia configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        heartFailure:
          description: Heart Failure configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        majorDepression:
          description: Major Depression configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        morbidObesity:
          description: Morbid Obesity configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        parkinsonsDisease:
          description: Parkinson's configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        rheumatoidArthritis:
          description: Rheumatoid Arthritis configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        thrombocytopenia:
          description: Thrombocytopenia configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        resolvedConditions:
          description: Resolved Conditions configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
        suspectedConditions:
          description: Suspected Conditions configuration
          allOf:
            - $ref: '#/components/schemas/RiskAdjustmentInsight'
      description: >-
        Risk adjustment configuration. Each condition may be individually
        enabled or disabled. Omitting a condition is the same as disabling it.
        This configuration is only effective for customers with the risk
        adjustment feature enabled.
    CareManagementConfiguration:
      type: object
      properties:
        amyotrophicLateralSclerosis:
          description: Amyotrophic Lateral Sclerosis configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        chronicKidneyDisease:
          description: Chronic Kidney Disease configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        chronicObstructivePulmonaryDisease:
          description: Chronic Obstructive Pulmonary Disease configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        cirrhosisOfLiver:
          description: Cirrhosis Of Liver configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        dementia:
          description: Dementia configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        diabetes:
          description: Diabetes configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        heartArrhythmia:
          description: Heart Arrhythmia configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        heartFailure:
          description: Heart Failure configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        majorDepression:
          description: Major Depression configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        parkinsonsDisease:
          description: Parkinson's configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        rheumatoidArthritis:
          description: Rheumatoid Arthritis configuration
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
        general:
          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.
          allOf:
            - $ref: '#/components/schemas/CareManagementInsight'
      description: >-
        Care Management configuration. Each condition may be individually
        enabled or disabled. Omitting a condition is the same as disabling it.
        This configuration is only effective for customers with the care
        management feature enabled.
    QualityMeasureConfiguration:
      type: object
      properties:
        asOfDateOverride:
          type: string
          description: >-
            Date to process quality rules for. 

            Allows for processing rules as if the patient were being processed
            in a prior year (generally the previous year). 

            It is recommended to use December 31st for prior years. If
            specified, this must be either a current or prior year.

            The system default is to simply use current date.
          format: date
          example: '2025-12-31'
        annualWellnessVisit:
          description: Annual Wellness Visit measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        cardiovascularBloodPressure:
          description: Blood Pressure Control measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        diabeticBloodPressure:
          description: Blood Pressure Control for Diabetics measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        diabeticEyeExam:
          description: Diabetic Eye Exam measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        diabeticHba1c:
          description: Diabetic HbA1c measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        diabeticKidneyHealth:
          description: Kidney Health measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        medAdherenceBloodPressure:
          description: Blood Pressure Medications adherence measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        medAdherenceCholesterol:
          description: Cholesterol Medications adherence measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        medAdherenceDiabetes:
          description: Diabetes Medications adherence measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        screeningBreastCancer:
          description: Breast Cancer Screening measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        screeningCervicalCancer:
          description: Cervical Cancer Screening measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        screeningColorectal:
          description: Colorectal Screening measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        screeningDepression:
          description: Depression Screening measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        vaccineFlu:
          description: Flu Vaccine measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
        screeningTobaccoUse:
          description: Tobacco Use screening measure configuration
          allOf:
            - $ref: '#/components/schemas/QualityMeasure'
      description: >-
        Quality measure configuration. Each measure may be individually enabled
        or disabled. Omitting a measure is the same as disabling it.
    Period:
      required:
        - startDate
      type: object
      properties:
        startDate:
          type: string
          description: Beginning of the period, inclusive
          format: date
          example: '2022-12-12'
        endDate:
          type: string
          description: End of the period, inclusive
          format: date
          example: '2022-12-14'
      description: >-
        Period of time this encounter took place. If end date is not specified
        then it will be defaulted to the start date
    ContactPointSystem:
      type: string
      description: Type of contact
      example: PHONE
      enum:
        - PHONE
        - EMAIL
    ContactPointUse:
      type: string
      description: Use for the contact
      example: HOME
      enum:
        - HOME
        - WORK
        - MOBILE
    DiseaseManagementDetail:
      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'
        provider:
          description: Provider who documented the recapture
          allOf:
            - $ref: '#/components/schemas/Provider'
        facility:
          description: Facility or clinic where the recapture was performed
          allOf:
            - $ref: '#/components/schemas/Facility'
    Facility:
      required:
        - name
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Facility Name
          example: ABC Clinic
        address:
          description: Facility Address
          allOf:
            - $ref: '#/components/schemas/Address'
      description: Facility where the medication was prescribed
    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
      example: QD
      enum:
        - BID
        - TID
        - QID
        - AM
        - PM
        - QD
        - QOD
        - Q1H
        - Q2H
        - Q3H
        - Q4H
        - Q6H
        - Q8H
        - BED
        - WK
        - MO
    Dosage:
      type: object
      properties:
        text:
          type: string
          description: Prescriber's sig, or directions for taking the medication
          example: take 1 tablet by mouth once daily
        strengthUnit:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Unit of the dosage strength
          example: mg
          x-pattern-message: Should not contain special characters
        strengthValue:
          type: number
          description: Value of the dosage strength
          format: double
          example: 100
        amountUnit:
          pattern: '[^<>"%;+@]*$'
          type: string
          description: Unit of a single dose
          example: puffs
          x-pattern-message: Should not contain special characters
        amountValue:
          type: number
          description: Value of a single dose
          format: double
          example: 2
    AdtEventClassification:
      type: string
      description: >-
        MAIN: This ADT is a main reason for the current request 

        SUPPLEMENTAL: This ADT is not directly related to the current request,
        but provides additional potentially useful patient data
      example: MAIN
      enum:
        - MAIN
        - SUPPLEMENTAL
    AdtEventType:
      type: string
      description: Supported ADT Event Types
      example: A03
      externalDocs:
        description: See Event Types
        url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Tables/0003
      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
    AdtIdentifier:
      type: object
      properties:
        root:
          type: string
          description: Identifier's root
          example: ACME_HEALTH
        extension:
          type: string
          description: Identifier value or extension
          example: '123456'
      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
      externalDocs:
        description: See PID segment
        url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PID
    AdtCode:
      type: object
      properties:
        code:
          type: string
          description: The specific code from a code system
          example: N0000175497
        codeSystem:
          type: string
          description: Code system OID. Must be populated if known
          example: 2.16.840.1.113883.6.345
        codeSystemName:
          type: string
          description: Human-readable name of the code system name if known
          example: MED-RT
        displayName:
          type: string
          description: Human-readable description of the code
          example: Penicillin-class Antibacterial
      description: Admit reason from PV2.3
      example:
        displayName: Stomach ache
      externalDocs:
        description: See PV2 segment
        url: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/PV2
    AdtEventDiagnosis:
      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
        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
        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
    RiskAdjustmentInsight:
      required:
        - enabled
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether this risk adjustment insight is enabled for care summary
      description: Individual insight for a condition
    CareManagementInsight:
      required:
        - enabled
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether this care management insight is enabled for care summary
      description: Individual care management for a condition
    QualityMeasure:
      required:
        - enabled
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the measure is enabled for quality reporting
      description: Individual quality measure
  securitySchemes:
    apiKey:
      type: apiKey
      description: API Key
      name: apiKey
      in: header

````