Share Patient Record

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"

responsibleProvider

object

required

Provider responsible for this patient's care. This can be the Primary Care Physician (PCP), most recent provider, or a provider assigned for future care.

Show child attributes

responsibleProvider.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

responsibleProvider.name

object

required

Show child attributes

responsibleProvider.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

responsibleProvider.name.given

string[]

required

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

Minimum array length: 1

responsibleProvider.name.prefix

string

Name prefix

Example:

"Mr."

responsibleProvider.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

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

All known clinical notes about the patient which are not related to a specific encounter

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

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"

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