IS-H FHIR Configuration Guide en

Configuration Guide | PUBLIC
Document Version: 2.0 – 2020-09-04
Configuration Guide FHIR Interface for SAP

Patient Management
© 2020 SAP SE or an SAP affiliate company. All rights reserved.
THE BEST RUN

Content
1 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1 CapabilityStatement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Activate Business Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Activate Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Activate FHIR Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Read CapabilityStatement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 View FHIR Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Mapping of SAP Patient Management Entities to FHIR Resources. . . . . . . . . . . . . . . . . . . . . . . . .8
3 Configuration of Supported Integration Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.1 RESTful API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2 FHIR Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Configuration for Outbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Configuration for Inbound Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4 Map SAP Patient Management Configuration to FHIR ValueSets. . . . . . . . . . . . . . . . . . . . . . . 21

4.1 ValueSet Example Patient Gender. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.2 ValueSet Example Patient Marital Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
4.3 Shipped Mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuration Guide FHIR Interface for SAP Patient Management

2 PUBLIC Content
1 About This Guide
This guide gives an overview of the different steps you have to carry out to integrate an application with SAP
Patient Management based on the FHIR interface.
Target audience of this document are integration developers with good knowledge in SAP Patient Management
and with little experience in HL7 FHIR.
For more information about the FHIR interface, see the following:
● On SAP Help Portal at https://help.sap.com/viewer/product/SAP_FOR_HEALTHCARE, choose the Use tab

and then the Application Help SAP Patient Management Communication FHIR Interface for SAP
Patient Management .
● On SAP Help Portal at https://help.sap.com/viewer/product/SAP_FOR_HEALTHCARE, choose the
Integrate tab and then Integration Guide for Outbound FHIR Messaging.
● Simplifier project FHIR Interface for SAP Patient Management (IS-H) at https://simplifier.net/
FHIRAPIofSAPPatientManagementIS-H

About This Guide PUBLIC 3
2 Getting Started
This section describes the necessary steps to activate the FHIR interface for SAP Patient Management and to
read the capabilityStatement describing the scope of the FHIR interface.
 Note
Please make sure that the relevant SAP Notes are implemented in your system by checking any SAP Notes
for component IS-H-CM-FHI.
2.1 CapabilityStatement
SAP ships a preconfigured version of profiles in a generic form that are independent of country/region
specifics. You can adapt them for your needs. These profiles are based on the FHIR release R4. This shipped
FHIR version has the technical name SAP_ISH_R4_GEN.
This FHIR version groups a set of FHIR profiles and is bound to an SAP ABAP service endpoint. Its FHIR
capabilities are accessible through the capabilityStatement. It’s relevant for both inbound and outbound
communication.
 Note
In this guide, all configuration steps and explanations are based on the shipped FHIR version
SAP_ISH_R4_GEN.
To be able to read the capabilityStatement of SAP Patient Management, you have to ensure the following:
1. The business function IS-H_MISC1 is activated.

2. The service for inbound communication is activated.
3. The shipped FHIR version is activated.
2.1.1 Activate Business Function
For the FHIR interface, you have to activate the business function IS-H_MISC1. This activation makes the
corresponding Switch BC Sets available in the system.
For more information, see SAP Help Portal at https://help.sap.com/viewer/product/SAP_NETWEAVER/,

choose an SAP NetWeaver release, and search for Switching on Business Functions.

4 PUBLIC Getting Started
2.1.2 Activate Service
Context
To activate the inbound communication service, you set up the connection in the Internet Communication
Framework (transaction SICF).
Procedure
1. Start transaction SICF (Internet Communication Framework).

2. For Hierarchy Type, enter SERVICE and execute the transaction.
3. Under the service path default_host/sap/is-h/fhir, create a new node and enter the name of the
service element to be created.
The service and the corresponding FHIR version must have the same name. If you want to use the shipped
functionality, then enter SAP_ISH_R4_GEN.
4. For the Type of Service Node to Be Created, choose Independent Service and choose Enter.
5. In the Description area, enter a service description.
6. On the following tabs, enter the service details.
○ Service Data: No specific entries required.
○ Logon Data:
○ We recommend that you carefully choose the logon procedure by using a certificate-based
authentication.
○ We recommend that you restrict the access to the service endpoint by specifying the client. Thus,
you don’t need to provide the parameter “client” in the URL of the inbound request and also gain
more control over access scenarios to different clients (for example, test client and productive
client).
○ Handler List: Enter the handler class CL_NFHIR_HANDLER.
○ Error Pages: No specific entries required.
7. Activate the service (SICF node).
2.1.3 Activate FHIR Version
To activate the shipped FHIR version, you have to select the Active indicator for this version in Customizing
under SAP Healthcare - Industry-Specific Components for Hospitals Communication FHIR Interface
Outbound Basic FHIR Components Register FHIR Versions .

Getting Started PUBLIC 5
2.1.4 Read CapabilityStatement
After having performed the basic configuration for the FHIR interface, you can read the capabilityStatement
with the following RESTful operation:
GET http(s)://<host>:<port>/<FHIR-endpoint>/CapabilityStatement
The following figure indicates where you can find the different parts of the URL in transaction SICF:
● Using the Information on Port and Host button, you get the respective details.
● In the tree view, you get the name of the FHIR endpoint.
Transaction SICF
The functional scope that you find in the capabilityStatement is configured in Customizing under SAP
Healthcare - Industry-Specific Components for Hospitals Communication FHIR Interface Inbound
Configure FHIR Inbound Process as shown in the following figure:
Functional Scope of CapabilityStatement
In this Customizing activity, you can also find all supported RESTful interactions and messages of the
capabilityStatement.

 Example
To display the configuration for the Patient resource, do the following:
1. Select the FHIR version in the Version view and double-click Resource in the Dialog Structure.
2. Select the Patient resource in the Resource view and double-click Interaction in the Dialog Structure.
You see all supported RESTful interactions for this resource. The similar procedure applies for search
parameters and valueSet bindings.
 Note
When using the shipped FHIR version, you don’t need to perform the following Customizing activities under
SAP Healthcare - Industry-Specific Components for Hospitals Communication FHIR Interface
Outbound Basic FHIR Components . However, you can check the already populated entries for the FHIR
version SAP_ISH_R4_GEN:
● Configure FHIR Resource: You can see which FHIR resources are part of the corresponding version and
how they’re implemented using ABAP structures and implementation classes.
● Configure FHIR Component ABAP Dictionary: You can see how the used FHIR foundation and resource
data types, such as bundle, messageHeader, and identifier, are implemented in ABAP.
2.2 View FHIR Profiles
You can view the shipped FHIR profiles and other resources using the Business Document Service (BDS).
They’re grouped into the following nodes:
● SAP_ISH_R4_GEN_PROFILE: Contains the SAP Patient Management profiles.

● SAP_ISH_R4_GEN_DATATYPE: Contains the necessary FHIR data types.
● SAP_ISH_R4_GEN_EXTENSION: Contains the SAP Patient Management extensions.
To access them, do the following:
1. From the SAP menu, choose Office Business Documents Documents Find (transaction OAOR).
2. Enter the following data:
○ Class name: ISH_FHIR
○ Class type: OT
3. Choose Execute.

Getting Started PUBLIC 7
When executing the program with this data, you get a tree view with the nodes. You can export the profiles from
there and view or change them in any tool allowing for manipulating JSON objects or any FHIR-specific
modeling tool as shown in the following figure:
Viewing FHIR Profiles
 Note
When using the shipped FHIR version, you don’t need to perform the Customizing under SAP Healthcare
- Industry-Specific Components for Hospitals Communication FHIR Interface Inbound Configure
FHIR Inbound Process . However, you can check the already populated entries for the FHIR version
SAP_ISH_R4_GEN. You find more information on the included resources, search parameters, RESTful
interactions, valueSet binding, and inbound messages.
 Note
You can also view the profiles in the Simplifier project FHIR Interface for SAP Patient Management (IS-H).
2.2.1 Mapping of SAP Patient Management Entities to FHIR

Resources
SAP Patient Management has its own data model that needs to be translated and mapped to the FHIR resource
model to allow FHIR-based communication.
For more information about the mapping logic, see the Application Help for SAP Patient Management on SAP
Help Portal at https://help.sap.com/viewer/product/SAP_FOR_HEALTHCARE under Communication FHIR
Interface for SAP Patient Management Relationship Between Entities in SAP Patient Management and FHIR
Resources .

3 Configuration of Supported Integration
Scenarios
The FHIR interface for SAP Patient Management supports the following integration scenarios:
● RESTful interactions
● Message-based communication, which can be:
○ Inbound messaging
○ Outbound messaging
3.1 RESTful API
Many integration scenarios using FHIR are based on its RESTful API. It allows for Create, Update, Delete, and
Read operations on FHIR resources, combined with search and FHIR operations. Through this, you can, for
example, connect a mobile device to SAP Patient Management and display patient data.
By setting up the capabilityStatement, you’ve enabled the first RESTful interaction. It’s actually a Read
operation of the resource capabilityStatement.
You can view all supported RESTful interactions in the capabilityStatement in Customizing under SAP
Healthcare - Industry-Specific Components for Hospitals Communication FHIR Interface Inbound
Configure FHIR Inbound Process .
Similar to reading the capabilityStatement, other RESTful interactions defined in the capabilityStatement can
be performed.
 Example
Read the instance of a patient with patient identifier “1234” with the following RESTful operation:
GET http(s)://<host>:<port>/<FHIR-endpoint>/Patient/1234.
Note that you must first perform the relevant value mapping between SAP Patient Management and FHIR.
Related Information
Read CapabilityStatement [page 6]

Map SAP Patient Management Configuration to FHIR ValueSets [page 21]

Configuration of Supported Integration Scenarios PUBLIC 9
3.2 FHIR Messaging
FHIR messaging isn’t yet specified in the same way as RESTful interactions are. Especially, the definition of
events (that is, the codeSystem of message events) and the definition of the message content (that is,
predefined messageDefinitions) aren’t detailed. This leaves a certain degree of freedom to the application
developers implementing FHIR messaging and results in less plug-and-play interoperability than in the RESTful
interaction part of the FHIR specification.
However, certain aspects are specified by the FHIR standard:
The message being sent from a source application to a destination application is a bundle of type “message”.
Several resources are bundled in this message. The first is the messageHeader. The others are business
resources and depend on the type of message:
● In the messageHeader, the event of the message is specified (in messageHeader.event). The associated
valueSet is an example binding in FHIR R4.
● The messageDefinition resource specifies which other resources are communicated as part of the
message.
For the implementation of FHIR messaging, SAP takes the following approach:
● As the valueSet for the message events isn’t yet predefined by the FHIR specification, SAP designed an
event pattern based on the basic operations occurring on the business-related FHIR resources. That is, per
resource, such as Patient and Encounter, SAP defined messages like patient-created, encounter-updated,
or appointment-cancelled.
● Initial load is a particular event. Its purpose is to synchronize master data, like Practitioner, with another
system. The message with the event practitioner-initial-load sends all Practitioner instances within SAP
Patient Management as message.
● The messageDefinition defines the content of the message per resource and event and also the expected
response. You can find the messageDefinition resources per event in the capabilityStatement of SAP
Patient Management. Please note that these messageDefinitions are configurable.
● Every time an event occurs, a message is created. This message is sent by invoking the $process-
message operation at the receiver.

10 PUBLIC Configuration of Supported Integration Scenarios
As an example, take a message that is sent every time a new procedure is created. In the following figure, you
can see an instance of this message and its definition:
Example of a FHIR Message: procedure-created
● MessageDefinition
The messageDefinition describes the structure of the message that is sent containing in the .focus element
the following resources:
○ The Procedure that has been created.
○ The Patient for whom this Procedure was performed.
○ The Encounter during which the Procedure was performed.
○ In the .event element, the event procedure-created is specified.
● Actual message
○ As indicated in the FHIR standard, the actual message is a bundle of type “message” covering the
messageHeader resource in which the event is specified (procedure-created).
○ The other resources referenced through the .focus element are the resources that are specified in the
corresponding messageDefinition.
Similar to the RESTful interactions, there are predefined messages that are shipped with the FHIR version
SAP_ISH_R4_GEN. You can view the inbound messages in Customizing under SAP Healthcare - Industry-
Specific Components for Hospitals Communication FHIR Interface Inbound Configure FHIR Inbound
Process :
● By selecting the FHIR version and double-clicking Message Event in the Dialog Structure, you see all the
inbound messages defined for this FHIR version.
● By selecting one message and double-clicking Message Definition in the Dialog Structure, you see which
resources are part of this message.
 Note
Currently, you can’t see the messageDefinitions for outbound messages in the configuration. You only see
the instances when triggering the corresponding events.

3.2.1 Configuration for Outbound Messaging
Outbound FHIR messages are based on the built-in hospital communication module (HCM) events. When, for
example, a patient is created in SAP Patient Management, the HCM event NP0100 is triggered. For this event, a
FHIR message is created and then sent.
The following steps describe how to set up the outbound FHIR interface for messaging based on the shipped
generic FHIR resources grouped in the version SAP_ISH_R4_GEN.
 Note
Currently, you can’t configure the outbound messageDefinitions. The only way to modify outbound
messages is on an instance base using the Business Add-In (BAdI) NFHIR_OB_SENDER (BAdI: Outbound
Sender).
3.2.1.1 Activate Outbound FHIR Interface
Context
Activate the FHIR interface as EDI procedure for the institution for which outbound messages are to be sent.
Procedure
1. In Customizing, go to SAP Healthcare - Industry-Specific Components for Hospitals Communication

FHIR Interface Outbound Electronic Data Interchange for FHIR Activate EDI Procedure .
2. Create a new entry for the relevant institution with the value FHIR as EDI procedure.
3. Set the Active indicator for this entry.
4. Save your settings.
3.2.1.2 Set Up Technical System Connection
The technical connection between the external system and SAP Patient Management is realized by an RFC
connection of the type “G” (HTTP connection to external server).
Perform the following steps:
1. Set up the connection technically.

There are different ways of setting up this connection. Choose the appropriate one depending on your
authentication requirements.
For more information, see SAP Help Portal at https://help.sap.com/viewer/product/SAP_NETWEAVER/,
choose an SAP NetWeaver release and search for Establishing a Connection Using a Destination (SM59).
 Example
For an example of a static JSON Web Token (JWT), see the Integration Guide for Outbound FHIR
Messaging.
2. In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals Communication

FHIR Interface Outbound Communication Assign FHIR Outbound Destination Version , assign the
FHIR version (for example, SAP_ISH_R4_GEN) to the created external connection.
3.2.1.3 Enable Application Log for Outbound Event

Monitoring
If you want FHIR eventing to be logged, enable the logging either on institution or on client level.
You enable the application log in Customizing under SAP Healthcare - Industry-Specific Components for
Hospitals Communication FHIR Interface Outbound Electronic Data Interchange for FHIR :
● Configure FHIR Institution-Dependent Data

● Configure FHIR Client-Specific Data
3.2.1.4 Configure Relevant Events for FHIR
For FHIR messaging, only a subset of the HCM events is relevant. For technical reasons when mapping SAP
Patient Management movements to FHIR Encounters, the following new events are introduced:
● NV14CR: Single movement creation for FHIR communication

● NV14CH: Single movement change for FHIR communication
● NV14CA: Single movement cancel for FHIR communication
The SAP Patient Management system automatically triggers these events.
 Note
If you use the FHIR version SAP_ISH_R4_GEN, you can check the shipped settings in the following
Customizing activities:
● In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals

Communication FHIR Interface Outbound Electronic Data Interchange for FHIR Assign FHIR
Events to Business Objects , you can check, which HCM event triggers which FHIR message. You can
see, for example, that at the HCM event NL10CR, the message chargeItem-created is generated.

Communication FHIR Interface Outbound Electronic Data Interchange for FHIR Assign
Application to Events , you can check the list of HCM events.
Communication FHIR Interface Outbound Electronic Data Interchange for FHIR Assign Relevant
EDI procedure for FHIR , you can check the events that are considered for outbound FHIR messaging.
● The FHIR resources are maintained as business objects in the Healthcare Communication Framework
(HCF). In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals
Communication FHIR Interface Outbound Electronic Data Interchange for FHIR Maintain
Business Objects , you can check their object keys and other settings.
● SAP Patient Management usually processes the events in a chronological order and sends the
respective FHIR messages. In Customizing under SAP Healthcare - Industry-Specific Components for
Hospitals Communication FHIR Interface Outbound Communication Define Message
Sequence , SAP ships a sequence for event processing. This sequence ensures, for example, that the
patient master data events are processed before the events for movements. Thus, the patient record
can be created at the receiver first before any messages concerning related objects come in.
Depending on your use case, you can assign only those messages that are relevant to the external destination.
You can make these settings in Customizing under SAP Healthcare - Industry-Specific Components for
Hospitals Communication FHIR Interface Outbound Communication Assign FHIR Outbound
Destination . For an example, see the Integration Guide for Outbound FHIR Messaging.
3.2.1.5 Configure Master Data Synchronization
In addition to the FHIR messages related to transactional data, SAP Patient Management offers a master data
synchronization based on FHIR messaging.
For this synchronization, a set of messages is predefined within the FHIR version SAP_ISH_R4_GEN. These are
the so-called “initial load messages”. Through these messages, you can send data to another system so that it
can synchronize its master data.
In the Application Help for SAP Patient Management on SAP Help Portal at https://help.sap.com/viewer/
product/SAP_FOR_HEALTHCARE under Communication FHIR Interface for SAP Patient Management
Relationship Between Entities in SAP Patient Management and FHIR Resources , you can see how the master
data entities in SAP Patient Management relate to FHIR resources.
For each of these SAP Patient Management entities, an initial load message is defined. This message is sent
when running the report RNFHIR_INITIAL_LOAD. For more information about this report, see the Application
Help for SAP Patient Management on SAP Help Portal at https://help.sap.com/viewer/product/
SAP_FOR_HEALTHCARE under Communication FHIR Interface for SAP Patient Management Reports for
Data Synchronization .
The initial load messages are defined from the perspective of the SAP Patient Management entities. You can
check them in Customizing under SAP Healthcare - Industry-Specific Components for Hospitals

Communication FHIR Interface Outbound Communication Configure FHIR Initial Load . This shipped
configuration is reflected in the following table. The implementation class corresponds to the shipped initial
load processing:
Entity Initial Load Object Event Implementation Class
Patient PATIENT INITIAL LOAD N NILPAT CL_NFHIR_PAT_INITIAL_L

OAD
Building unit BU INITIAL LOAD N NILBU CL_NFHIR_BU_INITIAL_LO

AD
Organizational unit OU INITIAL LOAD N NILOU CL_NFHIR_OU_INITIAL_LO

AD
Insurance provider INSURANCE PROVIDER N NILIP CL_NFHIR_IP_INITIAL_LO

INITIAL LOAD AD
Physician PRACTITIONER INITIAL N NILPC CL_NFHIR_PRACT_INITIAL

LOAD _LOAD
Scheduling type SCHEDULE INITIAL LOAD N NILSC CL_NFHIR_SCHEDULE_INIT

IAL_LOAD
The following table describes the message content that is sent for the initial load messages. Each message is a
bundle of the mentioned FHIR resources:
Content
SAP Patient Management (That is, covered FHIR re

Entity FHIR Message Event Code Message ID source instances)
Patient with: patient-initial-load patient-initial-load-sender Patient
Patient-related insurance re Coverage

lationship
RelatedPerson
Next of kin
Appointment
Appointment
Building units location-initial-load location-initial-load-sender Building units within an insti

tution that have an assign
ment to an organizational
unit are returned as Location
instances.
In the elements Location.par

tOf and Location.managin
gOrganization, you can find
the corresponding resource
references.

Content
SAP Patient Management (That is, covered FHIR re

Entity FHIR Message Event Code Message ID source instances)
Organizational units organization-initial-load organization-initial-load- Organizational units within

sender an institution are returned as
Organization instances.
Physicians practitioner-initial-load practitioner-initial-load- For physicians, the initial load

sender message covers these FHIR
resources:
● Practitioner
● PractitionerRole
Scheduling type schedule-initial-load schedule-initial-load-sender
Planning object
You can view the messageDefinition of each initial load message by querying the system with the following
RESTful operation:
GET http(s)://<host>:<port>/<FHIR-endpoint>/MessageDefinition/<message ID>
 Example
GET http(s)://<host>:<port>/<FHIR-endpoint>/MessageDefinition/location-initial-
load-sender
3.2.1.6 Perform Value Mapping
To ensure semantic interoperability, the FHIR messages must comply with the predefined valueSets in FHIR for
all relevant elements.
The valueSet binding in Customizing under SAP Healthcare - Industry-Specific Components for Hospitals
Communication FHIR Interface Inbound Configure FHIR Inbound Process is valid for both inbound and
outbound communication.
Related Information
Map SAP Patient Management Configuration to FHIR ValueSets [page 21]

3.2.1.7 Create Job for Event Processing
Outbound messages are created and sent using report RNFHIR_EVENTS_PROCESSOR. To have them sent
periodically, schedule a job for this report with the required frequency.
3.2.2 Configuration for Inbound Messaging
SAP Patient Management processes incoming messages by validating their structure and payload and then
persisting the corresponding database objects.
In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals Communication

FHIR Interface Inbound Configure FHIR Inbound Process , you can find all inbound messages that are
accepted by the shipped FHIR version of SAP Patient Management. Select the FHIR version SAP_ISH_R4_GEN
and then double-click Message Event in the Dialog Structure.
As errors can occur during inbound message processing, they’re stored in the Forward Error Handling (FEH)
framework. You can check the message queue using the Postprocessing Office (PPO) (transaction /n/SAPPO/
PPO2). A message queue is defined per object type and object.
3.2.2.1 Configure Inbound FHIR Messages
You can visualize and configure inbound messageDefinitions in Customizing under SAP Healthcare -
Industry-Specific Components for Hospitals Communication FHIR Interface Inbound Configure FHIR
Inbound Process :
1. Select the FHIR version SAP_ISH_R4_GEN and then double-click Message Event in the Dialog Structure.
2. Select a message event and then double-click Message Definition in the Dialog Structure.
3. You can add additional resources to be processed in the corresponding inbound message.
3.2.2.2 Activate Read Access Logging for Inbound FHIR

Messaging on Instance Level
Context
To activate Read Access Logging (RAL) for inbound FHIR messaging on instance level, execute the following
steps.

Procedure
1. In client 000, start transaction SE09 and create a Customizing request.

2. Find the following entries using transaction SE16 in client 000 and include them into the request that
you’ve created:
Table Condition
SRAL_CONFIG_RT Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_KERNEL_RFC Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_CONFIG_RFC Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_FIELDS_RFC Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_LG_COND Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_LOG_FIELDS Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_LOG_GROUPS Config_id = 42010AEE27111EE9948AD2F4B798993A
SRAL_LOG_DOM sw_comp = N_FHIR, name = N_FHIR
SRAL_PURPOSES id = N_FHIR
3. Transport the request from client 000 to your test or production client using transaction SCC1.
4. Ensure that the corresponding profile parameter is enabled.
Open transaction SRALMANAGER and then choose Administration Enabling in Client . Here you can
see if the profile parameter sec/ral_enabled_for_rfc is enabled. If not, set profile parameter sec/
ral_enabled_for_rfc to 1.
3.2.2.3 Activate Read Access Logging for Inbound FHIR

Messaging on Application Level
Context
To activate Read Access Logging (RAL) for inbound FHIR messaging on application level, execute the following
steps.

Procedure
1. In Customizing, go to SAP Healthcare - Industry-Specific Components for Hospitals Tools Access

Logging Activate Access Logging for Sensitive Objects .
2. Choose New Entries.
3. In the Activate Sensitive Objects view, make the following entries:
Subobject Descrip
Institution Object ID Subobject ID Object Description tion
<Your institution> 01 01 Patient Master Data Deceased Indicator
<Your institution> 04 * OU Assignment Complete OU Assign

ment
<Your institution> 07 * Procedures Complete Procedures
<Your institution> 09 * Diagnoses Complete Diagnosis
For all these entries, in the Maintain, Display, and Denied column, choose medium.
4. Save your entries.

5. Click Activate Objects and choose Back.
6. Go to SAP Healthcare - Industry-Specific Components for Hospitals Tools Access Logging

Customer-Specific Settings for Access Logging for Sensitive Objects .
7. Select the entry <your institiution>, object ID 01 (Patient Master Data), subobject ID 01.
8. In the Dialog Structure, double-click Transactions and Reports Maintenance.
9. Choose New Entries.
10. Make the following settings:
Transaction Code Program ID Access Type
PATIENT2 SAPMHTTP 02 Maintain
PATIENT3 SAPMHTTP 03 Display
11. Save your settings.

12. For the other entries, follow steps 7 to 11 with the corresponding settings:
For entry <your institiution>, object ID 04 (OU Assignment), subobject ID *:
ACCOUNT2 SAPMHTTP 02 Maintain
ACCOUNT3 SAPMHTTP 03 Display

DIAG2 SAPMHTTP 03 Display
ENCOUNTER2 SAPMHTTP 02 Maintain
ENCOUNTER3 SAPMHTTP 03 Display
PROCEDURE3 SAPMHTTP 03 Display
For entry <your institiution>, object ID 07 (Procedures), subobject ID *:
PROCEDURE3 SAPMHTTP 03 Display
For entry <your institiution>, object ID 09 (Diagnoses), subobject ID *:
DIAG2 SAPMHTTP 02 Maintain

4 Map SAP Patient Management
Configuration to FHIR ValueSets
As SAP Patient Management has a proprietary way of storing patient-related data, a mapping to the FHIR
representation has to be performed.
The mapping from SAP Patient Management entities and attributes to FHIR resources and elements is built
into the FHIR interface. However, the mapping of SAP Patient Management values to the specific FHIR
terminology concepts, like valueSets and codeSystems, often depends on the customer or project-specific
context and therefore can’t be done automatically.
Let’s take the example of the patient’s gender and their marital status.
The following figure shows the FHIR specification for the resource Patient:
FHIR Specification for Resource Patient (This page is part of the FHIR specification.)
This specification determines the following:
● The valueSet for the gender is a required value set. This means that the values are predefined by the FHIR
standard and, in order to be compliant, only those values shall be used.
● The valueSet for the marital status is an extensible value set. This means that the specified values shall be
used if they match semantically. If not, then additional values can be added.
For all resources, check the elements and then the corresponding valueSet binding.

Map SAP Patient Management Configuration to FHIR ValueSets PUBLIC 21
4.1 ValueSet Example Patient Gender
Let’s look at the shipped SAP Patient profile and its element gender:
Patient with Element Gender (This page is part of the FHIR specification.)
On the SAP Patient Management side, the values for the patient gender are built into the application and have
the following fixed values (defined using the domain GESCHL):
● 1 for male
● 2 for female
● 3 for unknown
This means that the SAP Patient Management values 1, 2, and 3 have to be mapped to the FHIR values male,
female, other, and unknown.
The mapping is done in Customizing under SAP Healthcare - Industry-Specific Components for Hospitals
Communication FHIR Interface Inbound Define FHIR ValueSet Mapping :
1. In the ValueSet Base Data view, in column Defining URL, select http://hl7.org/fhir/ValueSet/
administrative-gender.
2. In the Dialog Structure, double-click ValueSet Details.
Patient Gender Mapping
 Note
The external codes are the FHIR codes. The internal codes are the SAP Patient Management codes.

22 PUBLIC Map SAP Patient Management Configuration to FHIR ValueSets
4.2 ValueSet Example Patient Marital Status
Let’s look at the patient’s marital status. In the FHIR standard, the corresponding valueSet binding is defined as
an extensible one containing 11 values.
Patient with Element MaritalStatus (This page is part of the FHIR specification.)
In SAP Patient Management, the marital status can be defined by the customer in Customizing under SAP
Healthcare - Industry-Specific Components for Hospitals Patient Management Patients Maintain Marital
Status . This customizing can look like this, for example:
Mar.Stat. Marital Status
0 Single
1 Marr.
2 Wid.
3 Div.
4 NM
5 Sep.
6 Unknwn
9 RegCou
A RescRP
These customer values have to be mapped to the FHIR-defined valueSet. As the SAP values are free of any
semantic (that is, no domain values exist), SAP can’t ship any mapping between the FHIR valueSet and the
SAP Patient Management values for the marital status. Thus, only a partially populated table is shipped. In this
table, you can enter the SAP Patient Management values that you have chosen and map them to the
corresponding FHIR value.

Map SAP Patient Management Configuration to FHIR ValueSets PUBLIC 23
Patient Marital Status Mapping
4.3 Shipped Mapping
To reduce the mapping effort, SAP ships parts of the required mapping that you can complete and adapt to
your needs.
Using the transaction for Business Configuration Sets (BC Sets), you can view the shipped valueSets and
mappings to SAP Patient Management values.
For information about the detailed mapping between SAP Patient Management and FHIR, see SAP Note
2963681 .

24 PUBLIC Map SAP Patient Management Configuration to FHIR ValueSets
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within
the control or responsibility of SAP.
Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use
the experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your
feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

Important Disclaimers and Legal Information PUBLIC 25
www.sap.com/contactsap
© 2020 SAP SE or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.
Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.
Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.
THE BEST RUN

IS-H FHIR Configuration Guide en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IS-H FHIR Configuration Guide en

Uploaded by

Copyright:

Available Formats

Configuration Guide | PUBLIC

Document Version: 2.0 – 2020-09-04

Configuration Guide FHIR Interface for SAP

THE BEST RUN

1 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Configuration of Supported Integration Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 Map SAP Patient Management Configuration to FHIR ValueSets. . . . . . . . . . . . . . . . . . . . . . . 21

Configuration Guide FHIR Interface for SAP Patient Management

● On SAP Help Portal at https://help.sap.com/viewer/product/SAP_FOR_HEALTHCARE, choose the Use tab

Configuration Guide FHIR Interface for SAP Patient Management

1. The business function IS-H_MISC1 is activated.

2.1.1 Activate Business Function

For more information, see SAP Help Portal at https://help.sap.com/viewer/product/SAP_NETWEAVER/,

Configuration Guide FHIR Interface for SAP Patient Management

1. Start transaction SICF (Internet Communication Framework).

2.1.3 Activate FHIR Version

Configuration Guide FHIR Interface for SAP Patient Management

Functional Scope of CapabilityStatement

Configuration Guide FHIR Interface for SAP Patient Management

To display the configuration for the Patient resource, do the following:

2.2 View FHIR Profiles

● SAP_ISH_R4_GEN_PROFILE: Contains the SAP Patient Management profiles.

To access them, do the following:

Configuration Guide FHIR Interface for SAP Patient Management

Viewing FHIR Profiles

2.2.1 Mapping of SAP Patient Management Entities to FHIR

Configuration Guide FHIR Interface for SAP Patient Management

3.1 RESTful API

Read CapabilityStatement [page 6]

Configuration Guide FHIR Interface for SAP Patient Management

However, certain aspects are specified by the FHIR standard:

Configuration Guide FHIR Interface for SAP Patient Management

Example of a FHIR Message: procedure-created

Configuration Guide FHIR Interface for SAP Patient Management

3.2.1.1 Activate Outbound FHIR Interface

1. In Customizing, go to SAP Healthcare - Industry-Specific Components for Hospitals Communication

3.2.1.2 Set Up Technical System Connection

Perform the following steps:

1. Set up the connection technically.

Configuration Guide FHIR Interface for SAP Patient Management

2. In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals Communication

3.2.1.3 Enable Application Log for Outbound Event

● Configure FHIR Institution-Dependent Data

3.2.1.4 Configure Relevant Events for FHIR

● NV14CR: Single movement creation for FHIR communication

The SAP Patient Management system automatically triggers these events.

● In Customizing under SAP Healthcare - Industry-Specific Components for Hospitals

Configuration Guide FHIR Interface for SAP Patient Management

3.2.1.5 Configure Master Data Synchronization

Configuration Guide FHIR Interface for SAP Patient Management

Entity Initial Load Object Event Implementation Class

Patient PATIENT INITIAL LOAD N NILPAT CL_NFHIR_PAT_INITIAL_L

Building unit BU INITIAL LOAD N NILBU CL_NFHIR_BU_INITIAL_LO

Organizational unit OU INITIAL LOAD N NILOU CL_NFHIR_OU_INITIAL_LO

Insurance provider INSURANCE PROVIDER N NILIP CL_NFHIR_IP_INITIAL_LO

Physician PRACTITIONER INITIAL N NILPC CL_NFHIR_PRACT_INITIAL

Scheduling type SCHEDULE INITIAL LOAD N NILSC CL_NFHIR_SCHEDULE_INIT

SAP Patient Management (That is, covered FHIR re­

Patient with: patient-initial-load patient-initial-load-sender Patient

Patient-related insurance re­ Coverage

Building units location-initial-load location-initial-load-sender Building units within an insti­

In the elements Location.par­

Configuration Guide FHIR Interface for SAP Patient Management

SAP Patient Management (That is, covered FHIR re

Patient-related insurance re Coverage

Building units location-initial-load location-initial-load-sender Building units within an insti

In the elements Location.par

SAP Patient Management (That is, covered FHIR re

<Your institution> 04 * OU Assignment Complete OU Assign