Patient Data v2 Validate

Authorizations

apiKey

string

header

required

API Key

Body

application/json

patientProcessingRequests

object[]

required

Required array length: 1 - 2500 elements

Show child attributes

patientProcessingRequests.patient

object

required

Patient to be processed

Show child attributes

patientProcessingRequests.patient.mrn

object

required

Patient's Medical Record Number. Populated with the clinic HL7 OID home community ID and the local patient ID. Must be unique per patient

Show child attributes

patientProcessingRequests.patient.mrn.root

string

required

Identifier's root, generally an OID

Minimum string length: 1

Example:

"1.2.3.4"

patientProcessingRequests.patient.mrn.extension

string

required

Identifier value or extension

Minimum string length: 1

Example:

"ABC123"

patientProcessingRequests.patient.name

object

required

Show child attributes

patientProcessingRequests.patient.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patientProcessingRequests.patient.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patientProcessingRequests.patient.name.prefix

string

Name prefix

Example:

"Mr."

patientProcessingRequests.patient.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patientProcessingRequests.patient.gender

enum<string>

required

Available options:

MALE,

FEMALE,

OTHER,

UNKNOWN

patientProcessingRequests.patient.birthDate

string<date>

required

Birth date of the patient in ISO-8601 format yyyy-MM-dd

Example:

"1992-04-09"

patientProcessingRequests.patient.addresses

object[]

required

Required array length: 1 - 3 elements

Show child attributes

patientProcessingRequests.patient.addresses.zip

string

required

5-digit zip code

Example:

"55401"

patientProcessingRequests.patient.addresses.lines

string[]

Street lines of the address

patientProcessingRequests.patient.addresses.city

string

The city

Example:

"Minneapolis"

patientProcessingRequests.patient.addresses.state

string

State code abbreviation

Example:

"MN"

patientProcessingRequests.patient.contactPoints

object[]

Show child attributes

patientProcessingRequests.patient.contactPoints.value

string

required

Phone number or email address

Minimum string length: 1

Example:

"9525551234"

patientProcessingRequests.patient.contactPoints.contactPointSystem

enum<string>

required

Type of contact

Available options:

PHONE,

EMAIL

Example:

"PHONE"

patientProcessingRequests.patient.contactPoints.contactPointUse

enum<string>

required

Use for the contact

Available options:

HOME,

WORK,

MOBILE

Example:

"HOME"

patientProcessingRequests.requestingProvider

object

required

A medical provider

Show child attributes

patientProcessingRequests.requestingProvider.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

patientProcessingRequests.requestingProvider.name

object

required

Show child attributes

patientProcessingRequests.requestingProvider.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patientProcessingRequests.requestingProvider.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patientProcessingRequests.requestingProvider.name.prefix

string

Name prefix

Example:

"Mr."

patientProcessingRequests.requestingProvider.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patientProcessingRequests.upcomingAppointmentDate

string<date>

Date of the appointment in ISO-8601 format yyyy-MM-dd

Example:

"2025-11-05"

patientProcessingRequests.clinicName

string

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"

patientProcessingRequests.clinicNpi

string

Facility's NPI if known

Required string length: 10

Example:

"1414912117"

patientProcessingRequests.responseDirectAddress

string<email>

Direct Address to return documents to. Typically, populate this OR responseFaxNumber

Example:

"[email protected]"

patientProcessingRequests.responseFriendlyName

string

Human-readable name to send response message to

Example:

"Heart Clinic"

patientProcessingRequests.diagnoses

object[]

All diagnoses (problems) known about the patient. If the patient is an existing patient then this list should be populated with all known diagnoses

Show child attributes

patientProcessingRequests.diagnoses.code

string

required

The diagnosis code including punctuation

Minimum string length: 1

Example:

"E66.01"

patientProcessingRequests.diagnoses.codeSystem

string

required

The diagnosis code system - should be an HL7 OID

Minimum string length: 1

Example:

"2.16.840.1.113883.6.90"

patientProcessingRequests.diagnoses.displayName

string

required

The display value for the diagnosis

Minimum string length: 1

Example:

"Morbid (severe) obesity due to excess calories"

patientProcessingRequests.diagnoses.active

boolean

required

Whether the diagnosis is still active or not

Example:

true

patientProcessingRequests.diagnoses.date

string<date>

Date of the problem (onset or diagnosed)

Example:

"2022-12-12"

patientProcessingRequests.medications

object[]

All known medications about the patient

Show child attributes

patientProcessingRequests.medications.active

boolean

required

Whether this medication is still being actively used by the patient

Example:

true

patientProcessingRequests.medications.nameCode

object

required

Medication name code. Code system should be RxNorm if possible

Show child attributes

patientProcessingRequests.medications.nameCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.nameCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.nameCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.nameCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "6809",
  "codeSystem": "2.16.840.1.113883.6.88",
  "codeSystemName": "RxNorm",
  "displayName": "metFORMIN"
}

patientProcessingRequests.medications.classCode

object

Medication class code. Code system should be MED-RT if possible

Show child attributes

patientProcessingRequests.medications.classCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.classCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.classCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.classCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "N0000175565",
  "codeSystem": "2.16.840.1.113883.6.345",
  "codeSystemName": "MED-RT",
  "displayName": "Biguanide"
}

patientProcessingRequests.medications.scheduleCode

object

Medication schedule code.

Show child attributes

patientProcessingRequests.medications.scheduleCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.scheduleCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.scheduleCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.scheduleCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "IV",
  "codeSystem": "2.16.840.1.113883.12.477",
  "codeSystemName": "Controlled Substance Schedule",
  "displayName": "Schedule IV"
}

patientProcessingRequests.medications.medicationRequests

object[]

Show child attributes

patientProcessingRequests.medications.medicationRequests.code

object

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.

Show child attributes

patientProcessingRequests.medications.medicationRequests.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.medicationRequests.code.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.medicationRequests.code.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.medicationRequests.code.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "861007",
  "codeSystem": "2.16.840.1.113883.6.88",
  "codeSystemName": "RxNorm",
  "displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
}

patientProcessingRequests.medications.medicationRequests.form

object

Form the medication is in. Code system should be NCI Thesaurus if possible

Show child attributes

patientProcessingRequests.medications.medicationRequests.form.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.medicationRequests.form.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.medicationRequests.form.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.medicationRequests.form.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "C42998",
  "codeSystem": "2.16.840.1.113883.3.26.1.1",
  "codeSystemName": "NCI Thesaurus",
  "displayName": "tablet"
}

patientProcessingRequests.medications.medicationRequests.route

object

Route by which the medication is administered

Show child attributes

patientProcessingRequests.medications.medicationRequests.route.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.medications.medicationRequests.route.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.medications.medicationRequests.route.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.medications.medicationRequests.route.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "C38288",
  "codeSystem": "2.16.840.1.113883.3.26.1.1",
  "codeSystemName": "NCI Thesaurus",
  "displayName": "oral"
}

patientProcessingRequests.medications.medicationRequests.prescribedDate

string<date>

Date the medication was prescribed, in ISO-8601 format yyyy-MM-dd

Example:

"2023-12-02"

patientProcessingRequests.medications.medicationRequests.prescriber

object

Prescriber of the medication

Show child attributes

patientProcessingRequests.medications.medicationRequests.prescriber.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

patientProcessingRequests.medications.medicationRequests.prescriber.name

object

required

Show child attributes

patientProcessingRequests.medications.medicationRequests.prescriber.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patientProcessingRequests.medications.medicationRequests.prescriber.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patientProcessingRequests.medications.medicationRequests.prescriber.name.prefix

string

Name prefix

Example:

"Mr."

patientProcessingRequests.medications.medicationRequests.prescriber.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patientProcessingRequests.medications.medicationRequests.facility

object

Facility where the medication was prescribed

Show child attributes

patientProcessingRequests.medications.medicationRequests.facility.name

string

required

Facility Name

Minimum string length: 1

Example:

"ABC Clinic"

patientProcessingRequests.medications.medicationRequests.facility.address

object

Facility Address

Show child attributes

patientProcessingRequests.medications.medicationRequests.facility.address.zip

string

required

5-digit zip code

Example:

"55401"

patientProcessingRequests.medications.medicationRequests.facility.address.lines

string[]

Street lines of the address

patientProcessingRequests.medications.medicationRequests.facility.address.city

string

The city

Example:

"Minneapolis"

patientProcessingRequests.medications.medicationRequests.facility.address.state

string

State code abbreviation

Example:

"MN"

Example:

{
  "lines": ["123 Main St", "Suite 517"],
  "city": "Minneapolis",
  "state": "MN",
  "zip": "55401"
}

patientProcessingRequests.medications.medicationRequests.initialFillQuantity

number<double>

Quantity initially filled for the medication

Example:

10

patientProcessingRequests.medications.medicationRequests.numberOfRefillsAllowed

integer<int32>

Number of refills allowed for this prescription

Example:

0

patientProcessingRequests.medications.medicationRequests.timingEvent

enum<string>

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

Available options:

BID,

TID,

QID,

AM,

PM,

QD,

QOD,

Q1H,

Q2H,

Q3H,

Q4H,

Q6H,

Q8H,

BED,

WK,

MO

Example:

"QD"

patientProcessingRequests.medications.medicationRequests.frequencyUnit

string

Unit of time as defined by http://hl7.org/fhir/ValueSet/units-of-time. Should be consistent with timingEvent if both populated

Example:

"d"

patientProcessingRequests.medications.medicationRequests.frequencyValue

number<double>

Frequency at which the medication should be taken. Should be consistent with timingEvent if both populated

Example:

1

patientProcessingRequests.medications.medicationRequests.dosageInstruction

object

Show child attributes

patientProcessingRequests.medications.medicationRequests.dosageInstruction.text

string

Prescriber's sig, or directions for taking the medication

Example:

"take 1 tablet by mouth once daily"

patientProcessingRequests.medications.medicationRequests.dosageInstruction.strengthUnit

string

Unit of the dosage strength

Example:

"mg"

patientProcessingRequests.medications.medicationRequests.dosageInstruction.strengthValue

number<double>

Value of the dosage strength

Example:

100

patientProcessingRequests.medications.medicationRequests.dosageInstruction.amountUnit

string

Unit of a single dose

Example:

"puffs"

patientProcessingRequests.medications.medicationRequests.dosageInstruction.amountValue

number<double>

Value of a single dose

Example:

2

patientProcessingRequests.clinicalNotes

object[]

Additional information provided about the patient

Show child attributes

patientProcessingRequests.clinicalNotes.lines

string[]

required

text of the clinical note, each line will be distinctly separated on CCDA output

Minimum array length: 1

Minimum string length: 1

Example:

[
  "The patient was pleasant",
  "Recommend following up in 2 weeks"
]

patientProcessingRequests.clinicalNotes.author

object

A medical provider

Show child attributes

patientProcessingRequests.clinicalNotes.author.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

patientProcessingRequests.clinicalNotes.author.name

object

required

Show child attributes

patientProcessingRequests.clinicalNotes.author.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patientProcessingRequests.clinicalNotes.author.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patientProcessingRequests.clinicalNotes.author.name.prefix

string

Name prefix

Example:

"Mr."

patientProcessingRequests.clinicalNotes.author.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patientProcessingRequests.clinicalNotes.date

string<date>

Date the note was recorded or written.

Example:

"2022-12-12"

patientProcessingRequests.clinicalNotes.code

object

Type of note content. Should come from https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.68/expansion/Latest

Show child attributes

patientProcessingRequests.clinicalNotes.code.code

string

required

The specific code from a code system

Minimum string length: 1

Example:

"N0000175497"

patientProcessingRequests.clinicalNotes.code.codeSystem

string

required

Code system OID. Must be populated if known

Minimum string length: 1

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.clinicalNotes.code.codeSystemName

string

required

Human-readable name of the code system name if known

Minimum string length: 1

Example:

"MED-RT"

patientProcessingRequests.clinicalNotes.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

Example:

{
  "code": "11506-3",
  "codeSystem": "2.16.840.1.113883.6.1",
  "codeSystemName": "LOINC",
  "displayName": "Progress Note"
}

patientProcessingRequests.adtEventData

object

ADT event information about the patient; populating this field requires ADT feature authorization enabled on customer account

Show child attributes

patientProcessingRequests.adtEventData.adtEvents

object[]

ADT events for the patient, at least one of which should have classification of MAIN

Required array length: 1 - 300 elements

Show child attributes

patientProcessingRequests.adtEventData.adtEvents.classification

enum<string>

required

Reason why this event is included on request

Available options:

MAIN,

SUPPLEMENTAL

Example:

"MAIN"

patientProcessingRequests.adtEventData.adtEvents.messageId

string

required

Message Control ID from MSH.10

Minimum string length: 1

Example:

"5125745967"

patientProcessingRequests.adtEventData.adtEvents.eventType

enum<string>

required

ADT event type, generally from MSH.9.2 (EVN.1 in older messages)

Available options:

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

Example:

"A03"

patientProcessingRequests.adtEventData.adtEvents.sendingFacilityName

string

required

Name of the facility that sent the ADT, generally mapped from MSH.4; very important for matching admit/discharge pairs

Minimum string length: 1

Example:

"First Memorial Hospital"

patientProcessingRequests.adtEventData.adtEvents.timestamp

string<date-time>

required

Timestamp when this ADT event was received/processed; used to help establish chronological order of incoming events

Example:

"2024-11-01T20:25:16.907Z"

patientProcessingRequests.adtEventData.adtEvents.sendingFacilityPatientId

object

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

Show child attributes

patientProcessingRequests.adtEventData.adtEvents.sendingFacilityPatientId.root

string

Identifier's root

Example:

"ACME_HEALTH"

patientProcessingRequests.adtEventData.adtEvents.sendingFacilityPatientId.extension

string

Identifier value or extension

Example:

"123456"

Example:

{
  "root": "2.16.840.1.113883.3.9359.0",
  "extension": "FMH-12345"
}

patientProcessingRequests.adtEventData.adtEvents.patientClass

string

Patient class from PV1.2

Example:

"E"

patientProcessingRequests.adtEventData.adtEvents.visitNumber

object

Visit number from PV1.19

Show child attributes

patientProcessingRequests.adtEventData.adtEvents.visitNumber.root

string

Identifier's root

Example:

"ACME_HEALTH"

patientProcessingRequests.adtEventData.adtEvents.visitNumber.extension

string

Identifier value or extension

Example:

"123456"

Example:

{
  "root": "FirstMemHosp",
  "extension": "987654321"
}

patientProcessingRequests.adtEventData.adtEvents.admitDate

string<date>

Date portion of admit timestamp from PV1.44

Example:

"2024-10-31"

patientProcessingRequests.adtEventData.adtEvents.dischargeDate

string<date>

Date portion of (first) discharge timestamp from PV1.45

Example:

"2024-11-01"

patientProcessingRequests.adtEventData.adtEvents.dischargeDisposition

string

Discharge disposition from PV1.36

Example:

"02"

patientProcessingRequests.adtEventData.adtEvents.dischargedToLocation

string

Discharged to location from PV1.37

Example:

"Home"

patientProcessingRequests.adtEventData.adtEvents.admitReason

object

Admit reason from PV2.3

Show child attributes

patientProcessingRequests.adtEventData.adtEvents.admitReason.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.adtEventData.adtEvents.admitReason.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.adtEventData.adtEvents.admitReason.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

patientProcessingRequests.adtEventData.adtEvents.admitReason.displayName

string

Human-readable description of the code

Example:

"Penicillin-class Antibacterial"

Example:

{ "displayName": "Stomach ache" }

patientProcessingRequests.adtEventData.adtEvents.diagnoses

object[]

Diagnoses, one for each DG1 segment; any diagnosis without a valid ICD-10 code is ignored

Maximum array length: 500

Show child attributes

patientProcessingRequests.adtEventData.adtEvents.diagnoses.code

string

required

Diagnosis Code Identifier from DG1.3.1

Minimum string length: 1

Example:

"R10.13"

patientProcessingRequests.adtEventData.adtEvents.diagnoses.codeSystem

string

Diagnosis Code System from DG1.3.3

Example:

"I10"

patientProcessingRequests.adtEventData.adtEvents.diagnoses.type

string

Diagnosis Type from DG1.6

Example:

"Final"

Example:

[
  {
    "code": "R10.13",
    "codeSystem": "I10",
    "type": "Final"
  }
]

patientProcessingRequests.directives

object

Directives which may influence how the data is processed

Show child attributes

patientProcessingRequests.directives.newPatient

boolean

default:false

Whether patient is new to the clinic (first time patient)

Example:

false

patientProcessingRequests.directives.diagnosticCategories

object

Diagnostic categories of interest regarding the patient

Show child attributes

patientProcessingRequests.directives.diagnosticCategories.autoimmune

boolean

default:false

Autoimmune diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.bariatric

boolean

default:false

Bariatric diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.behavioral

boolean

default:false

Behavioral Health diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.cardiovascular

boolean

default:false

Cardiovascular diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.dental

boolean

default:false

Dental diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.dermatological

boolean

default:false

Dermatological/Integumentary diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.endocrinological

boolean

default:false

Endocrinological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.gastroenterological

boolean

default:false

Gastroenterological/Gastrointestinal/Hepatobiliary diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.generalInformation

boolean

default:false

General diagnostic information is desired for the patient; use in conjunction with medicalSummaryPeriod to limit the data normally returned

Example:

false

patientProcessingRequests.directives.diagnosticCategories.generalSurgery

boolean

default:false

General Surgery diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.hematological

boolean

default:false

Hematological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.infectious

boolean

default:false

Infectious disease diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.lymphatic

boolean

default:false

Lymphatic diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.mens

boolean

default:false

Men's Health diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.metabolic

boolean

default:false

Metabolic diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.musculoskeletal

boolean

default:false

Musculoskeletal diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.neonatological

boolean

default:false

Neonatological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.neurological

boolean

default:false

Neurological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.nutritional

boolean

default:false

Nutritional diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.oncological

boolean

default:false

Oncological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.ophthalmic

boolean

default:false

Ophthalmic diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.otolaryngological

boolean

default:false

Otolaryngological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.pain

boolean

default:false

Chronic pain-related diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.postSurgery

boolean

default:false

Post-surgery diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.pulmonary

boolean

default:false

Pulmonary diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.renal

boolean

default:false

Renal diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.spinal

boolean

default:false

Spinal diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.stroke

boolean

default:false

Stroke diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.toxicological

boolean

default:false

Toxicological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.urological

boolean

default:false

Urological diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.diagnosticCategories.womens

boolean

default:false

Women's Health diagnostic information is desired for the patient

Example:

false

patientProcessingRequests.directives.medicationsOfInterest

object[]

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.

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.active

boolean

required

Whether this medication is still being actively used by the patient

Example:

true

patientProcessingRequests.directives.medicationsOfInterest.nameCode

object

required

Medication name code. Code system should be RxNorm if possible

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.nameCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.nameCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.nameCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.nameCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "6809",
  "codeSystem": "2.16.840.1.113883.6.88",
  "codeSystemName": "RxNorm",
  "displayName": "metFORMIN"
}

patientProcessingRequests.directives.medicationsOfInterest.classCode

object

Medication class code. Code system should be MED-RT if possible

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.classCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.classCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.classCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.classCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "N0000175565",
  "codeSystem": "2.16.840.1.113883.6.345",
  "codeSystemName": "MED-RT",
  "displayName": "Biguanide"
}

patientProcessingRequests.directives.medicationsOfInterest.scheduleCode

object

Medication schedule code.

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.scheduleCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.scheduleCode.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.scheduleCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.scheduleCode.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "IV",
  "codeSystem": "2.16.840.1.113883.12.477",
  "codeSystemName": "Controlled Substance Schedule",
  "displayName": "Schedule IV"
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests

object[]

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.code

object

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.code.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.code.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.code.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "861007",
  "codeSystem": "2.16.840.1.113883.6.88",
  "codeSystemName": "RxNorm",
  "displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.form

object

Form the medication is in. Code system should be NCI Thesaurus if possible

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.form.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.form.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.form.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.form.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "C42998",
  "codeSystem": "2.16.840.1.113883.3.26.1.1",
  "codeSystemName": "NCI Thesaurus",
  "displayName": "tablet"
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.route

object

Route by which the medication is administered

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.route.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.route.code

string

The specific code from a code system

Example:

"N0000175497"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.route.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.route.codeSystemName

string

Human-readable name of the code system name if known

Example:

"MED-RT"

Example:

{
  "code": "C38288",
  "codeSystem": "2.16.840.1.113883.3.26.1.1",
  "codeSystemName": "NCI Thesaurus",
  "displayName": "oral"
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescribedDate

string<date>

Date the medication was prescribed, in ISO-8601 format yyyy-MM-dd

Example:

"2023-12-02"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber

object

Prescriber of the medication

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.name

object

required

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.name.prefix

string

Name prefix

Example:

"Mr."

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.prescriber.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility

object

Facility where the medication was prescribed

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.name

string

required

Facility Name

Minimum string length: 1

Example:

"ABC Clinic"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.address

object

Facility Address

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.address.zip

string

required

5-digit zip code

Example:

"55401"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.address.lines

string[]

Street lines of the address

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.address.city

string

The city

Example:

"Minneapolis"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.facility.address.state

string

State code abbreviation

Example:

"MN"

Example:

{
  "lines": ["123 Main St", "Suite 517"],
  "city": "Minneapolis",
  "state": "MN",
  "zip": "55401"
}

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.initialFillQuantity

number<double>

Quantity initially filled for the medication

Example:

10

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.numberOfRefillsAllowed

integer<int32>

Number of refills allowed for this prescription

Example:

0

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.timingEvent

enum<string>

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

Available options:

BID,

TID,

QID,

AM,

PM,

QD,

QOD,

Q1H,

Q2H,

Q3H,

Q4H,

Q6H,

Q8H,

BED,

WK,

MO

Example:

"QD"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.frequencyUnit

string

Unit of time as defined by http://hl7.org/fhir/ValueSet/units-of-time. Should be consistent with timingEvent if both populated

Example:

"d"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.frequencyValue

number<double>

Frequency at which the medication should be taken. Should be consistent with timingEvent if both populated

Example:

1

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction

object

Show child attributes

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction.text

string

Prescriber's sig, or directions for taking the medication

Example:

"take 1 tablet by mouth once daily"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction.strengthUnit

string

Unit of the dosage strength

Example:

"mg"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction.strengthValue

number<double>

Value of the dosage strength

Example:

100

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction.amountUnit

string

Unit of a single dose

Example:

"puffs"

patientProcessingRequests.directives.medicationsOfInterest.medicationRequests.dosageInstruction.amountValue

number<double>

Value of a single dose

Example:

2

patientProcessingRequests.directives.medicalSummaryPeriod

object

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.

Show child attributes

patientProcessingRequests.directives.medicalSummaryPeriod.startDate

string<date>

required

Beginning of the period, inclusive

Example:

"2022-12-12"

patientProcessingRequests.directives.medicalSummaryPeriod.endDate

string<date>

End of the period, inclusive

Example:

"2022-12-14"

patientProcessingRequests.directives.qualityMeasureConfiguration

object

Quality measure configuration options. If omitted, defaults to the customer default configuration.

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.cardiovascularBloodPressure

object

Blood Pressure Control measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.cardiovascularBloodPressure.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticBloodPressure

object

Blood Pressure Control for Diabetics measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticBloodPressure.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticEyeExam

object

Diabetic Eye Exam measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticEyeExam.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticHba1c

object

Diabetic HbA1c measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticHba1c.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticKidneyHealth

object

Kidney Health measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.diabeticKidneyHealth.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceBloodPressure

object

Blood Pressure Medications adherence measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceBloodPressure.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceCholesterol

object

Cholesterol Medications adherence measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceCholesterol.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceDiabetes

object

Diabetes Medications adherence measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.medAdherenceDiabetes.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningBreastCancer

object

Breast Cancer Screening measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningBreastCancer.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningCervicalCancer

object

Cervical Cancer Screening measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningCervicalCancer.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningColorectal

object

Colorectal Screening measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningColorectal.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningDepression

object

Depression Screening measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningDepression.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.vaccineFlu

object

Flu Vaccine measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.vaccineFlu.enabled

boolean

required

Whether the measure is enabled for quality reporting

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningTobaccoUse

object

Tobacco Use screening measure configuration

Show child attributes

patientProcessingRequests.directives.qualityMeasureConfiguration.screeningTobaccoUse.enabled

boolean

required

Whether the measure is enabled for quality reporting

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.

Show child attributes

patientPanelDirectives.requestMedicationHistory

boolean

default:false

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

patientPanelDirectives.kaidConfiguration

object

Configuration details for interactions with the KAID service. Normally, not populated.

Show child attributes

patientPanelDirectives.kaidConfiguration.tenantId

string

Identifier for the specific KAID Tenant configuration which should be used for processing. This value is required to match a tenant configured by Connective Health.

Example:

""

patientPanelDirectives.deliverableDocuments

enum<string>[]

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.

Available options:

PATIENT_CARE_SUMMARY,

QUALITY_MEASURES_SUMMARY

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

Show child attributes

responses.sequenceNumber

integer<int32>

Zero-based sequence number for which element in the original request this response is for

Example:

0

responses.correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

"e5c3310a-6cb4-4755-a5c2-35b99d946181"

Welcome

Product

Implementation

APIs

Authorizations

Body

Response