POST
/
v1
/
scheduled-appointment
Patient Data Processing
curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v1/scheduled-appointment \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "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"
      }
    ]
  },
  "upcomingAppointmentDate": "2024-11-05",
  "upcomingAppointmentProvider": {
    "npi": "1414912117",
    "name": {
      "family": "Johnson",
      "given": [
        "John",
        "Aaron"
      ],
      "prefix": "Mr.",
      "suffix": "Jr."
    }
  },
  "clinicName": "Simple Clinic Name",
  "clinicNpi": "1414912117",
  "responseDirectAddress": "contact@yourdomain.com",
  "responseFaxNumber": "6125551234",
  "responseFriendlyName": "Heart Clinic",
  "batchId": "BATCH-123",
  "medicalSummaryPeriod": {
    "startDate": "2022-12-12",
    "endDate": "2022-12-14"
  },
  "activeIcd10Diagnoses": [
    {
      "code": "E66.01",
      "displayName": "Morbid (severe) obesity due to excess calories",
      "date": "2022-12-12"
    }
  ],
  "activeIcd9Diagnoses": [
    {
      "code": "401.1",
      "displayName": "Benign essential hypertension",
      "date": "2023-12-12"
    }
  ],
  "activeSnomedDiagnoses": [
    {
      "code": "34713006",
      "displayName": "Vitamin D deficiency",
      "date": "2023-11-12"
    }
  ],
  "medications": [
    {
      "active": true,
      "nameCode": {
        "code": "6809",
        "codeSystem": "2.16.840.1.113883.6.88",
        "codeSystemName": "RxNorm",
        "displayName": "metFORMIN"
      },
      "classCode": {
        "code": "N0000175565",
        "codeSystem": "2.16.840.1.113883.6.345",
        "codeSystemName": "MED-RT",
        "displayName": "Biguanide"
      },
      "scheduleCode": {
        "code": "IV",
        "codeSystem": "2.16.840.1.113883.12.477",
        "codeSystemName": "Controlled Substance Schedule",
        "displayName": "Schedule IV"
      },
      "medicationRequests": [
        {
          "code": {
            "code": "861007",
            "codeSystem": "2.16.840.1.113883.6.88",
            "codeSystemName": "RxNorm",
            "displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
          },
          "form": {
            "code": "C42998",
            "codeSystem": "2.16.840.1.113883.3.26.1.1",
            "codeSystemName": "NCI Thesaurus",
            "displayName": "tablet"
          },
          "route": {
            "code": "C38288",
            "codeSystem": "2.16.840.1.113883.3.26.1.1",
            "codeSystemName": "NCI Thesaurus",
            "displayName": "oral"
          },
          "prescribedDate": "2023-12-02",
          "prescriber": {
            "npi": "<any>",
            "name": "<any>"
          },
          "facility": {
            "name": "<any>",
            "address": "<any>"
          },
          "initialFillQuantity": 10,
          "numberOfRefillsAllowed": 0,
          "timingEvent": "QD",
          "frequencyUnit": "d",
          "frequencyValue": 1,
          "dosageInstruction": {
            "text": "<any>",
            "strengthUnit": "<any>",
            "strengthValue": "<any>",
            "amountUnit": "<any>",
            "amountValue": "<any>"
          }
        }
      ]
    }
  ],
  "clinicalNotes": [
    {
      "author": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      },
      "date": "2022-12-12",
      "code": {
        "code": "11506-3",
        "codeSystem": "2.16.840.1.113883.6.1",
        "codeSystemName": "LOINC",
        "displayName": "Progress Note"
      },
      "lines": [
        "The patient was pleasant",
        "Recommend following up in 2 weeks"
      ]
    }
  ],
  "directives": {
    "newPatient": false,
    "diagnosticCategories": {
      "autoimmune": false,
      "bariatric": false,
      "behavioral": false,
      "cardiovascular": false,
      "dental": false,
      "dermatological": false,
      "endocrinological": false,
      "gastroenterological": false,
      "generalSurgery": false,
      "hematological": false,
      "infectious": false,
      "lymphatic": false,
      "mens": false,
      "metabolic": false,
      "musculoskeletal": false,
      "neonatological": false,
      "neurological": false,
      "nutritional": false,
      "oncological": false,
      "ophthalmic": false,
      "otolaryngological": false,
      "pain": false,
      "pulmonary": false,
      "renal": false,
      "spinal": false,
      "stroke": false,
      "toxicological": false,
      "urological": false,
      "womens": false
    },
    "medicationsOfInterest": [
      {
        "active": true,
        "nameCode": {
          "code": "6809",
          "codeSystem": "2.16.840.1.113883.6.88",
          "codeSystemName": "RxNorm",
          "displayName": "metFORMIN"
        },
        "classCode": {
          "code": "N0000175565",
          "codeSystem": "2.16.840.1.113883.6.345",
          "codeSystemName": "MED-RT",
          "displayName": "Biguanide"
        },
        "scheduleCode": {
          "code": "IV",
          "codeSystem": "2.16.840.1.113883.12.477",
          "codeSystemName": "Controlled Substance Schedule",
          "displayName": "Schedule IV"
        },
        "medicationRequests": [
          {
            "code": {
              "code": "861007",
              "codeSystem": "2.16.840.1.113883.6.88",
              "codeSystemName": "RxNorm",
              "displayName": "metFORMIN hydrochloride 500 MG Oral Tablet"
            },
            "form": {
              "code": "C42998",
              "codeSystem": "2.16.840.1.113883.3.26.1.1",
              "codeSystemName": "NCI Thesaurus",
              "displayName": "tablet"
            },
            "route": {
              "code": "C38288",
              "codeSystem": "2.16.840.1.113883.3.26.1.1",
              "codeSystemName": "NCI Thesaurus",
              "displayName": "oral"
            },
            "prescribedDate": "2023-12-02",
            "prescriber": {
              "npi": "<any>",
              "name": "<any>"
            },
            "facility": {
              "name": "<any>",
              "address": "<any>"
            },
            "initialFillQuantity": 10,
            "numberOfRefillsAllowed": 0,
            "timingEvent": "QD",
            "frequencyUnit": "d",
            "frequencyValue": 1,
            "dosageInstruction": {
              "text": "<any>",
              "strengthUnit": "<any>",
              "strengthValue": "<any>",
              "amountUnit": "<any>",
              "amountValue": "<any>"
            }
          }
        ]
      }
    ]
  }
}'
{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

Authorizations

​
apiKey
string
header
required

API Key

Body

application/json
​
patient
object
required

Patient to be processed

​
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

​
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:

"contact@yourdomain.com"

​
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. Period of time this encounter took place. If end date is not specified then it will be defaulted to the start date

​
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

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

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.

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

All known medications about the patient

​
clinicalNotes
object[]

Additional information provided about the patient

​
directives
object

Directives which may influence how the data is processed

Response

Success

​
correlationId
string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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