Panel Registration
curl --request POST \
--url https://processing-request-staging.connectivehealth.io/v1/patient-panel \
--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",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
},
"contactPoints": [
{
"value": "9525551234",
"contactPointSystem": "PHONE",
"contactPointUse": "HOME"
}
]
},
"provider": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"startDate": "2024-11-05",
"endDate": "2025-11-05",
"batchId": "BATCH-123",
"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"
}
],
"procedures": [
{
"date": "2022-12-12",
"code": {
"code": "44970",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "Laparoscopy, surgical, appendectomy"
},
"targetSite": {
"code": "66754008",
"codeSystem": "2.16.840.1.113883.6.96",
"codeSystemName": "SNOMED CT",
"displayName": "Appendix structure"
},
"note": "Procedure was well tolerated"
}
],
"immunizations": [
{
"date": "2024-10-01",
"code": {
"code": "150",
"codeSystem": "2.16.840.1.113883.12.292",
"codeSystemName": "CVX",
"displayName": "Influenza, injectable, quadrivalent, preservative free"
}
}
],
"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"
}
}
],
"consent": {}
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/patient-panel"
payload = {
"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"
}
]
},
"provider": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": ["John", "Aaron"],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"startDate": "2024-11-05",
"endDate": "2025-11-05",
"batchId": "BATCH-123",
"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"
}
],
"procedures": [
{
"date": "2022-12-12",
"code": {
"code": "44970",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "Laparoscopy, surgical, appendectomy"
},
"targetSite": {
"code": "66754008",
"codeSystem": "2.16.840.1.113883.6.96",
"codeSystemName": "SNOMED CT",
"displayName": "Appendix structure"
},
"note": "Procedure was well tolerated"
}
],
"immunizations": [
{
"date": "2024-10-01",
"code": {
"code": "150",
"codeSystem": "2.16.840.1.113883.12.292",
"codeSystemName": "CVX",
"displayName": "Influenza, injectable, quadrivalent, preservative free"
}
}
],
"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"
}
}
],
"consent": {}
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}]
},
provider: {
npi: '1414912117',
name: {family: 'Johnson', given: ['John', 'Aaron'], prefix: 'Mr.', suffix: 'Jr.'}
},
startDate: '2024-11-05',
endDate: '2025-11-05',
batchId: 'BATCH-123',
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'}],
procedures: [
{
date: '2022-12-12',
code: {
code: '44970',
codeSystem: '2.16.840.1.113883.6.12',
codeSystemName: 'CPT',
displayName: 'Laparoscopy, surgical, appendectomy'
},
targetSite: {
code: '66754008',
codeSystem: '2.16.840.1.113883.6.96',
codeSystemName: 'SNOMED CT',
displayName: 'Appendix structure'
},
note: 'Procedure was well tolerated'
}
],
immunizations: [
{
date: '2024-10-01',
code: {
code: '150',
codeSystem: '2.16.840.1.113883.12.292',
codeSystemName: 'CVX',
displayName: 'Influenza, injectable, quadrivalent, preservative free'
}
}
],
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'
}
}
],
consent: {}
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/patient-panel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://processing-request-staging.connectivehealth.io/v1/patient-panel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
],
'provider' => [
'npi' => '1414912117',
'name' => [
'family' => 'Johnson',
'given' => [
'John',
'Aaron'
],
'prefix' => 'Mr.',
'suffix' => 'Jr.'
]
],
'startDate' => '2024-11-05',
'endDate' => '2025-11-05',
'batchId' => 'BATCH-123',
'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'
]
],
'procedures' => [
[
'date' => '2022-12-12',
'code' => [
'code' => '44970',
'codeSystem' => '2.16.840.1.113883.6.12',
'codeSystemName' => 'CPT',
'displayName' => 'Laparoscopy, surgical, appendectomy'
],
'targetSite' => [
'code' => '66754008',
'codeSystem' => '2.16.840.1.113883.6.96',
'codeSystemName' => 'SNOMED CT',
'displayName' => 'Appendix structure'
],
'note' => 'Procedure was well tolerated'
]
],
'immunizations' => [
[
'date' => '2024-10-01',
'code' => [
'code' => '150',
'codeSystem' => '2.16.840.1.113883.12.292',
'codeSystemName' => 'CVX',
'displayName' => 'Influenza, injectable, quadrivalent, preservative free'
]
]
],
'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'
]
]
],
'consent' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://processing-request-staging.connectivehealth.io/v1/patient-panel"
payload := strings.NewReader("{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://processing-request-staging.connectivehealth.io/v1/patient-panel")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/patient-panel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"message": "<string>",
"_links": {},
"_embedded": {},
"logref": "<unknown>",
"path": "<unknown>"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}ADT Patient Panel
Panel Registration
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
Manage a patient’s registration on the Patient Panel for ADT monitoring. If an ADT notification event occurs, the patient will be processed.
POST
/
v1
/
patient-panel
Panel Registration
curl --request POST \
--url https://processing-request-staging.connectivehealth.io/v1/patient-panel \
--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",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
},
"contactPoints": [
{
"value": "9525551234",
"contactPointSystem": "PHONE",
"contactPointUse": "HOME"
}
]
},
"provider": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": [
"John",
"Aaron"
],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"startDate": "2024-11-05",
"endDate": "2025-11-05",
"batchId": "BATCH-123",
"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"
}
],
"procedures": [
{
"date": "2022-12-12",
"code": {
"code": "44970",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "Laparoscopy, surgical, appendectomy"
},
"targetSite": {
"code": "66754008",
"codeSystem": "2.16.840.1.113883.6.96",
"codeSystemName": "SNOMED CT",
"displayName": "Appendix structure"
},
"note": "Procedure was well tolerated"
}
],
"immunizations": [
{
"date": "2024-10-01",
"code": {
"code": "150",
"codeSystem": "2.16.840.1.113883.12.292",
"codeSystemName": "CVX",
"displayName": "Influenza, injectable, quadrivalent, preservative free"
}
}
],
"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"
}
}
],
"consent": {}
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/patient-panel"
payload = {
"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"
}
]
},
"provider": {
"npi": "1414912117",
"name": {
"family": "Johnson",
"given": ["John", "Aaron"],
"prefix": "Mr.",
"suffix": "Jr."
}
},
"startDate": "2024-11-05",
"endDate": "2025-11-05",
"batchId": "BATCH-123",
"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"
}
],
"procedures": [
{
"date": "2022-12-12",
"code": {
"code": "44970",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "Laparoscopy, surgical, appendectomy"
},
"targetSite": {
"code": "66754008",
"codeSystem": "2.16.840.1.113883.6.96",
"codeSystemName": "SNOMED CT",
"displayName": "Appendix structure"
},
"note": "Procedure was well tolerated"
}
],
"immunizations": [
{
"date": "2024-10-01",
"code": {
"code": "150",
"codeSystem": "2.16.840.1.113883.12.292",
"codeSystemName": "CVX",
"displayName": "Influenza, injectable, quadrivalent, preservative free"
}
}
],
"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"
}
}
],
"consent": {}
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}]
},
provider: {
npi: '1414912117',
name: {family: 'Johnson', given: ['John', 'Aaron'], prefix: 'Mr.', suffix: 'Jr.'}
},
startDate: '2024-11-05',
endDate: '2025-11-05',
batchId: 'BATCH-123',
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'}],
procedures: [
{
date: '2022-12-12',
code: {
code: '44970',
codeSystem: '2.16.840.1.113883.6.12',
codeSystemName: 'CPT',
displayName: 'Laparoscopy, surgical, appendectomy'
},
targetSite: {
code: '66754008',
codeSystem: '2.16.840.1.113883.6.96',
codeSystemName: 'SNOMED CT',
displayName: 'Appendix structure'
},
note: 'Procedure was well tolerated'
}
],
immunizations: [
{
date: '2024-10-01',
code: {
code: '150',
codeSystem: '2.16.840.1.113883.12.292',
codeSystemName: 'CVX',
displayName: 'Influenza, injectable, quadrivalent, preservative free'
}
}
],
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'
}
}
],
consent: {}
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/patient-panel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://processing-request-staging.connectivehealth.io/v1/patient-panel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
],
'provider' => [
'npi' => '1414912117',
'name' => [
'family' => 'Johnson',
'given' => [
'John',
'Aaron'
],
'prefix' => 'Mr.',
'suffix' => 'Jr.'
]
],
'startDate' => '2024-11-05',
'endDate' => '2025-11-05',
'batchId' => 'BATCH-123',
'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'
]
],
'procedures' => [
[
'date' => '2022-12-12',
'code' => [
'code' => '44970',
'codeSystem' => '2.16.840.1.113883.6.12',
'codeSystemName' => 'CPT',
'displayName' => 'Laparoscopy, surgical, appendectomy'
],
'targetSite' => [
'code' => '66754008',
'codeSystem' => '2.16.840.1.113883.6.96',
'codeSystemName' => 'SNOMED CT',
'displayName' => 'Appendix structure'
],
'note' => 'Procedure was well tolerated'
]
],
'immunizations' => [
[
'date' => '2024-10-01',
'code' => [
'code' => '150',
'codeSystem' => '2.16.840.1.113883.12.292',
'codeSystemName' => 'CVX',
'displayName' => 'Influenza, injectable, quadrivalent, preservative free'
]
]
],
'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'
]
]
],
'consent' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://processing-request-staging.connectivehealth.io/v1/patient-panel"
payload := strings.NewReader("{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://processing-request-staging.connectivehealth.io/v1/patient-panel")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/patient-panel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient\": {\n \"mrn\": {\n \"root\": \"1.2.3.4\",\n \"extension\": \"ABC123\"\n },\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n },\n \"birthDate\": \"1992-04-09\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n },\n \"contactPoints\": [\n {\n \"value\": \"9525551234\",\n \"contactPointSystem\": \"PHONE\",\n \"contactPointUse\": \"HOME\"\n }\n ]\n },\n \"provider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n },\n \"startDate\": \"2024-11-05\",\n \"endDate\": \"2025-11-05\",\n \"batchId\": \"BATCH-123\",\n \"activeIcd10Diagnoses\": [\n {\n \"code\": \"E66.01\",\n \"displayName\": \"Morbid (severe) obesity due to excess calories\",\n \"date\": \"2022-12-12\"\n }\n ],\n \"activeIcd9Diagnoses\": [\n {\n \"code\": \"401.1\",\n \"displayName\": \"Benign essential hypertension\",\n \"date\": \"2023-12-12\"\n }\n ],\n \"activeSnomedDiagnoses\": [\n {\n \"code\": \"34713006\",\n \"displayName\": \"Vitamin D deficiency\",\n \"date\": \"2023-11-12\"\n }\n ],\n \"procedures\": [\n {\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"44970\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"Laparoscopy, surgical, appendectomy\"\n },\n \"targetSite\": {\n \"code\": \"66754008\",\n \"codeSystem\": \"2.16.840.1.113883.6.96\",\n \"codeSystemName\": \"SNOMED CT\",\n \"displayName\": \"Appendix structure\"\n },\n \"note\": \"Procedure was well tolerated\"\n }\n ],\n \"immunizations\": [\n {\n \"date\": \"2024-10-01\",\n \"code\": {\n \"code\": \"150\",\n \"codeSystem\": \"2.16.840.1.113883.12.292\",\n \"codeSystemName\": \"CVX\",\n \"displayName\": \"Influenza, injectable, quadrivalent, preservative free\"\n }\n }\n ],\n \"medications\": [\n {\n \"active\": true,\n \"nameCode\": {\n \"code\": \"6809\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN\"\n },\n \"classCode\": {\n \"code\": \"N0000175565\",\n \"codeSystem\": \"2.16.840.1.113883.6.345\",\n \"codeSystemName\": \"MED-RT\",\n \"displayName\": \"Biguanide\"\n },\n \"scheduleCode\": {\n \"code\": \"IV\",\n \"codeSystem\": \"2.16.840.1.113883.12.477\",\n \"codeSystemName\": \"Controlled Substance Schedule\",\n \"displayName\": \"Schedule IV\"\n },\n \"medicationRequests\": [\n {\n \"code\": {\n \"code\": \"861007\",\n \"codeSystem\": \"2.16.840.1.113883.6.88\",\n \"codeSystemName\": \"RxNorm\",\n \"displayName\": \"metFORMIN hydrochloride 500 MG Oral Tablet\"\n },\n \"form\": {\n \"code\": \"C42998\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"tablet\"\n },\n \"route\": {\n \"code\": \"C38288\",\n \"codeSystem\": \"2.16.840.1.113883.3.26.1.1\",\n \"codeSystemName\": \"NCI Thesaurus\",\n \"displayName\": \"oral\"\n },\n \"prescribedDate\": \"2023-12-02\",\n \"initialFillQuantity\": 10,\n \"numberOfRefillsAllowed\": 0,\n \"timingEvent\": \"QD\",\n \"frequencyUnit\": \"d\",\n \"frequencyValue\": 1,\n \"dosageInstruction\": {\n \"text\": \"take 1 tablet by mouth once daily\",\n \"strengthUnit\": \"mg\",\n \"strengthValue\": 100,\n \"amountUnit\": \"puffs\",\n \"amountValue\": 2\n }\n }\n ]\n }\n ],\n \"clinicalNotes\": [\n {\n \"lines\": [\n \"The patient was pleasant\",\n \"Recommend following up in 2 weeks\"\n ],\n \"date\": \"2022-12-12\",\n \"code\": {\n \"code\": \"11506-3\",\n \"codeSystem\": \"2.16.840.1.113883.6.1\",\n \"codeSystemName\": \"LOINC\",\n \"displayName\": \"Progress Note\"\n }\n }\n ],\n \"consent\": {}\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"message": "<string>",
"_links": {},
"_embedded": {},
"logref": "<unknown>",
"path": "<unknown>"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}Authorizations
API Key
Body
application/json
Patient to add to the patient panel. Patients on the panel will be monitored via ADT events. If this patient already exists, it will be overwritten. Patients are never deleted; to remove a patient from the panel, set the endDate appropriately.
Show child attributes
Show child attributes
This will be the requesting provider for medical records required to generate a care summary (or FHIR bundle, etc.) as the result of an ADT event
Show child attributes
Show child attributes
Date the patient will start being monitored, in ISO-8601 format yyyy-MM-dd. Only panels generated on or after this date will include this patient. Defaults to current date.
Example:
"2024-11-05"
Date the patient will stop being monitored, in ISO-8601 format yyyy-MM-dd. If not null, only panels generated on or before this date will include this patient
Example:
"2025-11-05"
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 it not populated
Pattern:
[^<>"%;+@]*$Example:
"BATCH-123"
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
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Example:
[
{
"code": "401.1",
"displayName": "Benign essential hypertension",
"date": "2023-12-12"
}
]
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.
Show child attributes
Show child attributes
Example:
[
{
"code": "34713006",
"displayName": "Vitamin D deficiency",
"date": "2023-11-12"
}
]
All known procedures for the patient
Show child attributes
Show child attributes
All known immunizations for the patient, including historical (reported) and not-given immunizations
Show child attributes
Show child attributes
All known medications for the patient
Show child attributes
Show child attributes
Additional information provided about the patient
Show child attributes
Show child attributes
Whether patient consent has been obtained to register and/or share their data them in specific contexts. Some HIEs require consent information to register patients. It is important to include non-positive consent, as in some cases, those patients may still be eligible to have some information shared in emergencies.
Show child attributes
Show child attributes
Response
Success
Unique Connective Health identifier to correlate subsequent processing or troubleshooting
Example:
"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
Was this page helpful?