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"
      }
    ],
    "clinicalNote": {
      "lines": [
        "The patient was pleasant",
        "Recommend following up in 2 weeks"
      ],
      "author": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      },
      "date": "2022-12-12",
      "code": {
        "code": "11506-3",
        "codeSystem": "2.16.840.1.113883.6.1",
        "codeSystemName": "LOINC",
        "displayName": "Progress Note"
      }
    }
  },
  "clinicalMessageRecipients": [
    {
      "directAddress": "[email protected]",
      "friendlyName": "Dr. John Smith"
    }
  ]
}
'

{
  "correlationId": "9e923da0-f3cb-4d2b-9fbb-17417104ffd0"
}

POST

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"
      }
    ],
    "clinicalNote": {
      "lines": [
        "The patient was pleasant",
        "Recommend following up in 2 weeks"
      ],
      "author": {
        "npi": "1414912117",
        "name": {
          "family": "Johnson",
          "given": [
            "John",
            "Aaron"
          ],
          "prefix": "Mr.",
          "suffix": "Jr."
        }
      },
      "date": "2022-12-12",
      "code": {
        "code": "11506-3",
        "codeSystem": "2.16.840.1.113883.6.1",
        "codeSystemName": "LOINC",
        "displayName": "Progress Note"
      }
    }
  },
  "clinicalMessageRecipients": [
    {
      "directAddress": "[email protected]",
      "friendlyName": "Dr. John Smith"
    }
  ]
}
'

{
  "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

Show child attributes

patient.mrn

object

required

Patient's Medical Record Number. Populated with the clinic HL7 OID home community ID and the local patient ID. Must be unique per patient

Show child attributes

patient.mrn.root

string

required

Identifier's root, generally an OID

Minimum string length: 1

Example:

"1.2.3.4"

patient.mrn.extension

string

required

Identifier value or extension

Minimum string length: 1

Example:

"ABC123"

patient.name

object

required

Show child attributes

patient.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

patient.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

patient.name.prefix

string

Name prefix

Example:

"Mr."

patient.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

patient.gender

enum<string>

required

Available options:

MALE,

FEMALE,

OTHER,

UNKNOWN

patient.birthDate

string<date>

required

Birth date of the patient in ISO-8601 format yyyy-MM-dd

Example:

"1992-04-09"

patient.address

object

required

Show child attributes

patient.address.zip

string

required

5-digit zip code

Example:

"55401"

patient.address.lines

string[]

Street lines of the address

patient.address.city

string

The city

Example:

"Minneapolis"

patient.address.state

string

State code abbreviation

Example:

"MN"

Example:

{
  "lines": ["123 Main St", "Suite 517"],
  "city": "Minneapolis",
  "state": "MN",
  "zip": "55401"
}

patient.contactPoints

object[]

Show child attributes

patient.contactPoints.value

string

required

Phone number or email address

Minimum string length: 1

Example:

"9525551234"

patient.contactPoints.contactPointSystem

enum<string>

required

Type of contact

Available options:

PHONE,

EMAIL

Example:

"PHONE"

patient.contactPoints.contactPointUse

enum<string>

required

Use for the contact

Available options:

HOME,

WORK,

MOBILE

Example:

"HOME"

provider

object

required

Main provider for the encounter

Show child attributes

provider.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

provider.name

object

required

Show child attributes

provider.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

provider.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

provider.name.prefix

string

Name prefix

Example:

"Mr."

provider.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

facility

object

required

Facility where this encounter took place

Show child attributes

facility.name

string

required

Facility Name

Minimum string length: 1

Example:

"ABC Clinic"

facility.address

object

Facility Address

Show child attributes

facility.address.zip

string

required

5-digit zip code

Example:

"55401"

facility.address.lines

string[]

Street lines of the address

facility.address.city

string

The city

Example:

"Minneapolis"

facility.address.state

string

State code abbreviation

Example:

"MN"

Example:

{
  "lines": ["123 Main St", "Suite 517"],
  "city": "Minneapolis",
  "state": "MN",
  "zip": "55401"
}

encounter

object

required

Completed encounter by a provider with a patient

Show child attributes

encounter.id

string

required

Unique ID for this particular encounter. This value to deduplicate encounters if necessary

Minimum string length: 1

Example:

"09b21748-39f6-4c9b-9649-8d7642a19f0f"

encounter.period

object

required

Period of time this encounter took place. If end date is not specified then it will be defaulted to the start date

Show child attributes

encounter.period.startDate

string<date>

required

Beginning of the period, inclusive

Example:

"2022-12-12"

encounter.period.endDate

string<date>

End of the period, inclusive

Example:

"2022-12-14"

encounter.careSetting

enum<string>

required

Classification for where the care took place

Available options:

AMBULATORY,

EMERGENCY,

FIELD,

HOME_HEALTH,

INPATIENT,

VIRTUAL

Example:

"AMBULATORY"

encounter.type

object

required

Type of the encounter. Should come from https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.3.88.12.80.32/expansion

Show child attributes

encounter.type.code

string

required

The specific code from a code system

Minimum string length: 1

Example:

"N0000175497"

encounter.type.codeSystem

string

required

Code system OID. Must be populated if known

Minimum string length: 1

Example:

"2.16.840.1.113883.6.345"

encounter.type.codeSystemName

string

required

Human-readable name of the code system name if known

Minimum string length: 1

Example:

"MED-RT"

encounter.type.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

Example:

{
  "code": "99204",
  "codeSystem": "2.16.840.1.113883.6.12",
  "codeSystemName": "CPT",
  "displayName": "OFFICE/OUTPATIENT NEW MODERATE MDM 45 MINUTES"
}

encounter.diagnoses

object[]

Diagnoses determined at the encounter. Should be ICD10 or SNOMED codes.

Show child attributes

encounter.diagnoses.code

string

required

The specific code from a code system

Minimum string length: 1

Example:

"N0000175497"

encounter.diagnoses.codeSystem

string

required

Code system OID. Must be populated if known

Minimum string length: 1

Example:

"2.16.840.1.113883.6.345"

encounter.diagnoses.codeSystemName

string

required

Human-readable name of the code system name if known

Minimum string length: 1

Example:

"MED-RT"

encounter.diagnoses.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

Example:

[
  {
    "code": "E11.9",
    "codeSystem": "2.16.840.1.113883.6.90",
    "codeSystemName": "ICD10",
    "displayName": "Type 2 diabetes mellitus without complications"
  }
]

encounter.clinicalNote

object

Additional information provided about the encounter

Show child attributes

encounter.clinicalNote.lines

string[]

required

text of the clinical note, each line will be distinctly separated on CCDA output

Minimum array length: 1

Minimum string length: 1

Example:

[
  "The patient was pleasant",
  "Recommend following up in 2 weeks"
]

encounter.clinicalNote.author

object

A medical provider

Show child attributes

encounter.clinicalNote.author.npi

string

required

NPI value

Required string length: 10

Example:

"1414912117"

encounter.clinicalNote.author.name

object

required

Show child attributes

encounter.clinicalNote.author.name.family

string

required

Family name (last name)

Minimum string length: 1

Example:

"Johnson"

encounter.clinicalNote.author.name.given

string[]

required

First and middle names. First name (at least) is required

Minimum array length: 1

encounter.clinicalNote.author.name.prefix

string

Name prefix

Example:

"Mr."

encounter.clinicalNote.author.name.suffix

string

Name suffix

Example:

"Jr."

Example:

{
  "family": "Johnson",
  "given": ["John", "Aaron"],
  "prefix": "Mr.",
  "suffix": "Jr."
}

encounter.clinicalNote.date

string<date>

Date the note was recorded or written.

Example:

"2022-12-12"

encounter.clinicalNote.code

object

Type of note content. Should come from https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.68/expansion/Latest

Show child attributes

encounter.clinicalNote.code.code

string

required

The specific code from a code system

Minimum string length: 1

Example:

"N0000175497"

encounter.clinicalNote.code.codeSystem

string

required

Code system OID. Must be populated if known

Minimum string length: 1

Example:

"2.16.840.1.113883.6.345"

encounter.clinicalNote.code.codeSystemName

string

required

Human-readable name of the code system name if known

Minimum string length: 1

Example:

"MED-RT"

encounter.clinicalNote.code.displayName

string

required

Human-readable description of the code

Minimum string length: 1

Example:

"Penicillin-class Antibacterial"

Example:

{
  "code": "11506-3",
  "codeSystem": "2.16.840.1.113883.6.1",
  "codeSystemName": "LOINC",
  "displayName": "Progress Note"
}

clinicalMessageRecipients

object[]

Recipients who should receive a copy of the generated encounter summary

Maximum array length: 10

Show child attributes

clinicalMessageRecipients.directAddress

string<email>

required

Clinical message recipient address. Should be formatted like an email.

Minimum string length: 1

Example:

"[email protected]"

clinicalMessageRecipients.friendlyName

string

Human readable version of the recipient.

Example:

"Dr. John Smith"

Response

Success

correlationId

string

Unique Connective Health identifier to correlate subsequent processing or troubleshooting

Example:

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

Share Patient Record Panel Registration

⌘I

Welcome

Product

Implementation

APIs

Create Encounter Summary

Data Requirements

Overview

Authorizations

Body

Response