Activities - Patient.$summary

activities

latest

false

Integration Service activities

Patient.$summary

Patient.$summary activity for Epic FHIR, returning the active problems, allergies, medications and immunizations that are on file for one patient.

Project compatibility

Windows | Cross-platform

Overview

Description	API Method	API Path
Retrieve the International Patient Summary for one patient: their active problems, allergies, medications and immunizations in a single call, instead of searching each resource separately. Epic returns the standard IPS section set, and a section with no entries means nothing is on file.	GET	/PatientSummary/{id}

Input

Parameter	Description	Data Type
Patient Id	Required. The FHIR ID of the patient. Use Patient.$match or List Records to resolve one.	string

Output

Epic answers with an IPS document whose entries are a mix of resource types. The connector splits those entries into one group per section, alongside the document's own details and a sections list.

Each group carries the same fields the underlying FHIR resource returns through Get Record and List Records. The summary adds no fields and removes none, so the field list for a group is the field list Epic publishes for that resource.

Document details

Parameter	Description	Data Type
Document Id	The unique identifier Epic assigned to this summary document.	string
Title	The document title, for example "Patient Summary for Lopez, Camila Maria".	string
Status	The document status. Epic returns "final".	string
Date	The date on the summary composition.	string
Timestamp	When Epic generated the summary.	string
Patient Id	The FHIR ID of the patient the summary is about.	string

Sections

Parameter	Description	Data Type
Code	The LOINC code identifying the section.	string
Display	The LOINC display name for the section.	string
Entry Count	How many entries the section carries. Zero is normal — it means nothing is on file, not that access was withheld.	int32
Title	The section title, e.g. Problems, Allergies, Medications, Immunizations.	string

Output groups

Group	FHIR resource	Contents
`patient`	`Patient`	The patient the summary is about: names, identifiers, addresses, telecom entries, and contacts.
`conditions`	`Condition`	Active problems, each with its code, clinical status, and onset date.
`allergies`	`AllergyIntolerance`	Recorded allergies, each with its allergen code, criticality, reactions, and verification status.
`medications`	`MedicationRequest`	Medication orders, each with its medication code, dosage instructions, and order status.
`immunizations`	`Immunization`	Administered vaccines, each with its vaccine code, administration date, and status.

For the full field list of a group, see Epic's specification for that resource in Epic on FHIR. The patient group is the same record Patient.$match returns, and that page documents its fields in full.

The connector targets FHIR R4, so any field Epic marks as STU3-only never populates.

Key fields per group

Every group carries an Id holding the FHIR ID of that record, and a Resource Type holding the resource name. Beyond those, these are the fields an automation reads to identify and act on an entry.

Group	Field	Description	Data Type
`patient`	Name > Text	The patient's full name as a string.	string
`patient`	Birth Date	The patient's date of birth, in the format YYYY-MM-DD.	string
`patient`	Identifier > Value	The patient's ID, such as an MRN.	string
`conditions`	Code	The display name for the condition.	Object
`conditions`	Clinical Status	The clinical status, which can be active, resolved, or inactive.	Object
`conditions`	Onset Date Time	The date the condition began.	string
`allergies`	Code	The allergen name and codes.	Object
`allergies`	Criticality	The risk of clinical harm from a reaction to the substance: `unable-to-assess`, `high`, or `low`.	string
`allergies`	Clinical Status	The current calculated status of the allergy: active or inactive.	Object
`medications`	Medication Codeable Concept	Codes associated with the medication to be taken.	Object
`medications`	Dosage Instruction	Dosage instruction details.	string
`medications`	Status	Order status.	string
`immunizations`	Vaccine Code	The vaccine product administered, with code and name information. Vaccines are mapped to CVX and NDC codes.	Object
`immunizations`	Occurrence Date Time	Vaccination administration date, if available.	string
`immunizations`	Status	Status of the immunization: `completed`, `entered-in-error`, or `not-done`. Incomplete immunizations are not returned.	string

Note:

In API workflows, a single response object is returned as the output. Any required fields can be extracted directly from this object.
In RPA workflows, some output parameters may differ, but the necessary values can still be retrieved from the response object even if they are not explicitly exposed.

About the patient summary

The activity wraps Epic's Patient.$summary (International Patient Summary (IPS)) operation, and it needs the patient's FHIR ID before it can run. Patient.$match resolves one specific person to that ID, and Finding a patient covers the choice between matching and searching before you build the workflow around either.

Note:

An empty group means no data is on file. Epic returns the standard IPS section set regardless of content, so allergies: [] alongside a present Allergies section means the patient has no recorded allergies rather than withheld access. A section with entryCount: 0 is distinct from a section that was not returned at all.

When to use it

You want	Use
A general clinical picture of one patient	Patient.$summary
One clinical domain, filtered or paged	The individual activity, such as List Conditions or List Medication Requests
Data outside problems, allergies, medications and immunizations	The individual activity. The summary contains only the standard IPS sections.

Finding a patient — choosing between Patient.$match and a patient search before resolving a patient to a FHIR ID.
Patient.$match — resolving one specific person to the FHIR ID this activity needs.
Epic FHIR authentication — setting up the connection this activity uses.

Was this page helpful?

PREVIOUSPatient.$match

NEXTTechnical references

Project compatibility​

Overview​

Input​

Output​

Document details​

Sections​

Output groups​

Key fields per group​

About the patient summary​

When to use it​

Related resources​