Skip to main content
POST
/
v1
/
patient-record
Share Patient Record
curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v1/patient-record \
  --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"
      }
    ]
  },
  "responsibleProvider": {
    "npi": "1414912117",
    "name": {
      "family": "Johnson",
      "given": [
        "John",
        "Aaron"
      ],
      "prefix": "Mr.",
      "suffix": "Jr."
    }
  },
  "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": "1414912117",
            "name": {
              "family": "Johnson",
              "given": [
                "John",
                "Aaron"
              ],
              "prefix": "Mr.",
              "suffix": "Jr."
            }
          },
          "facility": {
            "name": "ABC Clinic",
            "address": {
              "lines": [
                "123 Main St",
                "Suite 517"
              ],
              "city": "Minneapolis",
              "state": "MN",
              "zip": "55401"
            }
          },
          "initialFillQuantity": 10,
          "numberOfRefillsAllowed": 0,
          "timingEvent": "QD",
          "frequencyUnit": "d",
          "frequencyValue": 1,
          "dosageInstruction": {
            "text": "take 1 tablet by mouth once daily",
            "strengthUnit": "mg",
            "strengthValue": 100,
            "amountUnit": "puffs",
            "amountValue": 2
          }
        }
      ]
    }
  ],
  "clinicalNotes": [
    {
      "lines": [
        "The patient was pleasant",
        "Recommend following up in 2 weeks"
      ],
      "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"
      }
    }
  ],
  "batchId": "BATCH-123"
}
'
{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

Authorizations

​
apiKey
string
header
required

API Key

Body

application/json
​
patient
object
required

Patient to be processed

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

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

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

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