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": {
"code": "861007",
"codeSystem": "2.16.840.1.113883.6.88",
"codeSystemName": "RxNorm",
"displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
},
"form": {
"code": "C42998",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "tablet"
},
"route": {
"code": "C38288",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "oral"
},
"prescribedDate": "2023-12-02",
"prescriber": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"initialFillQuantity": 10,
"numberOfRefillsAllowed": 0,
"timingEvent": "QD",
"frequencyUnit": "d",
"frequencyValue": 1,
"dosageInstruction": {
"text": "take 1 tablet by mouth once daily",
"strengthUnit": "mg",
"strengthValue": 100,
"amountUnit": "puffs",
"amountValue": 2
}
}
]
}
],
"clinicalNotes": [
{
"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"
]
}
],
"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": {
"code": "861007",
"codeSystem": "2.16.840.1.113883.6.88",
"codeSystemName": "RxNorm",
"displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
},
"form": {
"code": "C42998",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "tablet"
},
"route": {
"code": "C38288",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "oral"
},
"prescribedDate": "2023-12-02",
"prescriber": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"initialFillQuantity": 10,
"numberOfRefillsAllowed": 0,
"timingEvent": "QD",
"frequencyUnit": "d",
"frequencyValue": 1,
"dosageInstruction": {
"text": "take 1 tablet by mouth once daily",
"strengthUnit": "mg",
"strengthValue": 100,
"amountUnit": "puffs",
"amountValue": 2
}
}
]
}
],
"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"
}
]
}
Validates the request without doing any processing
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": {
"code": "861007",
"codeSystem": "2.16.840.1.113883.6.88",
"codeSystemName": "RxNorm",
"displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
},
"form": {
"code": "C42998",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "tablet"
},
"route": {
"code": "C38288",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "oral"
},
"prescribedDate": "2023-12-02",
"prescriber": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"initialFillQuantity": 10,
"numberOfRefillsAllowed": 0,
"timingEvent": "QD",
"frequencyUnit": "d",
"frequencyValue": 1,
"dosageInstruction": {
"text": "take 1 tablet by mouth once daily",
"strengthUnit": "mg",
"strengthValue": 100,
"amountUnit": "puffs",
"amountValue": 2
}
}
]
}
],
"clinicalNotes": [
{
"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"
]
}
],
"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": {
"code": "861007",
"codeSystem": "2.16.840.1.113883.6.88",
"codeSystemName": "RxNorm",
"displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
},
"form": {
"code": "C42998",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "tablet"
},
"route": {
"code": "C38288",
"codeSystem": "2.16.840.1.113883.3.26.1.1",
"codeSystemName": "NCI Thesaurus",
"displayName": "oral"
},
"prescribedDate": "2023-12-02",
"prescriber": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"initialFillQuantity": 10,
"numberOfRefillsAllowed": 0,
"timingEvent": "QD",
"frequencyUnit": "d",
"frequencyValue": 1,
"dosageInstruction": {
"text": "take 1 tablet by mouth once daily",
"strengthUnit": "mg",
"strengthValue": 100,
"amountUnit": "puffs",
"amountValue": 2
}
}
]
}
],
"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"
}
]
}
API Key
Success
The response is of type object
.