Share Patient Record

curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v2/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."
    },
    "birthDate": "1992-04-09",
    "addresses": [
      {
        "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."
    }
  },
  "diagnoses": [
    {
      "code": "E66.01",
      "codeSystem": "2.16.840.1.113883.6.90",
      "displayName": "Morbid (severe) obesity due to excess calories",
      "active": true,
      "date": "2022-12-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",
          "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"
      ],
      "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"
}

Clinical Data

Share Patient Record

Data Requirements

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

All active clinical information for a patient should be supplied in every API request. That information is used to satisfy reciprocity requirements of the various health information exchanges that Connective Health participates in. Failure to populate known clinical information for a patient is a violation of health information exchange reciprocity rules, and may result in the termination of information exchange.

Overview

Clinical patient record to share with other providers on the network. This record will ONLY be shared if the patient has ALREADY been the subject of a patient search due to either a scheduled appointment or an incoming ADT event.

POST

patient-record

Share Patient Record

curl --request POST \
  --url https://processing-request-staging.connectivehealth.io/v2/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."
    },
    "birthDate": "1992-04-09",
    "addresses": [
      {
        "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."
    }
  },
  "diagnoses": [
    {
      "code": "E66.01",
      "codeSystem": "2.16.840.1.113883.6.90",
      "displayName": "Morbid (severe) obesity due to excess calories",
      "active": true,
      "date": "2022-12-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",
          "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"
      ],
      "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

Show child attributes

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

diagnoses

object[]

All diagnoses (problems) known about the patient. If the patient is an existing patient then this list should be populated with all known diagnoses

Show child attributes

medications

object[]

All known medications about the patient

Show child attributes

clinicalNotes

object[]

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

Show child attributes

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

Pattern: [^<>"%;+@]*$

Example:

"BATCH-123"

Response

Success

correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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

Patient Data v1 Create Encounter Summary