Healthcare FHIR API TECHNICAL SPECIFICATION 7.4

Transcription

1 Healthcare FHIR API TECHNICAL SPECIFICATION 7.4

2 2018 Pegasystems Inc., Cambridge, MA All rights reserved. Trademarks For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or service marks are property of their respective holders. For information about the third-party software that is delivered with the product, refer to the third-party license file on your installation media that is specific to your release. Notices This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc. This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any commitment to offer or deliver the products or services described herein. This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services consultant. Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. shall not be liable for technical or editorial errors or omissions contained herein. Pegasystems Inc. may make improvements and/or changes to the publication at any time without notice. Any references in this publication to non-pegasystems websites are provided for convenience only and do not serve as an endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of those websites is at your own risk. Information concerning non-pegasystems products was obtained from the suppliers of those products, their publications, or other publicly available sources. Address questions about non-pegasystems products to the suppliers of those products. This publication may contain examples used in daily business operations that include the names of people, companies, products, and other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business enterprise or individual is coincidental. This information is the property of: Pegasystems Inc. One Rogers Street Cambridge, MA USA Phone: (617) Fax: (617) Pega Foundation for Healthcare Document: Technical Specification Software Version: 7.4 Updated: April 2018

3 CONTENTS FHIR API technical specifications... 5 Overview... 5 Published FHIR APIs... 7 Accessing FHIR APIs... 8 FHIR API integration classes... 9 Connector rule for API Key rules in FHIR API execution Connector data page Connect REST rule Dynamic Settings End Point URL Management Data Page Map Request Data Map Response Data FHIR APIs: Key rules Allergy Intolerance: GET Allergy or Intolerance details Care Plan: GET CarePlan details Condition: GET Condition details Device: GET Device details Diagnostic Report: GET Diagnostic Report details Encounter: GET Encounter details EpisodeOfCare: GET EpisodeOfCare details FamilyMemberHistory: GET FamilyMemberHistory details Goal: GET Goal details ImagingStudy: GET ImagingStudy details Immunization: GET Immunization details MedicationDispense: GET MedicationDispense details MedicationOrder: GET MedicationOrder details MedicationStatement - GET MedicationStatement details Observation - GET Observation details Patient: GET Patient details Practitioner: GET Practitioner details Procedure - GET Procedure details Schedule - GET Schedule details Slot - GET Slot details Pega Product Overview 3

4 Testing Configuring a new API for a new FHIR Resource Extending the mapping of an existing FHIR Resource Pega Product Overview 4

5 FHIR API technical specifications Overview FHIR Fast Healthcare Interoperability Resources (hl7.org/fhir) is a next generation standards framework created by the HL7 organization. It is designed to support the interoperability and exchange of healthcare related information including clinical, administrative, public health, and research data between organizations. The specification leverages widely used RESTful APIs that use HTTP requests to GET, PUT, POST, and DELETE data. FHIR is based on Resources which are common building blocks for all data exchanges. Resources are represented as either XML or JSON. The Pega FHIR APIs in the Pega Foundation for Healthcare offer pre-configured REST/JSON connectors to integrate your application with external electronic medical / health record (EMR/EHR) systems and other clinical data repositories and GET or fetch desired information about the patients/consumers managed in your application. This version of the Pega FHIR APIs supports the current - DSTU2 - version of the FHIR Standard in the REST/JSON format for the following Resources: Resource Allergy Intolerance Care Plan Condition (Problem) Device Diagnostic Report Description Risk of harmful or undesirable, physiological which is unique to an individual and associated with exposure to a substance. Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a diagnosis during an encounter; populating a problem list or a summary statement, such as a discharge summary. This resource identifies an instance of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or nonmedical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc. The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. Pega Product Overview 5

6 Document Reference Encounter Episode of Care Family Member History Goal Imaging Study Immunization Medication Medication Dispense Medication Order Medication Statement Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. Significant health events and conditions for a person related to the patient relevant in the context of care for the patient. Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, among others. Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service- Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (for example, X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication. Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. An order for both supply of the medication and the instructions for administration of the medication to a patient. A record of a medication that is being consumed by a patient. A Medication Statement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from e.g. the patient's memory, Pega Product Overview 6

7 from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. Observation Patient Practitioner Measurements and simple assertions made about a patient, device or other subject. Demographics and other administrative information about an individual or animal receiving care or other health-related services. A person who is directly or indirectly involved in the provisioning of healthcare. Procedure An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy. Schedule A container for slot(s) of time that may be available for booking appointments. Slot A slot of time on a schedule that may be available for booking appointments. For additional information on the Resources and the Standard object model, refer to In order to make use of these APIs, you will need to connect to a source clinical data system that has a FHIR server. Pega used two publicly available sandbox environments for testing the APIs: HAPI FHIR - This is a public test server available for testing FHIR APIs Epic FHIR - This is an open source light weight access layer made available for Epic. Note: All the APIs listed above have been tested on the above open source FHIR test servers as available. The search parameters are as available at the time of the release. Pega is not responsible for any changes that may be introduced on the open source servers. Published FHIR APIs Note: The FHIR APIs are configured and packaged as the HL7/FHIR Application bundle on the HCIF media. Ensure that your administrator has installed the application bundle in your application environment to access the capability documented below. The following list shows all the data pages and Connect REST APIs configured for each of the FHIR Resources supported in this release and described in the Overview section. Pega Product Overview 7

8 Resource Data Page Data Type (Class) Connect REST Allergy Intolerance D_GetFHIRAllergies Int-Fhir-AllergiesAPI Allergies Care Plan D_GetFHIRCarePlan Int-Fhir-CarePlanAPI CarePlan Condition (Problem) D_GetFHIRCondition Int-Fhir-ConditionAPI Condition Device D_GetFHIRDevice Int-Fhir-DeviceAPI Device Diagnostic Report Document Reference D_GetFHIRDiagnosticReport DiagnosticReport Int-Fhir- DiagnosticReportAPI Int-Fhir- DocumentReferenceAPI DiagnosticReport DocumentReference Encounter D_GetFHIREncounter Int-Fhir-EncounterAPI Encounter Episode of Care D_GetFHIREpisodeOfCare Int-Fhir-EpisodeOfCareAPI EpisodeOfCare Family Member Int-Fhir- History D_GetFHIRFamilyMemberHistory FamilyMemberHistoryAPI FamilyMemberHistory Goal D_GetFHIRGoal Int-Fhir-GoalAPI Goal Imaging Study D_GetFHIRImagingStudy Int-Fhir-ImagingStudyAPI ImagingStudy Immunization D_GetFHIRImmunization Int-Fhir-ImmunizationAPI Immunization Medication D_GetFHIRMedication Int-Fhir-MedicationAPI Medication Medication Dispense Medication Order Medication Statement D_GetFHIRMedicationDispense D_GetFHIRMedicationOrder D_GetFHIRMedicationStatement Int-Fhir- MedicationDispenseAPI Int-Fhir- MedicationOrderAPI Int-Fhir- MedicationStatementAPI MedicationDispense MedicationOrder MedicationStatement Observation D_GetFHIRObservation Int-Fhir-ObservationAPI Observation Patient D_GetFHIRPatient Int-Fhir-PatientAPI Patient Practitioner D_GetFHIRProvider Int-Fhir-PractitionerAPI Practitioner Procedure D_GetFHIRProcedure Int-Fhir-ProcedureAPI Procedure Schedule D_GetFHIRSchedule Int-Fhir-ScheduleAPI Schedule Slot D_GetFHIRSlot Int-Fhir-SlotAPI Slot Note: In the above Resources we have DocumentReference and Medication for which we do not have any mapping rules created. Accessing FHIR APIs 1. Log in as FHIRAdminstrator / password: install. 2. Navigate to Designer 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. The Data Types that have FHIR APIs can be identified by the Source System which follows the FHIR Xxxxxx naming convention. Note: For additional details on non-fhir APIs, refer to the Healthcare API Technical Specification document on your media. Pega Product Overview 8

9 3. Navigate to the desired Data Type (Member (Patient) example shown below) and expand the section to view the Data Page and the Connect REST rule. FHIR API integration classes The FHIR API infrastructure provides preconfigured integration classes that were autogenerated by the Connect REST wizard based on the published contracts for each Resource. This class structure defines the data model used in mapping the data returned via API call. The classes are configured as Int-FHIR-xxxxx as shown below. Pega Product Overview 9

10 Note: 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. Connector rule for API The Healthcare API infrastructure contains pre-configured specified endpoint URL and populates the returned result in data pages. The following diagram illustrates the flow of execution: Pega Product Overview 10

11 Key rules in FHIR API execution D_FHIRMember Data Page Calls the connector and identifies the request and mapping rules Patient Connect REST Calls the REST Service using endpoint URL MapPatientRequestData Data Transform Maps the request data MapToMembers Data Transform Wrapper rule which calls the main mapping data transform rule MapToMemberDetails Data Transform Mapping data transform which maps the results to the Connector data page The Connector data page for each Resource provides the configuration for the data page definition and the data source(s) that are used to fetch the data. It also identifies the request and data mapping rules. The following Connect Data pages are configured for the APIs. Pega Product Overview 11

12 As shown below, the Source for the data 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_HCSettings as explained later in this document. Pega Product Overview 12

13 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. Pega Product Overview 13

14 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. Pega Product Overview 14

15 The data source configured to fetch the end point URL is a Data Transform rule called LoadFHIRSettings. 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 Request Data The MapPatientRequestData data transform rule provides the parameter(s) passed in the request API. Pega Product Overview 15

16 Map Response Data The MapToMembers data transform initiates the mapping of the received from the source system based on the number of result pages received. The rule initiates mapping for each Member Resource in the. 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 payer class using the MapToMemberDetails data transform rule. FHIR APIs: Key rules Allergy Intolerance: GET Allergy or Intolerance details The FHIR AllergyIntolerance resource defines clinical information about a patient s allergic to a substance. The search interaction enables the client to query for all allergies associated with a given patient's medical history for a given search parameter. Pega Product Overview 16

17 Key rules Class: Int-Fhir-AllergiesAPI Allergies D_FHIRAllergy Data Page To call connector and map request and Allergies Connect REST Call REST Service using endpoint URL MapAllergiesRequestData Data Transform To map service request data MapToAllergy Data Transform To map result data to data page MapToAllergyDetails Data Transform Map results to HCIF Allergy object Care Plan: GET CarePlan details The FHIR CarePlan resource is a broad container for summarizing the plan of treatment for a patient. The Search interaction enables the client to query for the care plan for a given patient with a given search parameters. Pega Product Overview 17

18 Key rules Class: Int-Fhir-CarePlanAPI CarePlan D_FHIRCarePlan Data Page To call connector and map request and CarePlan Connect REST Call REST Service using endpoint URL MapCommonRequestData Data Transform To map service request data MapToCarePlan Data Transform To map result data to data page MapToCarePlanDetails Data Transform Map results to HCIF Care Plan object Condition: GET Condition details The FHIR Condition resource defines detailed information about a Condition, problem, or diagnosis relevant to the health of the patient. The Search interaction enables the client to query for all problems associated with a given patient's Conditions given search parameters. Pega Product Overview 18

19 Key rules Rule Name Rule Type Usage Class: Int-Fhir-ConditionAPI Condition D_FHIRClinicalCondition Data Page To call connector and map request and Condition Connect REST Call REST Service using endpoint URL MapConditionRequestData Data Transform To map service request data MapToClinicalCondition Data Transform To map result data to data page MapToClinicalConditionDetails Data Transform Map results to HCIF Clinical Condition object Device: GET Device details The FHIR Device resource describes information about a specific patient's durable, manufactured medical items. The Search interaction enables the client to query for the devices of a patient given search parameters. Pega Product Overview 19

20 Key rules Class: Int-Fhir-DeviceAPI Device D_FHIRDevice Data Page To call connector and map request and Device Connect REST Call REST Service using endpoint URL MapDevicerequestData Data Transform To map service request data MapToDevice Data Transform To map result data to data page MapToDeviceDetails Data Transform Map results to HCIF Clinical Condition object Diagnostic Report: GET Diagnostic Report details The FHIR DiagnosticReport resource contains information about a single diagnostic service performed for a patient. The Search interaction enables the client to query for all diagnostic reports that have been filed for a patient given search parameters. Pega Product Overview 20

21 Key rules Class: Int-Fhir-DiagnosticReportAPI DiagnosticReport D_FHIRDiagnosticReport Data Page To call connector and map request and DiagnosticReport Connect REST Call REST Service using endpoint URL MapDiagnosticReportRequest Data Transform To map service request data MapToDiagnosticReport Data Transform To map result data to data page MapToDiagnosticReportDetails Data Transform Map results to HCIF Diagnostic Report object Encounter: GET Encounter details The FHIR Encounter resource is an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. The Search interaction enables the client to query for all the Encounters that have been filed for a patient given search parameters. Pega Product Overview 21

22 Key rules Class: Int-Fhir-EncounterAPI Encounter D_FHIREncounter Data Page To call connector and map request and Encounter Connect REST Call REST Service using endpoint URL MapFHIRRequestData Data Transform To map service request data MapToEncounter Data Transform To map result data to data page MapToEncounterDetails Data Transform Map results to HCIF Encounter object EpisodeOfCare: GET EpisodeOfCare details The FHIR EpisodeOfCare Resource contains information about an association of a Patient with a Healthcare Provider for a period of time under which related healthcare activities may occur. The Search interaction enables the client to query for all the information about the patient association that have been filed for a patient given search parameters. Key rules Class: Int-Fhir-EpisodeOfCareAPI EpisodeOfCare D_FHIREncounter Data Page To call connector and map request and EpisodeOfCare Connect REST Call REST Service using endpoint URL MapFHIRRequestData Data Transform To map service request data MapToEpisodeOfCare Data Transform To map result data to data page MapToEpisodeOfCareDetails Data Transform Map results to HCIF EpisodeOfCare object FamilyMemberHistory: GET FamilyMemberHistory details The FHIR FamilyMemberHistory resource defines a patient's family history. This resource returns the current status, age, and medical and surgical history of relatives related to a specific Pega Product Overview 22

23 patient. The search interaction enables the client to query for family histories based on search parameters. Key rules Class: Int-Fhir-FamilyMemberHistoryAPI FamilyMemberHistory D_FHIRFamilyHistory Data Page To call connector and map request and FamilyMemberHistory Connect REST Call REST Service using endpoint URL MapFamilyHistoryRequestData Data Transform To map service request data MapToFamilyHistory Data Transform To map result data to data page MapFamilyMemberDetails Data Transform Map results to HCIF MedicalHistory object Goal: GET Goal details The FHIR Goal resource defines objectives for a patient based on a current condition or recent procedure. The Search interaction enables the client to query for the goals of a given patient for a given search parameters. Pega Product Overview 23

24 Key rules Class: Int-Fhir-GoalAPI Goal D_FHIRGoal Data Page To call connector and map request and Goal Connect REST Call REST Service using endpoint URL MapCommonRequestData Data Transform To map service request data MapToGoal Data Transform To map result data to data page MapToGoalDetails Data Transform Map results to HCIF Goal object ImagingStudy: GET ImagingStudy details The FHIR ImagingStudy resource provides mappings of its elements to DICOM attributes. The Search interaction enables the client to query for the DICOM attributes of a given patient for a given search parameters. Pega Product Overview 24

25 Key rules Class: Int-Fhir-ImagingStudyAPI ImagingStudy D_FHIRImagingStudy Data Page To call connector and map request and ImagingStudy Connect REST Call REST Service using endpoint URL MapFHIRRequestData Data Transform To map service request data MapToImagingStudy Data Transform To map result data to data page MapToImagingStudyDetails Data Transform Map results to HCIF ImageStudy object Immunization: GET Immunization details The FHIR Immunization Resource provides information about a patient's immunizations, including the vaccine administered and details regarding the administration. The search interaction enables the client to query for all immunizations documented for a given patient for a given search parameters. Key rules Class: Int-Fhir-ImmunizationAPI Immunization D_FHIRImmunization Data Page To call connector and map request and Immunization Connect REST Call REST Service using endpoint URL MapCommonRequestData Data Transform To map service request data MapToImmunization Data Transform To map result data to data page MapToImmunizationDetails Data Transform Map results to HCIF Immunization object Pega Product Overview 25

26 MedicationDispense: GET MedicationDispense details The FHIR MedicationDispense resource covers the supply of medications to a patient. The search interaction enables the client to query for all dispense information for a given patient for a given search parameters. Key rules Class: Int-Fhir-MedicationDispenseAPI MedicationDispense D_FHIRMedicationDispense Data Page To call connector and map request and MedicationDispense Connect REST Call REST Service using endpoint URL MapFHIRRequestData Data Transform To map service request data MapToMedicationDispense Data Transform To map result data to data page MapToMedicationDispenseDetails Data Transform Map results to HCIF PatientMedications object MedicationOrder: GET MedicationOrder details The FHIR MedicationOrder resource defines detailed information about a medication that was ordered for a patient. The search interaction enables the client to query for all medications associated with a given patient's medication list for a given ID{_id}. Pega Product Overview 26

27 Key rules Class: Int-Fhir-MedicationOrderAPI MedicationOrder D_FHIRMedicationOrder Data Page To call connector and map request and MedicationOrder Connect REST Call REST Service using endpoint URL MapMedicationOrderRequestData Data Transform To map service request data MapToMedicationOrderList Data Transform To map result data to data page MapToMedicationorderDetails Data Transform Map results to HCIF PatientMedications object MedicationStatement - GET MedicationStatement details The FHIR MedicationStatement resource defines detailed information about medications being consumed by a patient. The search interaction enables the client to query for all medications associated with a given patient's medication list for a given search parameters. Pega Product Overview 27

28 Key rules Class: Int-Fhir-MedicationStatementAPI MedicationStatement D_FHIRMedicationStatement Data Page To call connector and map request and MedicationStatement Connect REST Call REST Service using endpoint URL MapMedicationStatementRequestData Data To map service request data Transform MapToMedicationStatement Data Transform To map result data to data page MapToMedicationStatementDetails Data Transform Map results to HCIF PatientMedications object Observation - GET Observation details The FHIR Observation resource defines information about a measurement or simple assertion made about a patient. The Search interaction enables the client to query for all observations of a specific name or list of names that have been filed for a given patient for a given search parameters. Pega Product Overview 28

29 Key rules Class: Int-Fhir-ObservationAPI Observation D_FHIRObservation Data Page To call connector and map request and Observation Connect REST Call REST Service using endpoint URL MapObservationRequestData Data Transform To map service request data MapToObservation Data Transform To map result data to data page MapToObservationDetails Data Transform Map results to HCIF Observation object Patient: GET Patient details The FHIR Patient resource defines demographics, care providers, and other administrative information about a person receiving care at a health organization. The search interaction enables the client to query for patients based on a specified set of demographics information for a given search parameters. Pega Product Overview 29

30 Key rules Class: Int-Fhir-PatientAPI Patient D_FHIRMember Data Page To call connector and map request and Patient Connect REST Call REST Service using endpoint URL MapPatientRequestData Data Transform To map service request data MapToMembers Data Transform To map result data to data page MapToMemberDetails Data Transform Map results to HCIF Member object Practitioner: GET Practitioner details The FHIR Practitioner resource defines demographics and identifiers for care providers at a health care organization. The search interaction enables the client to query for patients based on a specified set of demographics information for a given search parameters. Pega Product Overview 30

31 Key rules Class: Int-Fhir-PractitionerAPI Practitioner D_FHIRPractitioner Data Page To call connector and map request and Practitioner Connect REST Call REST Service using endpoint URL MapFHIRRequestData Data Transform To map service request data MapToPractitioner Data Transform To map result data to data page MapToPractitionerDetails Data Transform Map results to HCIF Practitioner object Procedure - GET Procedure details The FHIR Procedure resource defines an activity performed on or with a patient as part of the provision of care. The Search interaction enables the client to query for all of a patient's completed procedures by providing search parameters. Pega Product Overview 31

32 Key rules Class: Int-Fhir-ProcedureAPI Procedure D_FHIRClinicalProcedure Data Page To call connector and map request and Procedure Connect REST Call REST Service using endpoint URL MapCommonRequestData Data Transform To map service request data MapToClinicalProcedure Data Transform To map result data to data page MapToClinicalProcedureDetails Data Transform Map results to HCIF ClinicalProcedure object Schedule - GET Schedule details The FHIR Schedule resource defines a group of schedulable "slots" that can ultimately be used to book an appointment with a provider. The search interaction enables the client, eventually, to receive information about schedulable slots for a given provider and/or visit type given search parameters. Key rules Class: Int-Fhir-ScheduleAPI Schedule D_FHIRSchedule Data Page To call connector and map request and Schedule Connect REST Call REST Service using endpoint URL MapFHIRScheduleRequestData Data Transform To map service request data MapToSchedule Data Transform To map result data to data page Pega Product Overview 32

33 MapToScheduleDetails Data Transform Map results to HCIF Goal object Slot - GET Slot details The FHIR Slot resource defines a time during which a provider is available to see patients. The search interaction returns the slots contained within the provided schedule given search parameters. Key rules Class: Int-Fhir-SlotAPI Slot D_FHIRSlot Data Page To call connector and map request and Slot Connect REST Call REST Service using endpoint URL MapFHIRSlotRequestData Data Transform To map service request data MapToSlot Data Transform To map result data to data page MapToSlotDetails Data Transform Map results to HCIF AppointmentSchedule object Testing If you want to run a simple test to ensure the APIs work against the FHIR server: 1. Log in as FHIRAdminstrator / password: install 2. Navigate to Designer Studio > Data Model > View external data entities. 3. Expand the Patient API Data Type and click on the D_GetFHIRPatient Data Page link to open it. Pega Product Overview 33

34 4. Click Run from the Actions menu of the Data Page rule. 5. Click Run on the Run Data Page screen. Note: The Data Page is defaulted with a search parameter as was used in testing the APIs against the FHIR Source Server. Assuming that the sample End Point URL configured for the FHIR test server is still active and the server is available, the API returns the. 6. Navigate through the Results section to view the data retrieved from the FHIR Server and mapped to the FHIR data model for the Patient Resource. 7. Alternatively, you may run the Test Case associated with the Data Page to test the API. Configuring a new API for a new FHIR Resource The connector and data model are generated by using the REST Connector wizard. 1. Log into your application using the administrator login. 2. On the Designer Studio menu, navigate to Integration > Connectors > Create REST Integration. 3. Configure the System details. Provide the FHIR end-point URL of desired resource as shown below. Pega Product Overview 34

35 4. Configure the Resource path, Query String parameters, and authentication as necessary. 5. In the Resource Methods step, specify the Resource name and select the desired Method, such as GET or POST. 6. On Integration layer provide the Parent Class name and Connector name as shown below. Skip the Data Layer. You will see the following Final screen after generating Data Model: Pega Product Overview 35

36 The Generated Data Model and API infrastructure looks as shown below: 7. Extend the LoadFHIRSettings DataTransform rule in your application layer and specify the end-point URLs of your source systems. 8. Create appropriate Request Data Transform rule to map the request parameters to use with the Connect rule. See MapPatientRequestData rule for reference. Pega Product Overview 36

37 9. Analyze PegaHC-Data- classes to identify existing logical data class to map the data and/or create a new data class as needed. 10. Create the appropriate Response Data Transform rules to map the data to the appropriate Data class identified/created above. See MapToMembers and MapToMemberDetails for reference. 11. Create an appropriate Data Page (see example D_FHIRMember) to call the configured REST service and the appropriate request and Data Transform rules. Extending the mapping of an existing FHIR Resource The mapping of the API data to logical data classes in Pega Foundation for Healthcare is configured using appropriate data transform rules as mentioned in the Key Rules for each Resource. The current mapping accounts for majority of data needed for business processing. To extend the mapping to include a missing attribute, copy and extend the data transform rule in your application layer. Note: Refer to the FHIR Resource Mapping document for details on pre-configured mapping for supported FHIR Resources. Pega Product Overview 37