POST
/
v2
/
patient-data
/
validate
Validate Patient Processing Panel
curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v2/patient-data/validate \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "patientProcessingRequests": [
    {
      "patient": {
        "mrn": {
          "root": "1.2.3.4",
          "extension": "ABC123"
        },
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        },
        "gender": "MALE",
        "birthDate": "1992-04-09",
        "addresses": [
          {
            "lines": [
              "123 Main St",
              "Suite 517"
            ],
            "city": "Minneapolis",
            "state": "MN",
            "zip": "55401"
          }
        ],
        "contactPoints": [
          {
            "value": "9525551234",
            "contactPointSystem": "PHONE",
            "contactPointUse": "HOME"
          }
        ]
      },
      "upcomingAppointmentDate": "2025-11-05",
      "requestingProvider": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      },
      "clinicName": "Simple Clinic Name",
      "clinicNpi": "1414912117",
      "responseDirectAddress": "contact@yourdomain.com",
      "responseFriendlyName": "Heart Clinic",
      "diagnoses": [
        {
          "code": "E66.01",
          "codeSystem": "2.16.840.1.113883.6.90",
          "displayName": "Morbid (severe) obesity due to excess calories",
          "date": "2022-12-12",
          "active": true
        }
      ],
      "medications": [
        {
          "active": true,
          "nameCode": {
            "code": "6809",
            "codeSystem": "2.16.840.1.113883.6.88",
            "codeSystemName": "RxNorm",
            "displayName": "metFORMIN"
          },
          "classCode": {
            "code": "N0000175565",
            "codeSystem": "2.16.840.1.113883.6.345",
            "codeSystemName": "MED-RT",
            "displayName": "Biguanide"
          },
          "scheduleCode": {
            "code": "IV",
            "codeSystem": "2.16.840.1.113883.12.477",
            "codeSystemName": "Controlled Substance Schedule",
            "displayName": "Schedule IV"
          },
          "medicationRequests": [
            {
              "code": "<any>",
              "form": "<any>",
              "route": "<any>",
              "prescribedDate": "<any>",
              "prescriber": "<any>",
              "facility": "<any>",
              "initialFillQuantity": "<any>",
              "numberOfRefillsAllowed": "<any>",
              "timingEvent": "<any>",
              "frequencyUnit": "<any>",
              "frequencyValue": "<any>",
              "dosageInstruction": "<any>"
            }
          ]
        }
      ],
      "clinicalNotes": [
        {
          "author": {
            "npi": "1414912117",
            "name": {
              "family": "Johnson",
              "given": [
                "John",
                "Aaron"
              ],
              "prefix": "Mr.",
              "suffix": "Jr."
            }
          },
          "date": "2022-12-12",
          "code": {
            "code": "11506-3",
            "codeSystem": "2.16.840.1.113883.6.1",
            "codeSystemName": "LOINC",
            "displayName": "Progress Note"
          },
          "lines": [
            "The patient was pleasant",
            "Recommend following up in 2 weeks"
          ]
        }
      ],
      "adtEventData": {
        "adtEvents": [
          {
            "classification": "MAIN",
            "messageId": "5125745967",
            "eventType": "A03",
            "sendingFacilityName": "First Memorial Hospital",
            "timestamp": "2024-11-01T20:25:16.907Z",
            "sendingFacilityPatientId": {
              "root": "2.16.840.1.113883.3.9359.0",
              "extension": "FMH-12345"
            },
            "patientClass": "E",
            "visitNumber": {
              "root": "FirstMemHosp",
              "extension": "987654321"
            },
            "admitDate": "2024-10-31",
            "dischargeDate": "2024-11-01",
            "dischargeDisposition": "02",
            "dischargedToLocation": "Home",
            "admitReason": {
              "displayName": "Stomach ache"
            },
            "diagnoses": [
              {
                "code": "R10.13",
                "codeSystem": "I10",
                "type": "Final"
              }
            ]
          }
        ]
      },
      "directives": {
        "newPatient": false,
        "diagnosticCategories": {
          "autoimmune": false,
          "bariatric": false,
          "behavioral": false,
          "cardiovascular": false,
          "dental": false,
          "dermatological": false,
          "endocrinological": false,
          "gastroenterological": false,
          "generalSurgery": false,
          "hematological": false,
          "infectious": false,
          "lymphatic": false,
          "mens": false,
          "metabolic": false,
          "musculoskeletal": false,
          "neonatological": false,
          "neurological": false,
          "nutritional": false,
          "oncological": false,
          "ophthalmic": false,
          "otolaryngological": false,
          "pain": false,
          "pulmonary": false,
          "renal": false,
          "spinal": false,
          "stroke": false,
          "toxicological": false,
          "urological": false,
          "womens": false
        },
        "medicationsOfInterest": [
          {
            "active": true,
            "nameCode": {
              "code": "6809",
              "codeSystem": "2.16.840.1.113883.6.88",
              "codeSystemName": "RxNorm",
              "displayName": "metFORMIN"
            },
            "classCode": {
              "code": "N0000175565",
              "codeSystem": "2.16.840.1.113883.6.345",
              "codeSystemName": "MED-RT",
              "displayName": "Biguanide"
            },
            "scheduleCode": {
              "code": "IV",
              "codeSystem": "2.16.840.1.113883.12.477",
              "codeSystemName": "Controlled Substance Schedule",
              "displayName": "Schedule IV"
            },
            "medicationRequests": [
              {
                "code": "<any>",
                "form": "<any>",
                "route": "<any>",
                "prescribedDate": "<any>",
                "prescriber": "<any>",
                "facility": "<any>",
                "initialFillQuantity": "<any>",
                "numberOfRefillsAllowed": "<any>",
                "timingEvent": "<any>",
                "frequencyUnit": "<any>",
                "frequencyValue": "<any>",
                "dosageInstruction": "<any>"
              }
            ]
          }
        ],
        "medicalSummaryPeriod": {
          "startDate": "2022-12-12",
          "endDate": "2022-12-14"
        }
      }
    }
  ],
  "batchId": "BATCH-123",
  "patientPanelDirectives": {
    "requestMedicationHistory": true,
    "kaidConfiguration": {
      "tenantId": ""
    }
  }
}'
{
  "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"
    }
  ]
}

Authorizations

apiKey
string
header
required

API Key

Body

application/json
patientProcessingRequests
object[]
required
Required array length: 1 - 2500 elements
batchId
string

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"

patientPanelDirectives
object

Directives which may influence how the data is processed. Applies to all requests in this panel.

Response

Success

correlationId
string

Unique overall Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

"10c7b080-76f2-4aff-beeb-a2f7b4ca7a89"

responses
object[]

Response details about each individual request in the panel