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

Medication History Patient Panel Load v1

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

Response

Success

correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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

Panel Registration Medication History Patient Panel Load v1 Validate