Patient Panel Load

curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v1/medication-history/patient-panel \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "medHistoryPatientRecords": [
    {
      "patient": {
        "mrn": {
          "root": "1.2.3.4",
          "extension": "ABC123"
        },
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        },
        "gender": "MALE",
        "birthDate": "1992-04-09",
        "address": {
          "lines": [
            "123 Main St",
            "Suite 517"
          ],
          "city": "Minneapolis",
          "state": "MN",
          "zip": "55401"
        },
        "contactPoints": [
          {
            "value": "9525551234",
            "contactPointSystem": "PHONE",
            "contactPointUse": "HOME"
          }
        ]
      },
      "requestingProvider": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      }
    }
  ]
}
'

{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

Medication History

Patient Panel Load

Data Requirements

Populate all known data. It is required for processing that as much information as possible is supplied.

Early Access

Note, this API is still in early access and is subject to change.

Overview

Submits a panel of patients for batch processing of medication history information.

Special Validations

Patient names must have two or more name components that each have two or more characters
Patient address city must be either empty or two or more characters
Patient address state must be either empty or two or more characters

Special Processing Rules

Data may be truncated when submitted for downstream system processing based on third-party requirements
Only ASCII values 32-126 are allowed for downstream processing; all accented characters will be replaced with non-accented characters

POST

medication-history

patient-panel

Patient Panel Load

curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v1/medication-history/patient-panel \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "medHistoryPatientRecords": [
    {
      "patient": {
        "mrn": {
          "root": "1.2.3.4",
          "extension": "ABC123"
        },
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        },
        "gender": "MALE",
        "birthDate": "1992-04-09",
        "address": {
          "lines": [
            "123 Main St",
            "Suite 517"
          ],
          "city": "Minneapolis",
          "state": "MN",
          "zip": "55401"
        },
        "contactPoints": [
          {
            "value": "9525551234",
            "contactPointSystem": "PHONE",
            "contactPointUse": "HOME"
          }
        ]
      },
      "requestingProvider": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      }
    }
  ]
}
'

{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

Authorizations

apiKey

string

header

required

API Key

Body

application/json

medHistoryPatientRecords

object[]

required

Required array length: 1 - 5000 elements

Show child attributes

medHistoryPatientRecords.patient

object

required

Patient to be processed

Show child attributes

medHistoryPatientRecords.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

medHistoryPatientRecords.patient.mrn.root

string

required

Identifier's root, generally an OID

Minimum string length: 1

Example:

"1.2.3.4"

medHistoryPatientRecords.patient.mrn.extension

string

required

Identifier value or extension

Minimum string length: 1

Example:

"ABC123"

medHistoryPatientRecords.patient.name

object

required

Show child attributes

medHistoryPatientRecords.patient.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

medHistoryPatientRecords.patient.name.given

string[]

required

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

Minimum array length: 1

medHistoryPatientRecords.patient.name.prefix

string

Name prefix

Example:

"Mr."

medHistoryPatientRecords.patient.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

medHistoryPatientRecords.patient.gender

enum<string>

required

Available options:

MALE,

FEMALE,

OTHER,

UNKNOWN

medHistoryPatientRecords.patient.birthDate

string<date>

required

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

Example:

"1992-04-09"

medHistoryPatientRecords.patient.address

object

required

Show child attributes

medHistoryPatientRecords.patient.address.zip

string

required

5-digit zip code

Example:

"55401"

medHistoryPatientRecords.patient.address.lines

string[]

Street lines of the address

medHistoryPatientRecords.patient.address.city

string

The city

Example:

"Minneapolis"

medHistoryPatientRecords.patient.address.state

string

State code abbreviation

Example:

"MN"

Example:

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

medHistoryPatientRecords.patient.contactPoints

object[]

Show child attributes

medHistoryPatientRecords.patient.contactPoints.value

string

required

Phone number or email address

Minimum string length: 1

Example:

"9525551234"

medHistoryPatientRecords.patient.contactPoints.contactPointSystem

enum<string>

required

Type of contact

Available options:

PHONE,

EMAIL

Example:

"PHONE"

medHistoryPatientRecords.patient.contactPoints.contactPointUse

enum<string>

required

Use for the contact

Available options:

HOME,

WORK,

MOBILE

Example:

"HOME"

medHistoryPatientRecords.requestingProvider

object

required

A medical provider

Show child attributes

medHistoryPatientRecords.requestingProvider.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

medHistoryPatientRecords.requestingProvider.name

object

required

Show child attributes

medHistoryPatientRecords.requestingProvider.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

medHistoryPatientRecords.requestingProvider.name.given

string[]

required

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

Minimum array length: 1

medHistoryPatientRecords.requestingProvider.name.prefix

string

Name prefix

Example:

"Mr."

medHistoryPatientRecords.requestingProvider.name.suffix

string

Name suffix

Example:

"Jr."

Example:

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

Response

Success

correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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

Panel Registration Bulk Patient Panel File Load

⌘I

Welcome

Product

Implementation

APIs

Patient Panel Load

Data Requirements

Early Access

Overview

Special Validations

Special Processing Rules

Authorizations

Body

Response