Create Encounter Summary
curl --request POST \
--url https://processing-request-staging.connectivehealth.io/v1/encounter-summary \
--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."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"encounter": {
"id": "09b21748-39f6-4c9b-9649-8d7642a19f0f",
"period": {
"startDate": "2022-12-12",
"endDate": "2022-12-14"
},
"careSetting": "AMBULATORY",
"type": {
"code": "99204",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES"
},
"diagnoses": [
{
"code": "E11.9",
"codeSystem": "2.16.840.1.113883.6.90",
"codeSystemName": "ICD10",
"displayName": "Type 2 diabetes mellitus without complications"
}
],
"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"
}
}
],
"clinicalMessageRecipients": [
{
"directAddress": "john.smith@connectivehealth.direct-ci.com",
"friendlyName": "Dr. John Smith"
}
],
"shareableWithClinicalNetworks": true
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/encounter-summary"
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."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": ["123 Main St", "Suite 517"],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"encounter": {
"id": "09b21748-39f6-4c9b-9649-8d7642a19f0f",
"period": {
"startDate": "2022-12-12",
"endDate": "2022-12-14"
},
"careSetting": "AMBULATORY",
"type": {
"code": "99204",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES"
},
"diagnoses": [
{
"code": "E11.9",
"codeSystem": "2.16.840.1.113883.6.90",
"codeSystemName": "ICD10",
"displayName": "Type 2 diabetes mellitus without complications"
}
],
"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"
}
}
],
"clinicalMessageRecipients": [
{
"directAddress": "john.smith@connectivehealth.direct-ci.com",
"friendlyName": "Dr. John Smith"
}
],
"shareableWithClinicalNetworks": True
}
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.'}
},
facility: {
name: 'ABC Clinic',
address: {
lines: ['123 Main St', 'Suite 517'],
city: 'Minneapolis',
state: 'MN',
zip: '55401'
}
},
encounter: {
id: '09b21748-39f6-4c9b-9649-8d7642a19f0f',
period: {startDate: '2022-12-12', endDate: '2022-12-14'},
careSetting: 'AMBULATORY',
type: {
code: '99204',
codeSystem: '2.16.840.1.113883.6.12',
codeSystemName: 'CPT',
displayName: 'OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES'
},
diagnoses: [
{
code: 'E11.9',
codeSystem: '2.16.840.1.113883.6.90',
codeSystemName: 'ICD10',
displayName: 'Type 2 diabetes mellitus without complications'
}
],
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'
}
}
],
clinicalMessageRecipients: [
{
directAddress: 'john.smith@connectivehealth.direct-ci.com',
friendlyName: 'Dr. John Smith'
}
],
shareableWithClinicalNetworks: true
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/encounter-summary', 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/encounter-summary",
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.'
]
],
'facility' => [
'name' => 'ABC Clinic',
'address' => [
'lines' => [
'123 Main St',
'Suite 517'
],
'city' => 'Minneapolis',
'state' => 'MN',
'zip' => '55401'
]
],
'encounter' => [
'id' => '09b21748-39f6-4c9b-9649-8d7642a19f0f',
'period' => [
'startDate' => '2022-12-12',
'endDate' => '2022-12-14'
],
'careSetting' => 'AMBULATORY',
'type' => [
'code' => '99204',
'codeSystem' => '2.16.840.1.113883.6.12',
'codeSystemName' => 'CPT',
'displayName' => 'OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES'
],
'diagnoses' => [
[
'code' => 'E11.9',
'codeSystem' => '2.16.840.1.113883.6.90',
'codeSystemName' => 'ICD10',
'displayName' => 'Type 2 diabetes mellitus without complications'
]
],
'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'
]
]
],
'clinicalMessageRecipients' => [
[
'directAddress' => 'john.smith@connectivehealth.direct-ci.com',
'friendlyName' => 'Dr. John Smith'
]
],
'shareableWithClinicalNetworks' => true
]),
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/encounter-summary"
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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\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/encounter-summary")
.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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/encounter-summary")
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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\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"
}Clinical Data
Create Encounter Summary
Data Requirements
Populate all known data. It is required for processing that as much information as possible is supplied.
Overview
Details of a patient encounter. These details are used to generate an Encounter Summary (Progress Note) CCDA document. Each encounter with a patient should generate a request to this endpoint.
POST
/
v1
/
encounter-summary
Create Encounter Summary
curl --request POST \
--url https://processing-request-staging.connectivehealth.io/v1/encounter-summary \
--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."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": [
"123 Main St",
"Suite 517"
],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"encounter": {
"id": "09b21748-39f6-4c9b-9649-8d7642a19f0f",
"period": {
"startDate": "2022-12-12",
"endDate": "2022-12-14"
},
"careSetting": "AMBULATORY",
"type": {
"code": "99204",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES"
},
"diagnoses": [
{
"code": "E11.9",
"codeSystem": "2.16.840.1.113883.6.90",
"codeSystemName": "ICD10",
"displayName": "Type 2 diabetes mellitus without complications"
}
],
"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"
}
}
],
"clinicalMessageRecipients": [
{
"directAddress": "john.smith@connectivehealth.direct-ci.com",
"friendlyName": "Dr. John Smith"
}
],
"shareableWithClinicalNetworks": true
}
'import requests
url = "https://processing-request-staging.connectivehealth.io/v1/encounter-summary"
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."
}
},
"facility": {
"name": "ABC Clinic",
"address": {
"lines": ["123 Main St", "Suite 517"],
"city": "Minneapolis",
"state": "MN",
"zip": "55401"
}
},
"encounter": {
"id": "09b21748-39f6-4c9b-9649-8d7642a19f0f",
"period": {
"startDate": "2022-12-12",
"endDate": "2022-12-14"
},
"careSetting": "AMBULATORY",
"type": {
"code": "99204",
"codeSystem": "2.16.840.1.113883.6.12",
"codeSystemName": "CPT",
"displayName": "OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES"
},
"diagnoses": [
{
"code": "E11.9",
"codeSystem": "2.16.840.1.113883.6.90",
"codeSystemName": "ICD10",
"displayName": "Type 2 diabetes mellitus without complications"
}
],
"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"
}
}
],
"clinicalMessageRecipients": [
{
"directAddress": "john.smith@connectivehealth.direct-ci.com",
"friendlyName": "Dr. John Smith"
}
],
"shareableWithClinicalNetworks": True
}
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.'}
},
facility: {
name: 'ABC Clinic',
address: {
lines: ['123 Main St', 'Suite 517'],
city: 'Minneapolis',
state: 'MN',
zip: '55401'
}
},
encounter: {
id: '09b21748-39f6-4c9b-9649-8d7642a19f0f',
period: {startDate: '2022-12-12', endDate: '2022-12-14'},
careSetting: 'AMBULATORY',
type: {
code: '99204',
codeSystem: '2.16.840.1.113883.6.12',
codeSystemName: 'CPT',
displayName: 'OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES'
},
diagnoses: [
{
code: 'E11.9',
codeSystem: '2.16.840.1.113883.6.90',
codeSystemName: 'ICD10',
displayName: 'Type 2 diabetes mellitus without complications'
}
],
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'
}
}
],
clinicalMessageRecipients: [
{
directAddress: 'john.smith@connectivehealth.direct-ci.com',
friendlyName: 'Dr. John Smith'
}
],
shareableWithClinicalNetworks: true
})
};
fetch('https://processing-request-staging.connectivehealth.io/v1/encounter-summary', 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/encounter-summary",
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.'
]
],
'facility' => [
'name' => 'ABC Clinic',
'address' => [
'lines' => [
'123 Main St',
'Suite 517'
],
'city' => 'Minneapolis',
'state' => 'MN',
'zip' => '55401'
]
],
'encounter' => [
'id' => '09b21748-39f6-4c9b-9649-8d7642a19f0f',
'period' => [
'startDate' => '2022-12-12',
'endDate' => '2022-12-14'
],
'careSetting' => 'AMBULATORY',
'type' => [
'code' => '99204',
'codeSystem' => '2.16.840.1.113883.6.12',
'codeSystemName' => 'CPT',
'displayName' => 'OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES'
],
'diagnoses' => [
[
'code' => 'E11.9',
'codeSystem' => '2.16.840.1.113883.6.90',
'codeSystemName' => 'ICD10',
'displayName' => 'Type 2 diabetes mellitus without complications'
]
],
'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'
]
]
],
'clinicalMessageRecipients' => [
[
'directAddress' => 'john.smith@connectivehealth.direct-ci.com',
'friendlyName' => 'Dr. John Smith'
]
],
'shareableWithClinicalNetworks' => true
]),
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/encounter-summary"
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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\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/encounter-summary")
.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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processing-request-staging.connectivehealth.io/v1/encounter-summary")
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 \"facility\": {\n \"name\": \"ABC Clinic\",\n \"address\": {\n \"lines\": [\n \"123 Main St\",\n \"Suite 517\"\n ],\n \"city\": \"Minneapolis\",\n \"state\": \"MN\",\n \"zip\": \"55401\"\n }\n },\n \"encounter\": {\n \"id\": \"09b21748-39f6-4c9b-9649-8d7642a19f0f\",\n \"period\": {\n \"startDate\": \"2022-12-12\",\n \"endDate\": \"2022-12-14\"\n },\n \"careSetting\": \"AMBULATORY\",\n \"type\": {\n \"code\": \"99204\",\n \"codeSystem\": \"2.16.840.1.113883.6.12\",\n \"codeSystemName\": \"CPT\",\n \"displayName\": \"OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES\"\n },\n \"diagnoses\": [\n {\n \"code\": \"E11.9\",\n \"codeSystem\": \"2.16.840.1.113883.6.90\",\n \"codeSystemName\": \"ICD10\",\n \"displayName\": \"Type 2 diabetes mellitus without complications\"\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 },\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 \"clinicalMessageRecipients\": [\n {\n \"directAddress\": \"john.smith@connectivehealth.direct-ci.com\",\n \"friendlyName\": \"Dr. John Smith\"\n }\n ],\n \"shareableWithClinicalNetworks\": true\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
Full details of an encounter
Patient to be processed
Show child attributes
Show child attributes
Main provider for the encounter
Show child attributes
Show child attributes
Facility where this encounter took place
Show child attributes
Show child attributes
Completed encounter by a provider with a patient
Show child attributes
Show child attributes
Immunizations administered, reported, or refused/not given, during this encounter
Show child attributes
Show child attributes
Recipients who should receive a copy of the generated encounter summary
Maximum array length:
10Show child attributes
Show child attributes
Should share this encounter in response to clinical network requests. Does not affect internal delivery via direct message, etc.
Response
Success
Unique Connective Health identifier to correlate subsequent processing or troubleshooting
Example:
"9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
Was this page helpful?