Skip to main content
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."
    },
    "gender": "MALE",
    "birthDate": "1992-04-09",
    "address": {
      "lines": [
        "123 Main St",
        "Suite 517"
      ],
      "city": "Minneapolis",
      "state": "MN",
      "zip": "55401"
    },
    "contactPoints": [
      {
        "value": "9525551234",
        "contactPointSystem": "PHONE",
        "contactPointUse": "HOME"
      }
    ]
  },
  "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"
      }
    ]
  },
  "clinicalMessageRecipients": [
    {
      "directAddress": "john.smith@connectivehealth.direct-ci.com",
      "friendlyName": "Dr. John Smith"
    }
  ],
  "shareableWithClinicalNetworks": true
}
'
{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

Authorizations

​
apiKey
string
header
required

API Key

Body

application/json

Full details of an encounter

​
patient
object
required

Patient to be processed

​
provider
object
required

Main provider for the encounter

​
facility
object
required

Facility where this encounter took place

​
encounter
object
required

Completed encounter by a provider with a patient

​
clinicalMessageRecipients
object[]

Recipients who should receive a copy of the generated encounter summary

Maximum array length: 10
​
shareableWithClinicalNetworks
boolean
default:true

Should share this encounter in response to clinical network requests. Does not affect internal delivery via direct message, etc.

Response

Success

​
correlationId
string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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