Patient Data v1

Authorizations

apiKey

string

header

required

API Key

Body

application/json

patient

object

required

Patient to be processed

Show child attributes

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

patient.mrn.root

string

required

Identifier's root, generally an OID

Minimum string length: 1

Example:

"1.2.3.4"

patient.mrn.extension

string

required

Identifier value or extension

Minimum string length: 1

Example:

"ABC123"

patient.name

object

required

Show child attributes

patient.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patient.name.given

string[]

required

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

Minimum array length: 1

patient.name.prefix

string

Name prefix

Example:

"Mr."

patient.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

patient.gender

enum<string>

required

Available options:

MALE,

FEMALE,

OTHER,

UNKNOWN

patient.birthDate

string<date>

required

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

Example:

"1992-04-09"

patient.address

object

required

Show child attributes

patient.address.zip

string

required

5-digit zip code

Example:

"55401"

patient.address.lines

string[]

Street lines of the address

patient.address.city

string

The city

Example:

"Minneapolis"

patient.address.state

string

State code abbreviation

Example:

"MN"

Example:

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

patient.contactPoints

object[]

Show child attributes

patient.contactPoints.value

string

required

Phone number or email address

Minimum string length: 1

Example:

"9525551234"

patient.contactPoints.contactPointSystem

enum<string>

required

Type of contact

Available options:

PHONE,

EMAIL

Example:

"PHONE"

patient.contactPoints.contactPointUse

enum<string>

required

Use for the contact

Available options:

HOME,

WORK,

MOBILE

Example:

"HOME"

upcomingAppointmentDate

string<date>

required

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

Example:

"2024-11-05"

upcomingAppointmentProvider

object

required

A medical provider

Show child attributes

upcomingAppointmentProvider.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

upcomingAppointmentProvider.name

object

required

Show child attributes

upcomingAppointmentProvider.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

upcomingAppointmentProvider.name.given

string[]

required

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

Minimum array length: 1

upcomingAppointmentProvider.name.prefix

string

Name prefix

Example:

"Mr."

upcomingAppointmentProvider.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

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"

clinicNpi

string

Facility's NPI if known

Required string length: 10

Example:

"1414912117"

responseDirectAddress

string<email>

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

Example:

"[email protected]"

responseFaxNumber

string

Fax number to send response documents to. Typically, populate this OR responseDirectAddress

Required string length: 10

Example:

"6125551234"

responseFriendlyName

string

Human-readable name to send response message to

Example:

"Heart Clinic"

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 to a UUID if not populated

Example:

"BATCH-123"

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

medicalSummaryPeriod.startDate

string<date>

required

Beginning of the period, inclusive

Example:

"2022-12-12"

medicalSummaryPeriod.endDate

string<date>

End of the period, inclusive

Example:

"2022-12-14"

activeIcd10Diagnoses

object[]

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

Show child attributes

activeIcd10Diagnoses.code

string

required

The diagnosis code including punctuation

Minimum string length: 1

Example:

"E66.01"

activeIcd10Diagnoses.displayName

string

required

The display value for the diagnosis

Minimum string length: 1

Example:

"Morbid (severe) obesity due to excess calories"

activeIcd10Diagnoses.date

string<date>

Date of the problem (onset or diagnosed)

Example:

"2022-12-12"

activeIcd9Diagnoses

object[]

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.

Show child attributes

activeIcd9Diagnoses.code

string

required

The diagnosis code including punctuation

Minimum string length: 1

Example:

"E66.01"

activeIcd9Diagnoses.displayName

string

required

The display value for the diagnosis

Minimum string length: 1

Example:

"Morbid (severe) obesity due to excess calories"

activeIcd9Diagnoses.date

string<date>

Date of the problem (onset or diagnosed)

Example:

"2022-12-12"

Example:

[
  {
    "code": "401.1",
    "displayName": "Benign essential hypertension",
    "date": "2023-12-12"
  }
]

activeSnomedDiagnoses

object[]

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.

Show child attributes

activeSnomedDiagnoses.code

string

required

The diagnosis code including punctuation

Minimum string length: 1

Example:

"E66.01"

activeSnomedDiagnoses.displayName

string

required

The display value for the diagnosis

Minimum string length: 1

Example:

"Morbid (severe) obesity due to excess calories"

activeSnomedDiagnoses.date

string<date>

Date of the problem (onset or diagnosed)

Example:

"2022-12-12"

Example:

[
  {
    "code": "34713006",
    "displayName": "Vitamin D deficiency",
    "date": "2023-11-12"
  }
]

medications

object[]

All known medications about the patient

Show child attributes

medications.active

boolean

required

Whether this medication is still being actively used by the patient

Example:

true

medications.nameCode

object

required

Medication name code. Code system should be RxNorm if possible

Show child attributes

medications.nameCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.nameCode.code

string

The specific code from a code system

Example:

"N0000175497"

medications.nameCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.classCode

object

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

Show child attributes

medications.classCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.classCode.code

string

The specific code from a code system

Example:

"N0000175497"

medications.classCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.scheduleCode

object

Medication schedule code.

Show child attributes

medications.scheduleCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.scheduleCode.code

string

The specific code from a code system

Example:

"N0000175497"

medications.scheduleCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.medicationRequests

object[]

Show child attributes

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

medications.medicationRequests.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.medicationRequests.code.code

string

The specific code from a code system

Example:

"N0000175497"

medications.medicationRequests.code.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.medicationRequests.form

object

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

Show child attributes

medications.medicationRequests.form.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.medicationRequests.form.code

string

The specific code from a code system

Example:

"N0000175497"

medications.medicationRequests.form.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.medicationRequests.route

object

Route by which the medication is administered

Show child attributes

medications.medicationRequests.route.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

medications.medicationRequests.route.code

string

The specific code from a code system

Example:

"N0000175497"

medications.medicationRequests.route.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

medications.medicationRequests.prescribedDate

string<date>

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

Example:

"2023-12-02"

medications.medicationRequests.prescriber

object

Prescriber of the medication

Show child attributes

medications.medicationRequests.prescriber.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

medications.medicationRequests.prescriber.name

object

required

Show child attributes

medications.medicationRequests.prescriber.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

medications.medicationRequests.prescriber.name.given

string[]

required

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

Minimum array length: 1

medications.medicationRequests.prescriber.name.prefix

string

Name prefix

Example:

"Mr."

medications.medicationRequests.prescriber.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

medications.medicationRequests.facility

object

Facility where the medication was prescribed

Show child attributes

medications.medicationRequests.facility.name

string

required

Facility Name

Minimum string length: 1

Example:

"ABC Clinic"

medications.medicationRequests.facility.address

object

Facility Address

Show child attributes

medications.medicationRequests.facility.address.zip

string

required

5-digit zip code

Example:

"55401"

medications.medicationRequests.facility.address.lines

string[]

Street lines of the address

medications.medicationRequests.facility.address.city

string

The city

Example:

"Minneapolis"

medications.medicationRequests.facility.address.state

string

State code abbreviation

Example:

"MN"

Example:

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

medications.medicationRequests.initialFillQuantity

number<double>

Quantity initially filled for the medication

Example:

10

medications.medicationRequests.numberOfRefillsAllowed

integer<int32>

Number of refills allowed for this prescription

Example:

0

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"

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"

medications.medicationRequests.frequencyValue

number<double>

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

Example:

1

medications.medicationRequests.dosageInstruction

object

Show child attributes

medications.medicationRequests.dosageInstruction.text

string

Prescriber's sig, or directions for taking the medication

Example:

"take 1 tablet by mouth once daily"

medications.medicationRequests.dosageInstruction.strengthUnit

string

Unit of the dosage strength

Example:

"mg"

medications.medicationRequests.dosageInstruction.strengthValue

number<double>

Value of the dosage strength

Example:

100

medications.medicationRequests.dosageInstruction.amountUnit

string

Unit of a single dose

Example:

"puffs"

medications.medicationRequests.dosageInstruction.amountValue

number<double>

Value of a single dose

Example:

2

clinicalNotes

object[]

Additional information provided about the patient

Show child attributes

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"
]

clinicalNotes.author

object

A medical provider

Show child attributes

clinicalNotes.author.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

clinicalNotes.author.name

object

required

Show child attributes

clinicalNotes.author.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

clinicalNotes.author.name.given

string[]

required

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

Minimum array length: 1

clinicalNotes.author.name.prefix

string

Name prefix

Example:

"Mr."

clinicalNotes.author.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

clinicalNotes.date

string<date>

Date the note was recorded or written.

Example:

"2022-12-12"

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

clinicalNotes.code.code

string

required

The specific code from a code system

Minimum string length: 1

Example:

"N0000175497"

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"

clinicalNotes.code.codeSystemName

string

required

Human-readable name of the code system name if known

Minimum string length: 1

Example:

"MED-RT"

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"
}

directives

object

Directives which may influence how the data is processed

Show child attributes

directives.newPatient

boolean

default:false

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

Example:

false

directives.diagnosticCategories

object

Diagnostic categories of interest regarding the patient

Show child attributes

directives.diagnosticCategories.autoimmune

boolean

default:false

Autoimmune diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.bariatric

boolean

default:false

Bariatric diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.behavioral

boolean

default:false

Behavioral Health diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.cardiovascular

boolean

default:false

Cardiovascular diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.dental

boolean

default:false

Dental diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.dermatological

boolean

default:false

Dermatological/Integumentary diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.endocrinological

boolean

default:false

Endocrinological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.gastroenterological

boolean

default:false

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

Example:

false

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

directives.diagnosticCategories.generalSurgery

boolean

default:false

General Surgery diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.hematological

boolean

default:false

Hematological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.infectious

boolean

default:false

Infectious disease diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.lymphatic

boolean

default:false

Lymphatic diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.mens

boolean

default:false

Men's Health diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.metabolic

boolean

default:false

Metabolic diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.musculoskeletal

boolean

default:false

Musculoskeletal diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.neonatological

boolean

default:false

Neonatological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.neurological

boolean

default:false

Neurological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.nutritional

boolean

default:false

Nutritional diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.oncological

boolean

default:false

Oncological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.ophthalmic

boolean

default:false

Ophthalmic diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.otolaryngological

boolean

default:false

Otolaryngological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.pain

boolean

default:false

Chronic pain-related diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.postSurgery

boolean

default:false

Post-surgery diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.pulmonary

boolean

default:false

Pulmonary diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.renal

boolean

default:false

Renal diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.spinal

boolean

default:false

Spinal diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.stroke

boolean

default:false

Stroke diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.toxicological

boolean

default:false

Toxicological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.urological

boolean

default:false

Urological diagnostic information is desired for the patient

Example:

false

directives.diagnosticCategories.womens

boolean

default:false

Women's Health diagnostic information is desired for the patient

Example:

false

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

directives.medicationsOfInterest.active

boolean

required

Whether this medication is still being actively used by the patient

Example:

true

directives.medicationsOfInterest.nameCode

object

required

Medication name code. Code system should be RxNorm if possible

Show child attributes

directives.medicationsOfInterest.nameCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.nameCode.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.nameCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.classCode

object

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

Show child attributes

directives.medicationsOfInterest.classCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.classCode.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.classCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.scheduleCode

object

Medication schedule code.

Show child attributes

directives.medicationsOfInterest.scheduleCode.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.scheduleCode.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.scheduleCode.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.medicationRequests

object[]

Show child attributes

directives.medicationsOfInterest.medicationRequests.code

object

Show child attributes

directives.medicationsOfInterest.medicationRequests.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.medicationRequests.code.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.medicationRequests.code.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.medicationRequests.form

object

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

Show child attributes

directives.medicationsOfInterest.medicationRequests.form.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.medicationRequests.form.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.medicationRequests.form.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.medicationRequests.route

object

Route by which the medication is administered

Show child attributes

directives.medicationsOfInterest.medicationRequests.route.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

directives.medicationsOfInterest.medicationRequests.route.code

string

The specific code from a code system

Example:

"N0000175497"

directives.medicationsOfInterest.medicationRequests.route.codeSystem

string

Code system OID. Must be populated if known

Example:

"2.16.840.1.113883.6.345"

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"
}

directives.medicationsOfInterest.medicationRequests.prescribedDate

string<date>

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

Example:

"2023-12-02"

directives.medicationsOfInterest.medicationRequests.prescriber

object

Prescriber of the medication

Show child attributes

directives.medicationsOfInterest.medicationRequests.prescriber.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

directives.medicationsOfInterest.medicationRequests.prescriber.name

object

required

Show child attributes

directives.medicationsOfInterest.medicationRequests.prescriber.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

directives.medicationsOfInterest.medicationRequests.prescriber.name.given

string[]

required

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

Minimum array length: 1

directives.medicationsOfInterest.medicationRequests.prescriber.name.prefix

string

Name prefix

Example:

"Mr."

directives.medicationsOfInterest.medicationRequests.prescriber.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

directives.medicationsOfInterest.medicationRequests.facility

object

Facility where the medication was prescribed

Show child attributes

directives.medicationsOfInterest.medicationRequests.facility.name

string

required

Facility Name

Minimum string length: 1

Example:

"ABC Clinic"

directives.medicationsOfInterest.medicationRequests.facility.address

object

Facility Address

Show child attributes

directives.medicationsOfInterest.medicationRequests.facility.address.zip

string

required

5-digit zip code

Example:

"55401"

directives.medicationsOfInterest.medicationRequests.facility.address.lines

string[]

Street lines of the address

directives.medicationsOfInterest.medicationRequests.facility.address.city

string

The city

Example:

"Minneapolis"

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"
}

directives.medicationsOfInterest.medicationRequests.initialFillQuantity

number<double>

Quantity initially filled for the medication

Example:

10

directives.medicationsOfInterest.medicationRequests.numberOfRefillsAllowed

integer<int32>

Number of refills allowed for this prescription

Example:

0

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"

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"

directives.medicationsOfInterest.medicationRequests.frequencyValue

number<double>

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

Example:

1

directives.medicationsOfInterest.medicationRequests.dosageInstruction

object

Show child attributes

directives.medicationsOfInterest.medicationRequests.dosageInstruction.text

string

Prescriber's sig, or directions for taking the medication

Example:

"take 1 tablet by mouth once daily"

directives.medicationsOfInterest.medicationRequests.dosageInstruction.strengthUnit

string

Unit of the dosage strength

Example:

"mg"

directives.medicationsOfInterest.medicationRequests.dosageInstruction.strengthValue

number<double>

Value of the dosage strength

Example:

100

directives.medicationsOfInterest.medicationRequests.dosageInstruction.amountUnit

string

Unit of a single dose

Example:

"puffs"

directives.medicationsOfInterest.medicationRequests.dosageInstruction.amountValue

number<double>

Value of a single dose

Example:

2

Response

Success

correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"

Welcome

Product

Implementation

APIs

Data Requirements

Overview

Authorizations

Body

Response