> ## 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.

# Panel Registration

> 
# 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
Manage a patient's registration on the Patient Panel for ADT monitoring. If an ADT notification event occurs, the patient will be processed.



## OpenAPI

````yaml post /v1/patient-panel
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:
  /v1/patient-panel:
    post:
      tags:
        - ADT Patient Panel
      summary: Panel Registration
      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

        Manage a patient's registration on the Patient Panel for ADT monitoring.
        If an ADT notification event occurs, the patient will be processed.
      operationId: processAdtPanelPatient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdtPanelPatient'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingResponse'
        '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/ProcessingResponse'
        '403':
          description: Missing permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingResponse'
components:
  schemas:
    AdtPanelPatient:
      required:
        - patient
        - provider
      type: object
      properties:
        patient:
          description: >-
            Patient to add to the patient panel. Patients on the panel will be
            monitored via ADT events. If this patient already exists, it will be
            overwritten. Patients are never deleted; to remove a patient from
            the panel, set the endDate appropriately.
          allOf:
            - $ref: '#/components/schemas/Patient'
        startDate:
          type: string
          description: >-
            Date the patient will start being monitored, in ISO-8601 format
            yyyy-MM-dd. Only panels generated on or after this date will include
            this patient. Defaults to current date.
          format: date
          example: '2024-11-05'
        endDate:
          type: string
          description: >-
            Date the patient will stop being monitored, in ISO-8601 format
            yyyy-MM-dd. If not null, only panels generated on or before this
            date will include this patient
          format: date
          nullable: true
          example: '2025-11-05'
        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 to a UUID it not populated
          example: BATCH-123
          x-pattern-message: Should not contain special characters
        provider:
          description: >-
            This will be the requesting provider for medical records required to
            generate a care summary (or FHIR bundle, etc.) as the result of an
            ADT event
          allOf:
            - $ref: '#/components/schemas/Provider'
        activeIcd10Diagnoses:
          type: array
          description: >-
            All active diagnoses (problems) known about the patient. Must all be
            ICD-10 codes. If the patient is an existing patient then this list
            should be populated with all known diagnoses
          items:
            $ref: '#/components/schemas/Diagnosis'
        activeIcd9Diagnoses:
          type: array
          description: >-
            All active diagnoses (problems) known about the patient. Must all be
            ICD-9 codes. If the patient is an existing patient then this list
            should be populated with all known diagnoses. **ICD-10 should be
            greatly preferred if available.**
          example:
            - code: '401.1'
              displayName: Benign essential hypertension
              date: '2023-12-12'
          items:
            $ref: '#/components/schemas/Diagnosis'
        activeSnomedDiagnoses:
          type: array
          description: >-
            All active diagnoses (problems) known about the patient. Must all be
            SNOMED codes. If the patient is an existing patient then this list
            should be populated with all known diagnoses. **ICD-10 should be
            greatly preferred if available.**
          example:
            - code: '34713006'
              displayName: Vitamin D deficiency
              date: '2023-11-12'
          items:
            $ref: '#/components/schemas/Diagnosis'
        medications:
          type: array
          description: All known medications for the patient
          items:
            $ref: '#/components/schemas/Medication'
        clinicalNotes:
          type: array
          description: Additional information provided about the patient
          items:
            $ref: '#/components/schemas/ClinicalNote'
        consent:
          description: >-
            Whether patient consent has been obtained to register and/or share
            their data them in specific contexts. Some HIEs require consent
            information to register patients. It is important to include
            non-positive consent, as in some cases, those patients may still be
            eligible to have some information shared in emergencies.
          allOf:
            - $ref: '#/components/schemas/Consent'
    ProcessingResponse:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            Unique Connective Health identifier to correlate subsequent
            processing or troubleshooting
          example: 9e923da0-f3cb-4d2b-9fbb-17417104ffd0
    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_'
    Patient:
      required:
        - address
        - 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'
        address:
          $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:
      required:
        - code
        - 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
        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'
    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
    Consent:
      type: object
      properties:
        bronxRhioConsent:
          description: Patient Consent information for Bronx RHIO, Inc. of New York State.
          allOf:
            - $ref: '#/components/schemas/BronxRhioConsent'
      description: >-
        Whether patient consent has been obtained to register and/or share their
        data them in specific contexts. Some HIEs require consent information to
        register patients. It is important to include non-positive consent, as
        in some cases, those patients may still be eligible to have some
        information shared in emergencies.
    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__'
    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'
    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
    BronxRhioConsent:
      required:
        - status
      type: object
      properties:
        status:
          description: Patient's consent status for Bronx RHIO
          allOf:
            - $ref: '#/components/schemas/BronxRhioConsent.Status'
        date:
          type: string
          description: Effective date of patient consent for Bronx RHIO
          format: date
      description: Patient Consent information for Bronx RHIO, Inc. of New York State.
    OptionalValues_List_Link__:
      type: object
      properties:
        empty:
          type: boolean
    OptionalValues_List_Resource__:
      type: object
      properties:
        empty:
          type: boolean
    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
    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
    BronxRhioConsent.Status:
      type: string
      description: Patient's consent status for Bronx RHIO
      enum:
        - 'YES'
        - 'NO'
        - UNKNOWN
        - RESET
      x-enum-descriptions:
        - Yes (positive consent)
        - No (negative consent)
        - Unknown (use this if neither YES/NO apply)
        - >-
          Reset/Remove (this should generally not be used unless directed by
          Connective Health)
  securitySchemes:
    apiKey:
      type: apiKey
      description: API Key
      name: apiKey
      in: header

````