Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

PegaHC FHIR Module - Healthcare API infrastructure

Updated on January 27, 2022

The Healthcare API infrastructure contains pre-configured connectors with specified endpoint URL and populates the returned result in data pages that map the result to Healthcare data model. The following diagram illustrates the flow of execution:

Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare Pega Foundation for Healthcare

Accessing HC FHIR APIs

  1. If you have imported the Pega Foundation for Healthcare demo application and sample operators as part of installation, Log in to the application as HCFHIRAdministrator using the password that you specified when you enabled this operator; to enable Pega-provided operators, see Enabling operators.
    Otherwise, complete the following steps to create a new operator ID:
    1. Log in to Dev Studio by using the operator ID [email protected] and the password that you specified for that operator.
    2. Save a copy of the existing [email protected] operator and give it a name that identifies it as a HC Fhir Administrator operator.
    3. Add PegaHCFhir:Administrators access group to the new operator record. Click the radio button to the left of the access group to select it as the default access group.
    4. Save the new operator record.
  2. Log in as the new operator that you created.
  3. Navigate to Dev Studio > Data Model > View external data entities.
    The system shows all pre-configured Data Types that have APIs configured for them. This includes FHIR and non- FHIR APIs.Note: For additional details on non- FHIR APIs, refer to the Healthcare API Technical Specification document on your media.
  4. Navigate to the desired Data Type (Refer to the list of published APIs) and expand the section to view the Data Page and the Connect REST rule.

List of Published FHIR APIs as part of PegaHC FHIR Module

The following list shows all the data pages and Connect REST APIs configured for read and search operations for each of the FHIR Resources supported in this release and described in the Overview section.

Note: Below Data pages are configured with Endpoint Urls to invoke HAPI FHIR®© sandbox. The Endpoint URLs for all configured resources in Healthcare API are fetched through a data page called D_FHIRSettings which is explained later in the document.
Resource DataPage Operation Data Type(Class) ConnectREST
Allergy IntoleranceD_FHIR4AllergyReadReadPegaHC-Data-AllergiesAllergiesReadFHIR4
D_FHIR4AllergySearchPegaHC-Data-AllergiesAllergiesFHIR4
Care PlanD_FHIR4CarePlanReadReadPegaHC-Data-CarePlanCarePlanReadFHIR4
D_FHIR4CarePlanSearchPegaHC-Data-CarePlanCarePlanFHIR4
Condition (Problem)D_FHIR4ClinicalConditi onRead

Read

PegaHC-Data- ClinicalCondition

ConditionReadFHIR4

D_FHIR4ClinicalConditi on

Search

PegaHC-Data- ClinicalCondition

ConditionFHIR4

CoverageD_FHIR4CoverageRea d

Read

PegaHC-Data-Policy

CoverageReadFHIR4

D_FHIR4CoverageSearchPegaHC-Data-PolicyCoverageFHIR4
DeviceD_FHIR4DeviceReadReadPegaHC-Data-DeviceDeviceReadFHIR4
D_FHIR4DeviceSearchPegaHC-Data-DeviceDeviceFHIR4
Diagnostic ReportD_FHIR4DiagnosticRep ortRead

Read

PegaHC-Data- DiagnosticReportDiagnosticReportReadF HIR4
D_FHIR4DiagnosticRep ort

Search

PegaHC-Data- DiagnosticReport

DiagnosticReportFHIR4

EncounterD_FHIR4EncounterRea d

Read

PegaHC-Data- Encounter

EncounterReadFHIR4

D_FHIR4Encounter

Search

PegaHC-Data- Encounter

EncounterFHIR4

Explanation of Benefits

D_FHIR4EOBRead

Read

PegaHC-Data-Claim

ExplanationOfBenefitRe adFHIR4

D_FHIR4EOB

Search

PegaHC-Data-Claim

ExplanationOfBenefitFH IR4
Episode of CareD_FHIR4EpisodeOfCar eRead

Read

PegaHC-Data- EpisodeOfCareEpisodeOfCareReadFHI R4
D_FHIR4EpisodeOfCar e

Search

PegaHC-Data- EpisodeOfCare

EpisodeOfCareFHIR4

Family Member HistoryD_FHIR4FamilyHistory Read

Read

PegaHC-Data- MedicalHistoryFamilyMemberHistoryR eadFHIR4

D_FHIR4FamilyHistory

Search

PegaHC-Data- MedicalHistoryFamilyMemberHistoryF HIR4
GoalD_FHIR4GoalReadReadPegaHC-Data-GoalGoalReadFHIR4
D_FHIR4GoalSearchPegaHC-Data-GoalGoalFHIR4
Imaging StudyD_FHIR4ImagingStudy Read

Read

PegaHC-Data- ImagingStudyImagingStudyReadFHIR 4

D_FHIR4ImagingStudy

Search

PegaHC-Data- ImagingStudy

ImagingStudyFHIR4

ImmunizationD_FHIR4Immunization Read

Read

PegaHC-Data- ImmunizationImmunizationReadFHIR 4

D_FHIR4Immunization

Search

PegaHC-Data- Immunization

ImmunizationFHIR4

MedicationD_FHIR4MedicationRe ad

Read

PegaHC-Data- PatientMedications

MedicationReadFHIR4

D_FHIR4Medication

Search

PegaHC-Data- PatientMedications

MedicationFHIR4

Medication DispenseD_FHIR4MedicationDi spenseRead

Read

PegaHC-Data- PatientMedicationsMedicationDispenseRe adFHIR4
D_FHIR4MedicationDi spense

Search

PegaHC-Data- PatientMedicationsMedicationDispenseFHI R4
Medication StatementD_FHIR4MedicationSt atementRead

Read

PegaHC-Data- PatientMedicationsMedicationStatementR eadFHIR4
D_FHIR4MedicationSt atement

Search

PegaHC-Data- PatientMedicationsMedicationStatementF HIR4
ObservationD_FHIR4ObservationR ead

Read

PegaHC-Data- Observation

ObservationReadFHIR4

D_FHIR4Observation

Search

PegaHC-Data- Observation

ObservationFHIR4

Patient

D_FHIR4PatientRead

Read

PegaHC-Data-Party- Member

PatientReadFHIR4

D_FHIR4Patient

Search

PegaHC-Data-Party- Member

PatientFHIR4

PractitionerD_FHIR4PractitionerR ead

Read

PegaHC-Data-Party- Provider-Practitioner

PractitionerReadFHIR4

D_FHIR4Practitioner

Search

PegaHC-Data-Party- Provider-Practitioner

PractitionerFHIR4

Practitioner RoleD_FHIR4PractitionerR oleRead

Read

PegaHC-Data-Party- ProviderPractitionerRoleReadFH IR4
D_FHIR4PractitionerR ole

Search

PegaHC-Data-Party- Provider

PractitionerRoleFHIR4

ProcedureD_Fhir4ClinicalProced ureRead

Read

PegaHC-Data- ClinicalProcedure

ProcedureReadFHIR4

D_FHIR4ClinicalProced ure

Search

PegaHC-Data- ClinicalProcedure

ProcedureFHIR4

ScheduleD_FHIR4ScheduleReadReadPegaHC-Data-GoalScheduleReadFHIR4
D_FHIR4ScheduleSearchPegaHC-Data-GoalScheduleFHIR4
Slot

D_FHIR4SlotRead

Read

PegaHC-Data- AppointmentSchedule

SlotReadFHIR4

D_FHIR4SlotSearchPegaHC-Data-AppointmentScheduleSlotFHIR4

Likewise, we have below data pages with connectors configured to invoke EPIC FHIR sandbox.

Resource DataPage Operation Data Type(Class) ConnectREST
Allergy IntoleranceD_FHIR4AllergyRe adEPIC

Read

PegaHC-Data-Allergies

AllergiesReadFHIR4EPIC

D_FHIR4AllergyEP IC

Search

PegaHC-Data-Allergies

AllergiesFHIR4EPIC

Observatio nD_FHIR4Observat ionReadEPIC

Read

PegaHC-Data-Observation

ObservationReadFHIR4EPIC

D_FHIR4Observat ionEPIC

Search

PegaHC-Data-Observation

ObservationFHIR4EPIC

PatientD_FHIR4PatientR eadEPIC

Read

PegaHC-Data-Party- Member

PatientReadFHIR4EPIC

D_FHIR4PatientE PIC

Search

PegaHC-Data-Party- Member

PatientFHIR4EPIC

Epic FHIR sandbox supports using the OAuth 2.0 framework to authenticate and authorize applications. Hence, we need to configure authentication profile with OAuth2.0 to be able to integrate with EPIC FHIR sandbox. For more details, refer to OAuth 2.0 tutorial on https://fhir.epic.com/Documentation?docId=oauth2

Above OOTB data pages are configured with a sample Authentication profile called ‘EPICAuthentication’ as shown below.

You need to update the configuration by following the oAuth 2.0 tutorial to be able to run these data pages to invoke the service endpoints exposed by Open EPIC. Refer to Pega online Help for additional information on configuring Authentication, Security Settings, and Error Handling.

Detailed view of a Resource API in PegaHC FHIR Module:

The sample rules shown in the next few sections are shown using the “Member (Patient)” resource as an example. Each published resource API has similar rules associated with it.

Key rules in FHIR API execution

Rule nameRule typeUsage
D_FHIR4PatientData PageCalls the connector and identifies the request and response mapping rules.
PatientFHIR4Connect RESTCalls the REST Service using endpoint URL.
MapToPatients4Data TransformWrapper rule which calls the main mapping data transform rule.
MapToPatient4DetailsData TransformMapping data transform which maps the results to the response.

As shown below, the Source for the datapage is configured as a Connector which invokes the external system REST service using the endpoint URL. The Endpoint URLs for all configured services in Healthcare API are fetched through a dynamic settings data page called D_FHIRSettings.

Connect REST rule

The Connect REST rule supports the interaction between Pega and other systems over the Hypertext Transfer Protocol (HTTP). It identifies the resource path endpoint URL of the source system to which this rule connects, and the parameters used to pass in the request. Refer to Pega online Help for additional information on configuring Authentication, Security Settings, and Error Handling.

Connect REST rule reads the EndpointUrl from application setting rule which in turn invokes D_FHIRSettings Data page.

Note: FHIR version is passed as a parameter.

Dynamic Settings End Point URL Management Data Page

The End Point URL resource path configured on a Connect REST rule cannot be modified once the rule is finalized and locked. To be able to maintain different endpoint system URLs and reference them dynamically, the Healthcare API configuration provide a pre-configured node level dynamic settings data page called D_FHIRSettings. As shown above, this page is referenced as a parameter to retrieve the EndPointURL for the given resource.

The data source configured to fetch the end point URL is a Data Transform rule called LoadFHIR4Settings. The rule is configured with URLs for a test reference system used internally for testing the Healthcare APIs. The rule is marked for Extension and is expected to be updated in your application with URLs for your own source systems for the different resources.

Map Response Data

The MapToPatients4 data transform initiates the mapping of the response received from the source system based on the number of result pages received. The rule initiates mapping for each Member Resource in the response.

Note: Above mapping Data transform rule is marked as final and you cannot override this rule in your layer. So, we provided ‘Pre_MapToMembers4_Ext’ and ‘Post_MapToMembers4_Ext’ data transforms for any extensions in your layer. Both rules are marked for extension as shown below.
Post_MapToPatients4_Ext
Post_MapToPatients4_Ext
The data received as JSON format is stored in Param.Response which is then mapped to appropriate object class in your application. In this example, the returned member information is mapped to member class using the MapToPatient4Details data transform rule.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us