GET api/PatientAccessHealthSummaries?cdaId={cdaId}&cdaSubSection={cdaSubSection}&download={download}

Returns the health summary (latest health summary if ID is not provided) of the patient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cdaId

Unique ID of health summary.

globally unique identifier

None.

cdaSubSection

Sub section name that will be returned in CDA.

string

Default value is All

download

Indicates if the request is for download or view.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

HealthSummaryModel
NameDescriptionTypeAdditional information
Id

Unique ID of the model on our system (Read only).

globally unique identifier

None.

CDAContent

The content of the health summary

string

None.

PatientExternalId

Patient's unique ID on integrating system (Required).

string

None.

PatientFirstName

First name of the patient.

string

None.

PatientMiddleName

Middle name of the patient.

string

None.

PatientLastName

Last name of the patient.

string

None.

LocationExternalId

Location's unique ID on integrating system (Required).

string

None.

LocationName

Name of the location.

string

None.

LocationTimeZoneId

Time zone ID of the location.

string

None.

DoctorExternalId

Doctor's unique ID on integrating system.

string

None.

DoctorName

Name of the doctor.

string

None.

EnteredUTC

Date when health summary entered.

string

None.

Type

Health summary type (Required). Type should be (AmbulatorySummary, SummaryOfCare or ClinicalSummary).

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "5cf4d6c8-df69-47b6-847c-a325b7dc4020",
  "CDAContent": "sample string 2",
  "PatientExternalId": "sample string 3",
  "PatientFirstName": "sample string 4",
  "PatientMiddleName": "sample string 5",
  "PatientLastName": "sample string 6",
  "LocationExternalId": "sample string 7",
  "LocationName": "sample string 8",
  "LocationTimeZoneId": "sample string 9",
  "DoctorExternalId": "sample string 10",
  "DoctorName": "sample string 11",
  "EnteredUTC": "sample string 12",
  "Type": "sample string 13"
}

application/xml, text/xml

Sample:
<HealthSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthSummaries">
  <CDAContent>sample string 2</CDAContent>
  <DoctorExternalId>sample string 10</DoctorExternalId>
  <DoctorName>sample string 11</DoctorName>
  <EnteredUTC>sample string 12</EnteredUTC>
  <Id>5cf4d6c8-df69-47b6-847c-a325b7dc4020</Id>
  <LocationExternalId>sample string 7</LocationExternalId>
  <LocationName>sample string 8</LocationName>
  <LocationTimeZoneId>sample string 9</LocationTimeZoneId>
  <PatientExternalId>sample string 3</PatientExternalId>
  <PatientFirstName>sample string 4</PatientFirstName>
  <PatientLastName>sample string 6</PatientLastName>
  <PatientMiddleName>sample string 5</PatientMiddleName>
  <Type>sample string 13</Type>
</HealthSummaryModel>