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

# Medication History Patient Panel Load v1

> 
# Data Requirements

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

## Early Access

Note, this API is still in early access and is subject to change. 
 
## Overview
Submits a panel of patients for batch processing of medication history information.

## Special Validations
1. Patient names must have two or more name components that each have two or more characters
1. Patient address city must be either empty or two or more characters
1. Patient address state must be either empty or two or more characters

## Special Processing Rules
1. Data may be truncated when submitted for downstream system processing based on third-party requirements
1. Only ASCII values 32-126 are allowed for downstream processing; all accented characters will be replaced with non-accented characters




## OpenAPI

````yaml post /v1/medication-history/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/medication-history/patient-panel:
    post:
      tags:
        - Medication History
      summary: Patient Panel Load
      description: >

        # Data Requirements


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


        ## Early Access


        Note, this API is still in early access and is subject to change. 
         
        ## Overview

        Submits a panel of patients for batch processing of medication history
        information.


        ## Special Validations

        1. Patient names must have two or more name components that each have
        two or more characters

        1. Patient address city must be either empty or two or more characters

        1. Patient address state must be either empty or two or more characters


        ## Special Processing Rules

        1. Data may be truncated when submitted for downstream system processing
        based on third-party requirements

        1. Only ASCII values 32-126 are allowed for downstream processing; all
        accented characters will be replaced with non-accented characters
      operationId: processMedicationHistoryPatientPanel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MedHistoryPatientPanel'
        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:
    MedHistoryPatientPanel:
      required:
        - medHistoryPatientRecords
      type: object
      properties:
        medHistoryPatientRecords:
          maxItems: 5000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/MedHistoryPatientRecord'
    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_'
    MedHistoryPatientRecord:
      required:
        - patient
        - requestingProvider
      type: object
      properties:
        patient:
          $ref: '#/components/schemas/Patient'
        requestingProvider:
          $ref: '#/components/schemas/Provider'
    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:
      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
    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'
    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
  securitySchemes:
    apiKey:
      type: apiKey
      description: API Key
      name: apiKey
      in: header

````