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."
}
}
}
]
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/medication-history/patient-panel"
payload = { "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."
}
}
}
] }
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({
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.'}
}
}
]
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/medication-history/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/medication-history/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([
'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.'
]
]
]
]
]),
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/medication-history/patient-panel"
payload := strings.NewReader("{\n \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\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/medication-history/patient-panel")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/medication-history/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 \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"message": "<string>",
"_links": {
"empty": true
},
"_embedded": {
"empty": true
},
"logref": "<unknown>",
"path": "<unknown>"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"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
/
v1
/
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."
}
}
}
]
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/medication-history/patient-panel"
payload = { "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."
}
}
}
] }
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({
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.'}
}
}
]
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/medication-history/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/medication-history/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([
'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.'
]
]
]
]
]),
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/medication-history/patient-panel"
payload := strings.NewReader("{\n \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\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/medication-history/patient-panel")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/medication-history/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 \"medHistoryPatientRecords\": [\n {\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 \"requestingProvider\": {\n \"npi\": \"1414912117\",\n \"name\": {\n \"family\": \"Johnson\",\n \"given\": [\n \"John\",\n \"Aaron\"\n ],\n \"prefix\": \"Mr.\",\n \"suffix\": \"Jr.\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"message": "<string>",
"_links": {
"empty": true
},
"_embedded": {
"empty": true
},
"logref": "<unknown>",
"path": "<unknown>"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}{
"correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}Authorizations
API Key
Body
application/json
Required array length:
1 - 5000 elementsShow 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?
⌘I