6/6/2023

Healthcare Enterprise Services

Generated on: 2023-06-06 12:15:13 GMT+0000

SAP for Healthcare | IS-H 618 SP 033

PUBLIC

Original content: https://help.sap.com/docs/SAP_FOR_HEALTHCARE/e2820d0474bd41188f86dc2e1124175f?locale=en-

US&state=PRODUCTION&version=618.33

Warning

This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.

For more information, please visit the https://help.sap.com/docs/disclaimer.

This is custom documentation. For more information, please visit the SAP Help Portal 1
 6/6/2023

Healthcare Enterprise Services

Healthcare Business Partner Data Management

De nition
This component provides a unique identi er for every patient in the enterprise or in a collaborative healthcare network. This
would include the medical center, outpatient clinics, practice offices and rehabilitation facilities. All registration systems would
look to this component to obtain patient information based upon several identi ers. The PMDM component would mainly
contain patient demographic information. This component is a special implementation if the Business Partner Data
Management Component.

Technical Data

Entity Type Process Component

Software Component Version ESM ERP 606

Technical Name HealthcareBusinessPartnerDataManagement

Namespace http://sap.com/xi/ESM/ERP

Business Context and Use

The Healthcare Business Partner Data Management process component enables the maintenance and communication of
patient data (represented by the Patient business object). It allows healthcare institutions to manage patient data.

Related Process Components

The Patient Encounter Management process component manages patient encounters.

The Patient Financials process component manages billable treatments, and groups them by patient.

More Information
The Patient business object is a healthcare-speci c projection of the Business Partner business object. Consequently, this
process component is related to Business Partner Data Management.

Patient

De nition
A patient is any person who potentially receives medical attention, care, or treatment. The person is most often ill or injured
and in need of treatment by a healthcare professional.

Technical Data

Entity Type Business Object

This is custom documentation. For more information, please visit the SAP Help Portal 2
 6/6/2023

Software Component Version ESM ERP 606

Technical Name Patient

Object Category Master Data Object

Business Context and Use

Overview

The Patient business object is used to access and manage patients. It is a healthcare-speci c projection of the Business Partner
business object, and functions in the same way. The Patient business object is located within the Healthcare Business Partner
Data Management process component, which is a central process component of all hospital information systems. This process
component provides service operations to create, maintain, and read instanes of the Patient business object.

Use Case

1. A hospital scheduling clerk receives calls from patients asking for outpatient appointments. The clerk asks each patient
whether he or she has previously been a patient at the hospital. If yes, the clerk searches for the existing patient record
by name and birth date ( Find Patient by Basic Data operation). If not, the clerk creates a temporary patient entry for
the patient, and enters the patient’s name, date of birth, and insurance status ( Create Patient operation).

2. A patient, who has been admitted to the hospital before, arrives. The admission clerk searches for the patient by name
and birth date ( Find Patient by Basic Data operation). The system returns information that the patient is a bad debt
party ( Check Patient Bad Debt Party operation). For more information, the clerk views the details of the patient ( Read
Patient operation). With this information, the clerk can decide how to proceed.

Constraints
Some features of this business object are only available if the Patient business object is handled as an SAP Business Partner in
the back-end system. These restrictions are documented for each relevant service operation.

The patient’s birth date is split into three components (day, month, year) instead of being transmitted as a single element
(date). This is due to the requirement that service operations must be able to communicate the birth date even if certain
components (for example, the year of birth) are missing. In this case, for example, only the day of the month and month are
lled.The GDTs used for the birth date are DayOfMonth, Month, and Year. As these GDTs are based on established international
standards, the format of the data is also in accordance with the standards.

DayOfMonth: ʻ---DD’

Month: ʻ--MM’

Year: ʻYYYY’

For more information, see the corresponding GDT documentation.

Notes on SAP Implementation

For several elements of this business object Customizing is necessary to map external to internal data. Maintain these
with Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication ->
Preparation Service-Enabling -> Inbound Processing -> Assign GDTs to Customizing Data -> Patient .

The supplementary component information for internal and external identi cation must be maintained. For more
information on supplementary components, see Scheme Attributes at IDs and Codes .You can maintain this information
with Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication ->

This is custom documentation. For more information, please visit the SAP Help Portal 3
 6/6/2023
Preparation Service-Enabling -> Inbound Processing -> Maintain Validation Parameters -> Maintain Business Object
Identi cation . The context NPAT-EXTNR relates to the internal identi cation, and the context NPAT-PATNR relates to
the external identi cation.

The system setting for institution-speci c patients can be made in Customizing for SAP Healthcare - Industry-Speci c
Components for Hospitals under Reset Client -> System Parameters -> Maintain Client-Speci c Basic Control -> Set
Client-Speci c Control Parameters ->Whole Client .

Manage Patient In

De nition
An interface to manage patient in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction inbound

Business Context and Use

The Manage Patient In inbound service interface groups two sets of operations.

The Create Patient and Update Patient operations request to, and receive con rmation from, the Healthcare Business
Partner Data Management process component to create or update patients.

The Read Patient and Read Patient Private Patient Indicator operations query to, and receive response from, the
Healthcare Business Partner Data Management process component to view details of a patient.

Create Patient

De nition
To create an instance of the Patient business object, and con rm that the creation was successful.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPCreateRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientERPCrtRC

This is custom documentation. For more information, please visit the SAP Help Portal 4
 6/6/2023

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

When a new patient is being admitted, the Create Patient inbound operation creates a new instance of the Patient business
object to store the information.

Related Operations

The Update Patient , Maintain Patient , and Deactivate Patient operations are used to manage instances of the Patient
business object.

The Read Patient and Read Patient Private Patient Indicator operations are used to view the details of instances of the
Patient business object.

The Merge Patient operation is used to merge two instances of the Patient business object.

Features
This synchronous inbound operation creates a new patient with the information provided by the consumer. It can be performed
exactly once for a given set of input data. For information on Exactly Once (Idempotent) behavior, see Idempotent Service .

No mandatory information is required to create a patient, however, any information that is available can be provided (for
example, the patient's name or date of birth).

The information provided is used to create a new instance of the Patient business object. These values are returned with an
automatically-generated PatientID. Any external identi ers provided during the execution of this operation are used as
alternative identi ers. When an external (alternative) identi er is provided as input for other operations, this identi er is rst
converted to the internal identi er associated with it, and then processed.

Example Input

This is an example set of input data for this operation. The patient's name and birth date are entered. If required, more details
can be entered later, using the Maintain Patient or Update Patient operation.

<Patient>

<Common>

<PersonName>

<FormOfAddressCode listAgencySchemeID="" listAgencySchemeAgencyID=" "> 01 </FormOfAddressCode>

<GivenName> John </GivenName>

<FamilyName> Wilson </FamilyName>

This is custom documentation. For more information, please visit the SAP Help Portal 5
 6/6/2023
</PersonName>

<BirthDate>

<DayOfMonth> ---15 </DayOfMonth>

<Month> --05 </Month>

<Year> 1983 </Year>

</BirthDate>

</Common>

</Patient>

Message Types
PatientERPCreateCon rmation_sync

PatientERPCreateRequest_sync

Constraints
The PersonName element supports the following components: FormOfAddressCode, GivenName, FamilyName,
BirthName, NickName, AcademicTitleCode, NamePre xCode and NameSupplementCode.

In the GenderCode element, the supported values are '01' (Unknown), '02' (Male) and '03' (Female).

The value for the DeathStartDate must be greater than, or equal to, the BirthDate. The DeathEndDateTime must be
greater than the DeathStartDateTime.

Only one AddressUsage must be marked as the default AddressUsage.

The RelationshipRoleCode element supports the codes 'BUR010-2' (Is Employee Of), 'HC0002-1' (Has Family
Physician), and 'HC0001-1' (Has Health Care Payer).

For the RelationshipValidityPeriod element, the role codes 'Has Family Physician' and 'Is Employee Of' must have the
maximum validity. Only the 'Has Health Care Payer' relationship can have a validity period other than the maximum
validity.

The HealthCarePayer node is lled only for the relationship 'Has Health Care Payer'.

The HealthCarePayerCategoryCode element supports the value '3' (Third-Party Non-Individual).

The PriorityValue element can take values from 1 to 99.

The InsuredPartyAddress node supports the following components: GivenName, LastName, FormOfAddress Code,
AcademicTitleCode, NamePre xCode and NameSupplementCode, StreetName, CountryCode, StreetPostalCode,
CityName, one EmailURI and multiple TelephoneNumbers.

The InsuredPartyAlternativeIdenti cationPartyIdenti erTypeCode only supports the value 'SocialInsuranceNumber'.

The EmployerPartyAddress node supports the following components: OrganisationFormattedName, StreetName,

CountryCode, StreetPostal Code, CityName, one TelephoneNumber and one EmailURI.

The DependentRelationshipValidityPeriod element must have the maximum validity (from 01.01.1800 to 31.12.9999).

This is custom documentation. For more information, please visit the SAP Help Portal 6
 6/6/2023
The EmployerName and EmployerAddress elements in the Occupation node must be lled only when the patient has no
business partner relationship with the employer.

The EmployerAddress in the Occupation node supports the following components: CountryCode, CityName,
StreetPostalCode and StreetName are supported.

Read Patient

De nition
To read the detailed information about a patient.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPByIDQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientERPByIDQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

The Read Patient operation can be used when the details of a patient ( Patient business object) are needed.

Related Operations

The Find Patient by Basic Data and Find Patient by Identifying Elements operations are used to nd patients.

Features
This synchronous inbound operation returns the detailed information of a patient, speci ed by the patient's identi er. The
identi er can be found using the Find Patient by Basic Data operation. The detailed information returned includes data such
as the name, gender, date of birth, and relationship details.

To read the details of a patient record, the following information is required:

This is custom documentation. For more information, please visit the SAP Help Portal 7
 6/6/2023
An identi er for the patient (PatientIdenti er and optional supplementary components)

Example Input

This is an example set of input data for this operation.

<PatientSelectionByID>

<PatientID schemeID="" schemeAgencyID="" schemeAgencySchemeID="" schemeAgencySchemeAgencyID=""> 2222222

</PatientID>

</PatientSelectionByID>

Message Types
PatientERPByIDQuery_sync

PatientERPByIDResponse_sync

Prerequisites
The instance of the Patient business object must exist in the system.

Read Patient Private Patient Indicator

De nition
To read the private patient indicator of an instance of the Patient business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPPrivatePatientIndicatorByIDQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientPrivIndByIdQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

This is custom documentation. For more information, please visit the SAP Help Portal 8
 6/6/2023

Business Context and Use

During the course of admission or treatment, it is necessary to check whether a patient is a private patient (that is, a patient
insured by private health insurance), as private patients may be treated differently in comparison to patients insured by a public
healthcare provider. The Read Patient Private Patient Indicator inbound operation reads the private patient indicator of a
patient ( Patient business object).

Related Operations

The Check Patient Bad Debt Party operation is used during admission to check if the patient is bad debt party.

Features
This synchronous inbound operation checks if a patient is privately insured. This is determined on the basis of treatment
categories, chief physician choice, and other billing-relevant information (if the SAP Patient Management BAdI
ISH_PAT_PRIV_IND_READ is implemented by the customer).

To check if a patient is privately insured, the following information is required:

The identi er of the patient (PatientIdenti cation or PatientID elements)

The result of this operation is information that speci es if the patient is privately insured or not.

Message Types
PatientERPPrivatePatientIndicatorByIDQuery_sync

PatientERPPrivatePatientIndicatorByIDResponse_sync

Prerequisites
The instance of the Patient business object must exist.

Notes on SAP Implementation

The authorization object N_PATI_AKT checks the authorization of the user executing the operation. If the service
consumer does not have authorization for this operation, an error message is returned.

Executing this operation calls the BAdI ISH_PAT_PRIV_IND_READ of the ES_ISH_PAT enhancement spot. The current
algorithm uses the classi cation category of the current or last case of the patient to determine the private patient
indicator. Consumers can create their own BAdI implementation to determine this. The signature of the BAdI is:

Importing parameter: PatientID, Patient Demographic data and Insurance detail

Exporting parameter: Private Indicator, table of error messages and error type

Update Patient

De nition
To update an instance of the Patient business object, and con rm that the update was successful.

This is custom documentation. For more information, please visit the SAP Help Portal 9
 6/6/2023

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPUpdateRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientERPUpdRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior Type3

P2P Communication Enabled true

Business Context and Use

The Update Patient operation can be used when a patient's details must be updated (for example, a change of insurance
details).

Related Operations

The Create Patient , Maintain Patient , and Deactivate Patient operations are used to manage instances of the Patient
business object.

The Read Patient operation is used to view a patient's details.

The Merge Patient operation is used to merge two instances of the Patient business object.

Features
This synchronous inbound operation updates an instance of the Patient business object. It supports Exactly Once (idempotent)
processing. For more information, see Idempotent Service .

To update a Patient, the following information is needed:

The identi er of the Patient (PatientID element)

The current state identi er of the patient (ChangeStateID element)

The new values for any elements that are to be changed. The values you pass will replace the current values for these
elements.

Additionally, if the patient is hospital-speci c, the following information is also required:

The identi er of the hospital (HospitalPartyID element)

This is custom documentation. For more information, please visit the SAP Help Portal 10
 6/6/2023
A con rmation is returned with the updated details of the patient.

Example Input

This is an example set of input data for this operation. The patient identi er and current ChangeStateID value are provided,
along with an updated value for the organ donor indicator and a note.

<Patient>

<ID> 0123456789 </ID>

<ChangeStateID> 2222222222 </ChangeStateID>

<ClinicalDemographics>

<OrganDonorIndicator> true </OrganDonatorIndicator>

<OrganDonorNote> This patient is willing to donate their kidneys only. </OrganDonorNote>

</ClinicalDemographics>

</Patient>

Message Types
PatientERPUpdateCon rmation_sync

PatientERPUpdateRequest_sync

Prerequisites
Obtain the value of the ChangeStateID element of the patient with the Read Patient operation before executing this
operation. The ChangeStateID must re ect the most current patient details, otherwise this operation cannot be
executed.

The instance of the Patient business objected that is to be updated must not be deactivated or locked in the system.

Constraints
The PersonName element supports the following components: FormOfAddressCode, GivenName, FamilyName,
BirthName, NickName, AcademicTitleCode, NamePre xCode and NameSupplementCode.

In the GenderCode element, the supported values are '01' (Unknown), '02' (Male) and '03' (Female).

The value for the DeathStartDate must be greater than, or equal to, the BirthDate. The DeathEndDateTime must be
greater than the DeathStartDateTime.

Only one AddressUsage must be marked as the default AddressUsage.

The RelationshipRoleCode element supports the codes 'BUR010-2' (Is Employee Of), 'HC0002-1' (Has Family
Physician), and 'HC0001-1' (Has Health Care Payer).

For the RelationshipValidityPeriod element, the role codes 'Has Family Physician' and 'Is Employee Of' must have the
maximum validity. Only the 'Has Health Care Payer' relationship can have a validity period other than the maximum
validity.

The HealthCarePayer node is lled only for the relationship 'Has Health Care Payer'.

This is custom documentation. For more information, please visit the SAP Help Portal 11
 6/6/2023
The HealthCarePayerCategoryCode element supports the value '3' (Third-Party Non-Individual).

The PriorityValue element can take values from 1 to 99.

The InsuredPartyAddress node supports the following components: GivenName, LastName, FormOfAddress Code,
AcademicTitleCode, NamePre xCode and NameSupplementCode, StreetName, CountryCode, StreetPostalCode,
CityName, one EmailURI and multiple TelephoneNumbers.

The InsuredPartyAlternativeIdenti cationPartyIdenti erTypeCode only supports the value 'SocialInsuranceNumber'.

The EmployerPartyAddress node supports the following components: OrganisationFormattedName, StreetName,

CountryCode, StreetPostal Code, CityName, one TelephoneNumber and one EmailURI.

The DependentRelationshipValidityPeriod element must have the maximum validity (from 01.01.1800 to 31.12.9999).

The EmployerName and EmployerAddress elements in the Occupation node must be lled only when the patient has no
business partner relationship with the employer.

The EmployerAddress in the Occupation node supports the following components: CountryCode, CityName,
StreetPostalCode and StreetName.

Using services to create relationships between patient and next of kin data is only possible, if you use the SAP Business
Partner, and the next of kin already exist as business partner in SAP Patient Management. This also applies to
relationships between patient and third-party payer data.

More Information
For more information about the Change/Update behavior of this operation, see Change / Update Behavior Type 3 .

If no value is speci ed for the actionCode attributes, the following actions are taken:

If a value already exists for the element, the value is changed

If a value does not exist for the element, the value is created

Patient Action In

De nition
An interface to manage patient in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Patient Action In inbound service interface groups two sets of operations:

The Check Patient Bad Debt Party operation is a query to, and response from, the Healthcare Business Partner Data
Management process component to check whether a patient is potentially a bad debt party.

This is custom documentation. For more information, please visit the SAP Help Portal 12
 6/6/2023
The Deactivate Patient and Merge Patient operations are requests to, and responses from, the Healthcare Business
Partner Data Management process component to deactivate or merge patients.

Check Patient Bad Debt Party

De nition
To check whether a patient is potentially a bad debt party.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPBadDebtPartyCheckQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PAT_BADDBTPTY_CHK_QR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

During admittance, the system checks if the patient is listed as a bad debt party ( Check Patient Bad Debt Party operation). A
bad debt party is a person to whom the user’s attention is drawn by the system during the admission process. The user can then
decide what action to take.

Related Operations

The Read Patient Private Patient Indicator operation is used to check if a patient is a private patient.

Features
This synchronous inbound operation checks if a patient is known as a bad debt party through a set of search criteria.

To check whether a patient is potentially a bad debt party, at least one of the following pieces of information is required:

The identi er of the patient (PatientID element)

The patient’s given name (GivenName element)

This is custom documentation. For more information, please visit the SAP Help Portal 13
 6/6/2023
The patient’s surname (FamilyName element)

The patient’s date of birth (BirthDate element)

A message is returned with information on whether the patient is a bad debt party or not, and a reason for this (if available).

Message Types
PatientERPBadDebtPartyCheckQuery_sync

PatientERPBadDebtPartyCheckResponse_sync

Prerequisites
The bad debt party check function must be active. Activate this in Customizing for SAP Healthcare – Industry-Speci c
Components for Hospitals under Basic Settings -> System Parameters -> Maintain Institution -> Speci c Basic Control
.

Bad debt party patients must be identi ed and maintained in the bad debt party list.

Notes on SAP Implementation

Bad Debt Party List

The supplied search criteria are checked against a list of bad debt parties stored in the SAP Patient Management back-end
system. Patients which are classi ed as bad debt parties are itemized in this list.

The list is stored in database table NWAN and can be displayed and maintained through Customizing for SAP Healthcare under
Patient Management -> Enter Bad Debt Parties . If multiple search parameters are used, they are prioritized as below

1. Internal patient identi cation is providedAn SAP Patient Management internal PatientID is prioritized. If the ID matches
an entry stored in the system, any other supplied parameters must also match those of the entry before the patient is
agged as a bad debt party. If other search parameters are not supplied, they are ignored, and do not have to match the
stored values before the patient is agged as a bad debt party.

2. External patient identi cation is providedThe system rst converts the external ID into an internal ID, and then acts as
described for an internal ID.

3. Given Name and Family Name are providedIf the names supplied match an entry stored in the system, any other
supplied attributes must also match those of the entry before the patient is agged as a bad debt party. If other search
criteria are not supplied, they are ignored, and do not need to match the stored values before the patient is agged as a
bad debt party.

4. Other parameter combinations are providedEach element supplied must match the value stored in SAP Patient
Management before the patient is agged as a bad debt party. Any elements not supplied are ignored, and do not have
to match the stored values before the patient is agged as a bad debt party.

More Information
The following messages can be returned by this operation:

"Patient may be a bad debt party ([reason]). Perform a more detailed check" (Message 001 (N_SE_PATMDM))The
patient is listed as a bad debt party and the reason is available.

"Patient may be a bad debt party. Perform a more detailed check" (Message 004 (N_SE_PATMDM))The patient is listed
as a bad debt party and no reason is available.

This is custom documentation. For more information, please visit the SAP Help Portal 14
 6/6/2023
"Patient is not managed as bad debt party" (Message 002 (N_SE_PATMDM))The patient is not listed as a bad debt party
(under the provided search criteria).

"Bad debt party check is not active in your system" (Message 003 (N_SE_PATMDM))The bad debt party check function is
not activated in the system.

Deactivate Patient

De nition
To deactivate an instance of the Patient business object, and con rm that the deactivation was successful.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPDeactivateRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientERPDeactivateRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

When a patient’s details are no longer required, the Deactivate Patient operation can deactivate an instance of the Patient
business object. However, it remains in the system for future reference.

Related Operations

The Create Patient , Maintain Patient , Update Patient , Merge Patient , and Read Patient operations are used to
manage instances of the Patient business object.

Features
This synchronous inbound operation deactivates an instance of the Patient business object, but does not delete it. It can be
performed exactly once for a given set of input data. For information on Exactly Once (Idempotent) behavior, see Idempotent
Service .

This is custom documentation. For more information, please visit the SAP Help Portal 15
 6/6/2023
To deactivate a patient, the following information is required:

The identi er of the patient (PatientID element)

A successful execution of this operation results in a deactivated patient, with the value of the LifeCycleStatusCode element as
'4'.

Example Input

This is an example set of input data for this operation.

<Patient>

<ID> 0123456789 </ID>

</Patient>

Message Types
PatientERPDeactivateCon rmation_sync

PatientERPDeactivateRequest_sync

Prerequisites
Cancel all dependent relationships and assigned billing patient encounter groups before deactivating the patient.

Merge Patient

De nition
To merge two instances of the Patient business object, and con rm that the merge was successful.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPMergeRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ish_patmrgrc

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

This is custom documentation. For more information, please visit the SAP Help Portal 16
 6/6/2023
Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

Two instances of the Patient business object exist in the system that refer to the same patient. The Merge Patient
synchronous inbound operation merges the two sets of details, and result in one instance of the Patient business object with
newly added dependent objects.

During the merge, One of the Patient business objects is speci ed as the ʻmajor’ Patient, and remains active after the merge.
The other ʻminorʻ Patient is cancelled, and all its dependent objects are transferred to the major Patient.

Related Operations

The Merge Patient asychronous operation is used to merge two instances of the Patient business object without
returning a con rmation.

Features
This synchronous inbound operation merges two instances of the Patient business object. One of the patients is speci ed as the
'major' patient, and the other as the 'minor' patient. The major patient remains active following the merge, and the minor
patient is cancelled. This operation can be performed exactly once for a given set of input data. For information on Exactly Once
(Idempotent) behavior, see Idempotent Service .

To merge two Patient business objects, supply any (or all) of the following information:

The identi er of the major patient (PatientID and PatientAlternativeID elements)

The identi er of the minor patient (PatientID and PatientAlternativeID elements)

Alternatively, if the external identi er(s) supplied for the major patient are not currently stored, but those supplied for the
minor patient are, this operation changes the currently-existing external identi ers of the minor patient to those supplied for
the major patient. The internal identi er of the minor patient is not changed.

For example: No driving license number is stored for the major patient, but the driving license number ʻ1234567’ is stored for the
minor patient. This operation is executed with the value ʻ2222222’ supplied as the driving license number of the major patient,
and ʻ1234567’ supplied for the minor patient. The result is that the driving license number of the minor patient is replaced with
ʻ2222222’.

A successful execution of this operation takes the form of either an active Patient business object with additional dependent
objects, or a change in the external identi ers of the minor patient. Example Input

This is an example set of input for this operation.

<MajorPatient>

<ID schemeID="ISH_PATIENT_INTERNAL_ID" schemeAgencyID=""> 0123456789 </ID>

</MajorPatient>

<MinorPatient>

<ID> 9876543210 </ID>

This is custom documentation. For more information, please visit the SAP Help Portal 17
 6/6/2023
</MinorPatient>

Message Types
PatientERPMergeCon rmation_sync

PatientERPMergeRequest_sync

Prerequisites
Two active instances of the Patient business object must exist for the same patient.

No restrictions prohibit the transfer of all dependent objects from the minor patient to the major patient. These
restrictions relate to Financial Accounting and assigned records.

The patient has a customer in Financial Accounting with open or cleared items, copayments in collection, or
receivable procedures.

The patient has assigned medical records, renewable documents or electronic cards.

At least one valid identi er for each instance of the Patient business object is supplied.

Constraints
A check on cleared items in Financial Accounting is performed in the SAP Patient Management system and cannot be disabled.

Patient Event Out

De nition
An interface to inform of any changes in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction outbound

Business Context and Use

The Patient Event Out outbound service interface groups operations that send information to external systems about the
details of a patient.

Inform of Patient Change

De nition
To inform connected systems of a changed instance of the Patient business object.

This is custom documentation. For more information, please visit the SAP Help Portal 18
 6/6/2023

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPChangedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

If an administrative clerk changes a patient's details, the system informs all connected systems that the patient has been
changed.

Related Operations

The Inform of Patient Creation , Inform of Patient Merge , and Inform of Patient Identi cation Change operations are
used to communicate information to connected systems.

Features
This asynchronous outbound operation informs connected systems of a changed instance of the Patient business object,
including the new values of the changed attributes.

Some examples of the information sent are:

The identi er of the patient (PatientID element)

The patient’s date of birth (BirthDate element)

The address of the patient (AddressInformation element)

Any comment about the patient (PatientNote element)

The status (active, inactive, cancelled) of the Patient business object (PatientLifeCycleStatusCode element)

This operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if SAP
Patient Management plays the role of Patient Demographics Supplier in the context of IHE. The operation is then used in the
following scenario:

The master data for patients is entered in the SAP Patient Management system. Connected systems can use this
operation to retrieve data from SAP Patient Management, and store it in their own databases.

This is custom documentation. For more information, please visit the SAP Help Portal 19
 6/6/2023

Message Types
Patient ERP Changed Information

Inform of Patient Creation

De nition
To inform of a created instance of the Patient business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPCreatedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

When a new patient ( Patient business object) is created in the SAP Patient Management system, this operation informs all
connected systems that a new patient has been created. When this information is received, other systems can mirror the
creation to ensure consistency.

Related Operations

The Create Patient based on Patient Created Noti cation operation is used to create an instance of the Patient business
object when noti ed that the patient has been created in an external system.

The Inform of Patient Change , Inform of Patient Merge , and Inform of Patient Identi cation Change operations are
used to communicate information to external systems.

Features
This asynchronous outbound operation sends information about the created instance of the Patient business object. Some
examples of the information sent are:

The identi er of the patient (PatientID element)

This is custom documentation. For more information, please visit the SAP Help Portal 20
 6/6/2023
Any comments stored for the patient (PatientNote element)

Whether the patient is active, inactive, or cancelled (PatientLifeCycleStatusCode element)

The patient’s date of birth (PatientCommonBirthDate element)

The patient’s address and contact details (PatientAddressInformation element)

This operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if SAP
Patient Management plays the role of Patient Demographics Supplier in the sense of IHE. The operation is then used in the
following scenario:

The master data for patients is stored in the SAP Patient Management system. SAP Patient Management can use this
operation to send data to connected systems so that it can be stored in their own databases.

Message Types
Patient ERP Created Information

Inform of Patient Deactivation

De nition
To inform third-party systems about a patient deactivation.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 605

Release State released

Technical Name PatientERPDeactivatedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

For legal reasons, the record of a patient cannot be deleted. Instead, it can be deactivated so that it is not considered when a
user, for example, searches for patients. A patient may also be deactivated when two patients are merged.

This is custom documentation. For more information, please visit the SAP Help Portal 21
 6/6/2023
For example, an admissions clerk creates a new patient in the system. Later, he realises that the patient already exists, and as
no patient encounters have been created for the new patient, he deactivates it. The Inform of Patient Deactivation operation
sends information to third-party systems about the deactivated instance of the Patient business object.

Related Operations

The Inform of Patient Creation operaton is used to inform third-party systems about a new patient.

The Inform of Patient Change operation is used to inform third-party systems about a changed patient.

The Inform of Patient Identi cation Change operation is used to inform third-party systems about the changed ID of a
patient.

The Inform of Patient Merge operation is used to inform third-party systems about two patients that have been merged.

Features
This asynchronous outbound operation informs third-party systems of a deactivated patient ( Patient business object) from the
Healthcare Business Partner Data Management process component.

This operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if SAP
Patient Management plays the role of Patient Demographics Supplier in the context of IHE. The operation is then used in the
following scenario:

The master data for patients is entered in the SAP Patient Management system. This operation sends the data from
SAP Patient Management to third-party systems, allowing them to mirror the data if desired.

Message Types
Patient ERP Deactivated Information

Notes on SAP Implementation

This operation is triggered by the cancelling of a patient in the backend (event NP020S). When this event occurs, the
information is queued for dispatch as part of a regularly scheduled run.In cases where two noti cations about the same patient
are queued, consolidation logic combines the two and sends them as a single information message as follows:

If a patient is created, and then deactivated, no information is sent.

If a patient is updated, and then deactivated, only the deactivation information is sent.

If the status of a patient is changed, and the patient is then deactivated, only the deactivation information is sent.

More Information
For information about the MDT of this operation, see SAP Note 1461662 .

Inform of Patient Identi cation Change

De nition
To inform all connected systems that one or more identi ers of a patient have been changed.

This is custom documentation. For more information, please visit the SAP Help Portal 22
 6/6/2023

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPIdenti cationChangedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

To maintain consistency, the Inform of Patient Identi cation Change operation sends information to all connected systems
that the external identi er of a patient has been changed.

Related Operations

The Merge Patient synchronous inbound operation can be used to change the external identi ers of a patient.

The Inform of Patient Creation , Inform of Patient Merge , and Inform of Patient Change operations are used to
communicate information to connected systems.

Features
This asynchronous outbound operation sends information to connected systems whenever any of the following elements are
changed:

A patient’s external identi ers, such as the external ID given by the connected system, the social insurance number, or
passport number (PartyIdenti erTypeCode element)

Information on whether the identi er has been created, changed, or deleted (contained in the actionCode attribute)

This service operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if
SAP Patient Management plays the role of Patient Demographics Supplier in the sense of IHE. The operation is then used in the
following scenario:

The identi ers for patient are changed in the SAP Patient Management system.SAP Patient Management can use this
operation to send data on changed patient identi ers to connected systems. The connected systems can then store it in
their own databases.

Message Types

This is custom documentation. For more information, please visit the SAP Help Portal 23
 6/6/2023
Patient ERP Identi cation Changed Information

Prerequisites
An active patient ( Patient business object) must exist in the system.

Constraints
The SAP Patient Management internal identi er cannot be changed.

Inform of Patient Merge

De nition
To inform all connected systems that two instances of the Patient business object have been merged.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPMergedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

To maintain consistency of records, the Inform of Patient Merge outbound operation sends information to all connected
systems that two instances of the Patient business object have been merged.

Related Operations

The Merge Patient synchronous inbound operation is used to merge two instances of the Patient business object.

The Merge Patient asynchronous inbound operation is used to merge two instances of the Patient business object.

The Inform of Patient Creation , Inform of Patient Change , and Inform of Patient Identi cation Change service
operations are used to communicate information to connected systems.

This is custom documentation. For more information, please visit the SAP Help Portal 24
 6/6/2023

Features
This asynchronous outbound operation sends information about a changed instance of the Patient business object.

This service operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if
SAP Patient Management plays the role of Patient Demographics Supplier in the sense of IHE. The operation is then used in the
following scenario:

The master data of two patients is merged in the SAP Patient Management system. SAP Patient Management can use
this operation to send information on merged patient data to connected systems. The connected systems can
then store the information in their own databases, to ensure data consistency.

The information sent is:

The contact information of the major patient (PersonName node)

The internal and external identi ers of the major patient (PatientID and PartyIdenti erTypeCode elements)

The internal and external identi ers of the minor patient (PatientID and PartyIdenti erTypeCode elements)

Message Types
Patient ERP Merged Information

Prerequisites
Two instances of the Patient business object must be merged ( Merge Patient service operation).

Notes on SAP Implementation

To have the system send out the PatientMergeInformation message for a speci c institution, activate the Con guration
Set for asynchronous outbound processing in Customizing for SAP Healthcare - Industry-Speci c Components for
Hospitals under Communication -> Preparation for Service Enabling -> Asynchronous Outbound Processing -> Maintain
HCF Con guration Sets.

To log events and enable data exchange with external communication partners, activate the Electronic Data Interchange
procedure in Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication ->
Electronic Data Interchange -> Activate EDI Procedure.

Patient In

De nition
An interface to manage patient in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction inbound

This is custom documentation. For more information, please visit the SAP Help Portal 25
 6/6/2023

Business Context and Use

The Patient In inbound service interface groups operations that request to, and receive con rmation from, the Healthcare
Business Partner Data Management process component to manage instances of the Patient business object, to ensure data
consistency between systems.

Change Patient based on Patient Changed Noti cation

De nition
To change an instance of the Patient business object when noti ed that it has been changed in a connected system.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPChangedNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior Type3

P2P Communication Enabled no

Business Context and Use

If necessary, the details of a patient can be changed. When a patient’s details are changed in an external system, a noti cation
is sent to any connected systems ( Inform of Patient Change operation). This allows the same change to be performed in all
connected systems, to ensure the consistency of records ( Change Patient based on Patient Changed Noti cation operation).

Related Operations

The Create Patient based on Patient Created Noti cation , Merge Patient based on Patient Merged Noti cation and
Deactivate Patient based on Patient Deactivated Noti cation operations are also used to ensure consistency of patient
details across connected systems.

The Inform of Patient Change operation is used to notify connected systems that an instance of the Patient business
object has been changed.

The Maintain Patient operation is used to change instances of the Patient business object.

Features
This is custom documentation. For more information, please visit the SAP Help Portal 26
 6/6/2023
This asynchronous inbound operation changes an instance of the Patient business object to re ect the changes made in an
external system, without returning a con rmation. Alternatively, if an acknowledgement of the change is required, the Maintain
Patient asynchronous operation can be used. In this case, a response is returned through the Con rm Patient Maintenance
operation.

The input for this operation is taken from the noti cation, which contains information on the changed patient details. This
information is:

The identi er of the patient (PatientID element)

The new values for any elements which are to be changed

A successful execution results in a changed instance of the Patient business object. No con rmation is returned to the sender.

Error Handling
Forward Error Handling

The Change Patient based on Patient Changed Noti cation operation supports Forward Error Handling .

The following errors might occur:

Error type: Lock request error; automatic or manual restart possible

Cannot lock patient & &

Patient & & is locked by & (re-try later)

Patient & & does not exist in institution &

Enter a valid institution

Error type: Con ict; restart not possible

Patient & & is canceled

Message Types
Patient ERP Changed Noti cation

Constraints
General Constraints

This operation does not return a con rmation message.

This operation does not create a new instance of the Patient business object if the patient identi er provided does not
exist in the system.

Element Constraints

In the PersonName element, the following components are supported: FormOfAddressCode, GivenName, FamilyName,
BirthName, NickName, AcademicTitleCode, NamePre xCode, and NameSupplementCode.

In the GenderCode element, ʻUnknown’, ʻMale’ and ʻFemale’ are the only supported values.

This is custom documentation. For more information, please visit the SAP Help Portal 27
 6/6/2023
In the DeathDateTimePerion, the DeathStartDate must be greater than or equal to the BirthDate. The
DeathEndDateTime must be greater than the DeathStartDateTime.

In the AddressUsageDefalt indicator element, only one address must be marked as the default address.

In the PhysicalAddress element, the following components are supported: CountryCode, CountryName, RegionCode,
RegionName, CityName, DistrictName, StreetPostalCode, StreetName, BuildingID, FloorID, RoomID, and POBoxID.

In the PhoneNumber element, only the component SubscriberID is supported.

In the RelationshipRoleCode element, only the codes 'Is the employee of', 'Has family physician', 'Has health care payer'
are supported.

In the RelationshipValidityPeriod, the relationships 'Has Family Physician' and 'Is employee of' must have the maximum
validity. Only the 'Has HealthCare Payer' relationship can have a validity period other than the maximum validity.

The HealthcarePayer node is only lled for the relationship 'Has health care payer'.

In the HealthCarePayerCategoryCode element, 'Third Party Individual' and 'Third Party Non-Individual' are the only
supported values.

In the HealthcarePayerPriorityValue, the value can be from ʻ1’ to ʻ99’.

In the InsuredPartyAddressNode, the following components are supported: Given Name, Last Name, Form Of Address
Code, Academic Title code, Name Pre x Code, Name Supplement Code, Street Name, Country Code, Street Postal Code,
City Name, one Email URI, and multiple Telephone Numbers.

In the AlternativeIdenti cationPartyIdenti erTypeCode, only the 'SocialInsuranceNumber' code is supported.

In the EmployerPartyAddress node, the following components are supported: Organisation Formatted Name, Street
Name, Country Code, Street Postal Code, City Name, one Telephone Number, and one Email URI.

In the DependentRelationshipValidityPeriod, all relationships must have the maximum validity period.

In the Occupation node, the Employer Name and Employer Address must not be lled unless the patient has no Business
Partner relationship with the employer.

Using services to create relationship between patient and next of kin data is only possible, if you use the SAP Business
Partner and the next of kin already exist as business partner in SAP Patient Management. This also applies to
relationships between patient and third-party payer data.

More Information
For more information on the change/update behavior of this operation, see Change / Update Behavior Type 1 .

If no value is speci ed for the actionCode attributes, the following actions are taken:

If a value already exists for the element, the value is changed.

If a value does not exist for the element, the value is created.

Create Patient based on Patient Created Noti cation

De nition
To create a Patient business object when noti ed that it has been created in a connected system.

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 28
 6/6/2023

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPCreatedNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

When a new patient enters the hospital, the patient's details must be entered into the system. When a patient is created in an
external system, a noti cation is sent to the SAP Patient Management system ( Inform of Patient Creation operation). This
allows the same patient to be created, to ensure the consistency of records ( Create Patient based on Patient Created
Noti cation operation).

Related Operations

The Change Patient based on Patient Changed Noti cation , Merge Patient based on Patient Merged Noti cation and
Deactivate Patient based on Patient Deactivated Noti cation operations are also used to ensure consistency of patient data
across connected systems.

The Create Patient operation is used to create an instance of the Patient business object.

The Inform of Patient Creation operation sends information to connected systems that an instance of the Patient
business object has been created.

Features
This asynchronous inbound operation creates an instance of the Patient business object to re ect the creation of a patient in
an external system, without returning a con rmation. Alternatively, if an acknowledgement of the change is required, the
Maintain Patient asynchronous operation can be used. In this case, a response is returned through the Con rm Patient
Maintenance operation.

The input for this operation is taken from the noti cation ( Inform of Patient Creation operation), which contains information on
the created patient. The following information is required:

One identi er of the patient, such as the internal ID, social security number, or passport number (PatientID element)

Other information can also be provided, such as:

The identi er of the hospital (HospitalPartyID element)

The address information of the patient (AddressInformation node)

This is custom documentation. For more information, please visit the SAP Help Portal 29
 6/6/2023
The medical risk factor of the patient (MedicalRiskFactorCode element)

A successful execution results in a new instance of the Patient business object. No con rmation is returned to the sender.

Error Handling
Forward Error Handling

The Create Patient based on Patient Created Noti cation operation supports Forward Error Handling .

The following errors might occur:

Error type: Lock request error; automatic or manual restart possible

Cannot lock patient & &

Enter a valid institution

Message Types
Patient ERP Created Noti cation

Constraints
In the PersonName element, the following components are supported: FormOfAddressCode, GivenName, FamilyName,
BirthName, NickName, AcademicTitleCode, NamePre xCode, and NameSupplementCode.

In the GenderCode element, ʻUnknown’, ʻMale’ and ʻFemale’ are the only supported values.

In the DeathDateTimePerion, the DeathStartDate must be greater than or equal to the BirthDate. The
DeathEndDateTime must be greater than the DeathStartDateTime.

In the AddressUsageDefalt indicator element, only one address must be marked as the default address.

In the PhysicalAddress element, the following components are supported: CountryCode, CountryName, RegionCode,
RegionName, CityName, DistrictName, StreetPostalCode, StreetName, BuildingID, FloorID, RoomID, and POBoxID.

In the PhoneNumber element, only the component SubscriberID is supported.

In the RelationshipRoleCode element, only the codes 'Is Employee Of', 'Has Family Physician', 'Has Health Care Payer'
are supported.

In the RelationshipValidityPeriod, the relationships 'Has Family Physician' and 'Is employee of' must have the maximum
validity. Only the 'Has Health Care Payer' relationship can have a validity period other than the maximum validity.

The HealthCarePayer node is only lled for the relationship 'Has Health Care Payer'.

In the HealthCarePayerCategoryCode element, only the value 'Third-Party Non-Individual' is supported.

In the HealthCarePayerPriorityValue, the value can be from ʻ1’ to ʻ99’.

In the InsuredPartyAddressNode, the following components are supported: Given Name, Last Name, Form Of Address
Code, Academic Title code, Name Pre x Code, Name Supplement Code, Street Name, Country Code, Street Postal Code,
City Name, one Email URI, and multiple Telephone Numbers.

In the AlternativeIdenti cationPartyIdenti erTypeCode, only the 'SocialInsuranceNumber' code is supported.

In the EmployerPartyAddress node, the following components are supported: Organisation Formatted Name, Street
Name, Country Code, Street Postal Code, City Name, one Telephone Number, and one Email URI.

This is custom documentation. For more information, please visit the SAP Help Portal 30
 6/6/2023
In the DependentRelationshipValidityPeriod, all relationships must have the maximum validity period.

In the Occupation node, the Employer Name and Employer Address must not be lled unless the patient has no Business
Partner relationship with the employer.

Using services to create relationships between patient and next of kin data is only possible, if you use the SAP Business
Partner, and the next of kin already exist as business partner in SAP Patient Management. This also applies to
relationships between patient and third-party payer data.

Deactivate Patient based on Patient Deactivated Noti cation

De nition
To deactivate an instance of the Patient business object when noti ed that it has been deactivated in a connected system.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPDeactivatedNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

If a patient's details are no longer needed, the patient can be deactivated. When a patient is deactivated in a system, a
noti cation is sent to any connected systems. This allows the patient to be deactivated in all connected systems, to ensure the
consistency of records ( Deactivate Patient based on Patient Deactivated Noti cation operation).

Related Operations

The Create Patient based on Patient Created Noti cation , Merge Patient based on Patient Merged Noti cation and
Change Patient based on Patient Changed Noti cation operations are also used to ensure consistency of patient details
across connected systems.

The Deactivate Patient operation is used to deactivate an instance of the Patient business object.

Features

This is custom documentation. For more information, please visit the SAP Help Portal 31
 6/6/2023
This asynchronous inbound operation deactivates an instance of the Patient business object to re ect the deactivation of the
patient in an external system, without returning a con rmation.

The input for this operation is taken from the noti cation, which contains information on the deactivated patient. This
information is:

The identi er of the patient (PatientID element)

The status of the patient record (LifeCycleStatusCode element)Set the status to value ʻ4’ to deactivate the patient.

A successful execution results in a deactivated instance of the Patient business object (patient with LifeCycleStatusCode value
'4'). No con rmation is returned to the sender.

Error Handling
Forward Error Handling

The Deactivate Patient based on Patient Deactivated Noti cation operation supports Forward Error Handling for all business
errors where a manual restart is possible.

The following error might occur:

Error type: Lock request error; automatic or manual restart possible

Patient &1 is already being processed by user &3 &4.

Message Types
Patient ERP Deactivated Noti cation

Prerequisites
Cancel all dependent relationships before deactivating the patient.

Maintain Patient

De nition
To maintain an instance of the Patient business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPRequest_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

This is custom documentation. For more information, please visit the SAP Help Portal 32
 6/6/2023
Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

An administrative clerk, working in an external system, changes a patient’s details. To ensure data consistency, the Maintain
Patient operation is called in the external system to re ect the changes for the speci ed patient ( Patient business object) in
the internal system.The Con rm Patient Maintenance operation sends a con rmation that the patient was successfully
maintained.

Related Operations

The Con rm Patient Maintenance operation is a con rmation of a patient maintenance.

The Create Patient , Update Patient , and Deactivate Patient operations are used to manage instances of the Patient
business object.

Features
This asynchronous inbound operation changes a speci ed instance of the Patient business object if it exists, and creates one if it
does not. Any existing information is overwritten, whether it is up-to-date or not. This contrasts with the performance of the
Update Patient service operation.As this is an asynchronous operation, con rmation of a successful maintenance is returned by
the Con rm Patient Maintenance operation.This operation returns a response to an execution of the Maintain Patient
operation to con rm that an instance of the Patient business object has been maintained.

This service operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if
SAP Patient Management plays the role of Patient Demographics Consumer in the sense of IHE. The operation is then used in
the following scenario:

The master data for patients is entered in a system connected to the SAP Patient Management system (for example,
the admission system). The external system can use this operation to send data to the SAP Patient Management
system, and store it in the SAP Patient Management databases.

To maintain a patient, the following information is required:

The identi er of the patient (PatientID or PatientIdenti cation elements)

New values for any elements that are to be changed

A succesful execution of this operation results in a changed or created instance of the Patient business object.

Example Input

This is an example set of input data for this operation. The internal identi er of the patient is entered to identify the patient,
and the name and birth date of the patient are changed. Additionally, the reason for the maintenance is entered.

<Patient addressInformationListCompleteTransmissionIndicator="false"
relationshipListCompleteTransmissionIndicator="false" dependentRelationshipListCompleteTransmissionIndicator="false"

This is custom documentation. For more information, please visit the SAP Help Portal 33
 6/6/2023
identi cationListCompleteTransmissionIndicator="false" medicalRiskFactorListCompleteTransmissionIndicator="false"
medicalInstitutionAssignmentListCompleteTransmissionIndicator="false">

<ID> 2010744 </ID>

<DataFollowupReasonCode> 1 </DataFollowupReasonCode>

<Common>

<PersonName>

<FormOfAddressCode listAgencySchemeID="" listAgencySchemeAgencyID=" "> 01 </FormOfAddressCode>

<GivenName> John </GivenName>

<FamilyName> Wilson </FamilyName>

</PersonName>

<BirthDate>

<DayOfMonth> ---15 </DayOfMonth>

<Month> --05 </Month>

<Year> 1983 </Year>

</BirthDate>

</Common>

</Patient>

Error Handling
Forward Error Handling

The Maintain Patient operation supports Forward Error Handling .

The following errors may occur:

Error type: Lock request error; automatic or manual restart possible

Patient &1 is locked

Error type: Authorization error; manual restart possible

No authorization for maintenance

Message Types
Patient ERP Request

Prerequisites

This is custom documentation. For more information, please visit the SAP Help Portal 34
 6/6/2023
If maintaining an existing patient, the patient must be active.

Using services to create relationships between patient and next of kin data is only possible, if you use the SAP Business Partner,
and the next of kin already exist as business partner in SAP Patient Management. This also applies to relationships between
patient and third-party payer data.

More Information
For more information on the Change/Update behavior of this operation, see Change / Update Behavior Type 3 .

If no value is speci ed for the actionCode attributes, the following actions are taken:

If a value already exists for the element, the value is changed.

If a value does not exist for the element, the value is created.

Merge Patient

De nition
To merge two instances of the Patient business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPMergeRequest_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

Two instances of the Patient business object exist in the system that refer to the same person. The Merge Patient
asynchronous inbound operation, and result in one instance of the Patient business object with newly added dependent objects.

The Merge Patient asynchronous inbound operation merges the two patient records (Patient business objects) into one Patient
business object. One of the Patient business objects is speci ed as the ʻmajor’ patient, and remains active after the merge. The
other ʻminorʻ patient is cancelled, and its dependent objects are transferred to the major patient.

This is custom documentation. For more information, please visit the SAP Help Portal 35
 6/6/2023
This operation can be called following a patient merge in a connected system, in order to re ect the change in the current
system. Either this operation, or the Merge Patient based on Patient Merged Noti cation operation can be used.

Related Operations

The Con rm Patient Merge operation is the asynchronous response to this operation.

The Merge Patient based on Patient Merged Noti cation is used to merge two instances of the Patient business
object when noti ed that those records have been merged in a connected system.

The Merge Patient operation is used to synchronously merge two instances of the Patient business object.

Features
This asynchronous inbound operation merges two instances of the Patient business object. One of the patients is speci ed as
the 'major' patient, and the other as the 'minor' patient. The major patient remains active following the merge, and the minor
patient is cancelled. This operation can be performed exactly once for a given set of input data. For information on Exactly Once
(Idempotent) behavior, see Idempotent Service .

This service operation meets IHE (Integrating the Healthcare Enterprise) Patient Administration requirements. It can be used if
SAP Patient Management plays the role of Patient Demographics Consumer in the sense of IHE. The operation is then used in
the following scenario:

The master data for patients is entered in a system connected to the SAP Patient Management system (for example,
the admission system).SAP Patient Management can use this operation to send information on merged patient data to
the connected system. The connected system can then store this information to ensure data consistency.

To merge two patients, supply any (or all) of the following information:

The identi er of the major patient (PatientID and PatientAlternativeID elements)

The identi er of the minor patient (PatientID and PatientAlternativeID elements)

Alternatively, if the external identi er(s) supplied for the major patient are not currently stored, but those supplied for the
minor patient are, this operation changes the currently-existing external identi ers of the minor patient to those supplied for
the major patient. The internal identi er of the minor patient is not changed.

For example: No driving license number is stored for the major patient, but the driving license number ʻ1234567’ is stored for the
minor patient. This operation is executed with the value ʻ2222222’ supplied as the driving license number of the major patient,
and ʻ1234567’ supplied for the minor patient. The result is that the driving license number of the minor patient is replaced with
ʻ2222222’.

A successful execution of this operation takes the form of either an active Patient business object with additional dependent
objects, or a change in the external identi ers of the minor patient.

A successful execution of this operation takes the form of either an active Patient business object with additional dependent
objects, or a change in the external identi ers of the minor patient. No con rmation is returned by this operation.

Example Input

This is an example set of input for this operation.

<MajorPatient>

<ID schemeID="ISH_PATIENT_INTERNAL_ID" schemeAgencyID=""> 0123456789 </ID>

This is custom documentation. For more information, please visit the SAP Help Portal 36
 6/6/2023
</MajorPatient>

<MinorPatient>

<ID> 9876543210 </ID>

</MinorPatient>

Error Handling
Forward Error Handling

The Merge Patient operation supports Forward Error Handling .

The following errors may occcur:

Error type: Lock request error; automatic or manual restart possible

Patient &1 is locked

Error type: Authorization error; manual restart possible

No authorization for merge

Message Types
PatientERPMergeRequest

Prerequisites
Two active instances of the Patient business object must exist for the same patient.

No restrictions prohibit the transfer of all dependent objects from the minor patient to the major patient. These
restrictions relate to Financial Accounting and assigned records.

The patient has a customer in Financial Accounting with open or cleared items, copayments in collection, or
receivable procedures.

The patient has assigned medical records, renewable documents or electronic cards.

At least one valid identi er for each instance of the Patient business object is supplied.

Constraints
A check on cleared items in Financial Accounting is performed in the SAP Patient Management system and cannot be disabled.

Merge Patient based on Patient Merged Noti cation

De nition
To merge two instances of the Patient business object when noti ed that they have been merged in a connected system.

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 37
 6/6/2023

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPMergedNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

If two instances of the Patient business object are found to refer to the same patient, these can be merged. When instances of
the Patient business object are merged in a system, a noti cation is sent to the SAP Patient Managment system ( Inform of
Patient Merge operation). This allows the same merge to be performed, to ensure the consistency of data ( Merge Patient
based on Patient Merged Noti cation operation).

Related Operations

The Create Patient based on Patient Created Noti cation , Change Patient based on Patient Changed Noti cation and
Deactivate Patient based on Patient Deactivated Noti cation operations are also used to ensure consistency of patient details
across connected systems.

The Merge Patient synchronous inbound operation is used to merge two instances of the Patient business object.

The Merge Patient asynchronous inbound operation is used to merge two instances of the Patient business object.

Features
This asynchronous inbound operation merges two instances of the Patient business object to re ect the changes made in an
external system, without returning a con rmation. One patient is speci ed as the ʻmajor patient’, and the other as the ʻminor
patient’. After the merge, the major patient remains active, while the minor patient is cancelled. All dependent objects (such as
insurance relationships) of the minor patient are transferred to the major patient. Alternatively, if a response is required, the
Merge Patient synchronous inbound operation or the asynchronous request con rmation used can be used.

This operation can be performed exactly once for a given set of input data. For information on Exactly Once (Idempotent)
behavior, see Idempotent Service .

The input for this operation is taken from the noti cation, which contains information on the merged patient records. This
information is:

The identi er of the major patient (PatientID and PartyIdenti erTypeCode elements)

The identi er of the minor patient (PatientID and PartyIdenti erTypeCode elements)

This is custom documentation. For more information, please visit the SAP Help Portal 38
 6/6/2023
A successful execution of this operation results in one active instance of the Patient business object with additional dependent
objects. No con rmation is returned to the sender.

Example Input

This is an example set of input for this operation.

<MajorPatient>

<ID schemeID="ISH_PATIENT_INTERNAL_ID" schemeAgencyID=""> 0123456789 </ID>

</MajorPatient>

<MinorPatient>

<ID> 9876543210 </ID>

</MinorPatient>

Error Handling
Forward Error Handling

The Merge Patient based on Patient Merged Noti cation operation supports Forward Error Handling .

The following errors may occur:

Error type: Lock request error; automatic or manual restart possible

Patient &1 is locked

Error type: Authorization error; manual restart possible

No authorization for merge

Message Types
Patient ERP Merged Noti cation

Prerequisites
Two active instances of the Patient business object exist that refer to the same person.

No restrictions prohibit the transfer of all dependent objects from the minor patient to the major patient. These
restrictions relate to Financial Accounting and assigned records.

The patient has a customer in Financial Accounting with open or cleared items, copayments in collection, or
receivable procedures.

The patient has assigned medical records, renewable documents or electronic cards.

At least one valid identi er for each patient is supplied.

Constraints

This is custom documentation. For more information, please visit the SAP Help Portal 39
 6/6/2023
A check on cleared items in Financial Accounting is performed in the SAP Patient Management system and cannot be
disabled.

Test execution is not possible.

Notes on SAP Implementation

Business Function ISH_MISC1 must be activated.

The function of this operation is identical to the report Merge Patients in Dialog Mode (RNJOIN00) in SAP Patient
Management.

Patient Out

De nition
An interface to con rm patient changes in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction outbound

Business Context and Use

The Patient Out outbound service interface groups operations that send con rmation to connected systems that instances
of the Patient business object have been maintained or merged.

Con rm Patient Maintenance

De nition
To con rm the maintenance of a patient, in response to the Maintain Patient operation.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPCon rmation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

This is custom documentation. For more information, please visit the SAP Help Portal 40
 6/6/2023
Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

A administrative clerk, working in an external system, changes a patient’s details. The Maintain Patient operation is called to
re ect the changes for the speci ed patient ( Patient business object) in the SAP Patient Management system, to ensure data
consistency. This operation sends a con rmation to the external system that the patient was successfully maintained. Related
Operations

The Maintain Patient service operation is used to maintain the details of a patient.

The Con rm Patient Merge service operation is used to con rm the merging of two instances of the Patient business
object.

Features
This asynchronous outbound operation returns a response to an execution of the Maintain Patient operation to con rm that an
instance of the Patient business object has been maintained. If the patient was not successfully maintained, this operation is
not called.

Message Types
Patient ERP Con rmation

Prerequisites
The Maintain Patient asynchronous inbound operation is called.

More Information
For more inforamtion, see the Maintain Patient operation.

Con rm Patient Merge

De nition
To con rm the merging of two patients, in response to the Merge Patient asynchronous inbound operation.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

This is custom documentation. For more information, please visit the SAP Help Portal 41
 6/6/2023
Technical Name PatientERPMergeCon rmation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

An administrative clerk, working in an external system, merges two patients’ details. To maintain consistency of data, the Merge
Patient asynchronous inbound operation is called to re ect the merge in the internal system. The Con rm Patient Merge
asynchronous outbound operation sends a con rmation to the external system that the patients were successfully merged.

Related Operations

The Merge Patient asynchronous operation is used to merge two patients without returning a con rmation immediately.

The Merge Patient synchronous operation is used to merge two patients and return a con rmation immediately.

The Con rm Patient Maintenance is used to con rm that a patient has been maintained.

Features
This asynchronous outbound operation sends a response to an execution of the Merge Patient asynchronous operation to
con rm that two instances of the Patient business object have been merged. If the Merge Patient operation was unsuccessful,
this operation is not called.

Message Types
Patient ERP Merge Con rmation

More Information
For more information, see the Merge Patient asynchronous inbound operation.

Query Patient In

De nition
An interface for querying patient in Healthcare Business Partner Data Management

Technical Data

This is custom documentation. For more information, please visit the SAP Help Portal 42
 6/6/2023
Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Query Patient In inbound service interface groups operations that query to, and receive response from, the Healthcare
Business Partner Data Management process component for instances of the Patient business object.

Find Patient by Basic Data

De nition
To nd a patient by searching by basic data.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPBasicDataByBasicDataQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientERPBDQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

To avoid duplicate records, it can be useful to check if a patient already exists in the system before creating a new instance of
the Patient business object. This synchronous inbound operation returns a list of patients whose details match the search
criteria.

Related Operations

The Find Patient by Basic Data synchronous outbound operation is used to search for patients by basic data in an
external system.

This is custom documentation. For more information, please visit the SAP Help Portal 43
 6/6/2023
The Find Patient by Identifying Elements synchronous inbound operation is also used to check whether a patient exists
in the system.

The Create Patient operation is used to create a new instance of the Patient business object.

Features
This synchronous inbound operation returns a list of patients matching the provided search criteria. The search criteria consist
of basic data such as name, date of birth, and address. The list returned also includes the major attributes required to identify
the patients. The operation returns active, inactive and cancelled patients, which can be distinguished using the
LifeCycleStatusCode element.

This service operation can be used to meet IHE (Integrating the Healthcare Enterprise) Patient Demographics Query
requirements. To do so, further restrictions must be taken into account. See "Con guring Enterprise Services for SAP Patient
Managment" on the Enterprise Services wiki (). From here, select the ES Bundle Patient Administration , and then select the
child page Service Con guration.

This operation is IHE-compliant if SAP Patient Management plays the role of Patient Demographics Supplier. It is then used in
the following scenario:

The master data for patients is stored in the SAP Patient Management system.Users of a connected system can use
this operation to retrieve data from SAP Patient Management.

To search for a patient record, at least one of the following attributes must be provided:

The name of the patient (PatientName element)

The gender of the patient (PatientGenderCode element)

The identi er of the hospital (PatientHospitalPartyID element)This element is mandatory when patients are stored as
institution-speci c.

A range of birth dates for the patient (SelectionByPatientBirthDate element)

The identi ers of the patient (PatientIdenti cation and PatientID elements)

The address of the patient (PatientAddress element)

You must also provide values for the processing conditions. You can either specify that all results be returned at once, or limit
the amount of results to a certain number. If you limit the amount of results, you can call the operation again, starting from a
certain ID (for example, the ID of the last patient returned in a previous search).

Display all results (Query Hits Maximum Indicator)

Display a certain number of results (Query Hits Maximum Number Value)

The ID of the last result returned in a previous search (Last Returned Object ID)

Example Input

This is an example set of input data for this operation. It will search for all patients with the last name Wilson. The processing
conditions specify that a maximum of 200 results are to be returned, and all results are to be displayed.

<PatientBasicDataSelectionByBasicData>

<PatientName>

<FamilyName> Wilson </FamilyName>

This is custom documentation. For more information, please visit the SAP Help Portal 44
 6/6/2023
</PatientName>

</PatientBasicDataSelectionByBasicData>

<ProcessingConditions>

<QueryHitsMaximumNumberValue> 200 </QueryHitsMaximumNumberValue>

<QueryHitsUnlimitedIndicator> true </QueryHitsUnlimitedIndicator>

</ProcessingConditions>

Message Types
PatientERPBasicDataByBasicDataQuery_sync

PatientERPBasicDataByBasicDataResponse_sync

Constraints
The PatientGenderCode element cannot be used as the sole search criteria.

In the PatientName element, only the components GivenName, FamilyName and BirthName are supported.

In the PatientGenderCode element, only the values '0' (Unknown), '1' (Male) and '2' (Female) are supported.

In the InclusionExclusionCode element, only the value 'I' (Inclusion) is supported.

In the IntervalBoundaryTypeCode element, only the values '1' (single value), '3' (interval closed lower and upper) and '7'
(interval with unlimited lower and closed upper boundary) are supported.

Find Patient by Identifying Elements

De nition
To nd an instance of the Patient business object and inform an external system that the patient is known.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPSimpleByIdentifyingElementsQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientSmplByIdnElmtQR

Category A2X

Direction inbound

This is custom documentation. For more information, please visit the SAP Help Portal 45
 6/6/2023
Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

This operation is used to nd a patient by using identi cation elements, such as Social Insurance Number or passport number,
as the search criteria. To ensure data security, only the internal identi er of the patient is returned.

Related Operations

The Find Patient by Basic Data inbound operation is used to search for a patient by basic data.

The Find Patient by Basic Data outbound operation is used to search for a patient by basic data in an external system.

Features
This synchronous inbound operation searches for an instance of the Patient business object and returns a message that either
con rms that the patient exists (and lists the status) or informs that the patient does not exist.

To nd a patient by identifying elements, the following information is required:

The internal identi er of the patient (PatientID element)

The external identi er of the patient, such as passport number or Social Insurance Number (PartyIdenti erTypeCode
element)

If patients are created as hospital-speci c, the following information is also required:

The identi er of the hospital (HospitalPartyID element)

If a patient that matches the search criteria is found, the internal identi er is returned, along with the status of the
patient (active, inactive, or cancelled). If not, a message is returned informing the user that no patient record was found. If
two patients that match the search criteria are found, a message is sent that informs the user that the selection criteria were
not unique.

Example Input

This is an example set of input data for this operation.

<PatientSimpleSelectionByIdentifyingElements>

<PatientHospitalPartyID> 0001 </PatientHospitalPartyID>

<PatientIdenti cation>

<Identi erTypeCode listID="Str 180" listVersionID="Str 181" listAgencyID="Str 182" listAgencySchemeID="Str 183"
listAgencySchemeAgencyID="Str"> IBS001 </Identi erTypeCode>

<PatientID schemeID="Str 186" schemeAgencyID="Str 187" schemeAgencySchemeID="Str 188"

schemeAgencySchemeAgencyID="Str"> SINUM1 </PatientID>

This is custom documentation. For more information, please visit the SAP Help Portal 46
 6/6/2023
</PatientIdenti cation>

</PatientSimpleSelectionByIdentifyingElements>

Message Types
PatientERPSimpleByIdentifyingElementsQuery_sync

PatientERPSimpleByIdentifyingElementsResponse_sync

Query Patient Out

De nition
An interface to manage querying of patient in Healthcare Business Partner Data Management

Technical Data

Entity Type Service Interface

Category A2X

Direction outbound

Business Context and Use

The Query Patient Out outbound service interface contains an operation that queries to, and receives a response from, an
external system for a patient.

Find Patient by Basic Data

De nition
To nd a patient by searching by basic data.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientERPBasicDataByBasicDataQueryResponse_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) n/a

Category SAP A2A

This is custom documentation. For more information, please visit the SAP Help Portal 47
 6/6/2023
Direction outbound

Mode synchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

To avoid duplicate records, it can be useful to check if a patient already exists in an external system before creating a new
instance of the Patient business object. This synchronous outbound operation returns a list of patients whose details match the
search criteria.

Related Operations

The Find Patient by Basic Data synchronous inbound operation is also used to search for patients.

The Find Patient by Identifying Elements operation is also used to search for patients.

The Create Patient operation is used to create a new instance of the Patient business object.

Features
This synchronous outbound operation returns a list of patients matching the provided search criteria. The search criteria
consist of basic data such as name, date of birth, and address. It returns a list of patients and the major attributes required to
identify them. It returns active, inactive and cancelled patients, which can be distinguished using the LifeCycleStatusCode.

This operation is designed to meet IHE (Integrating the Healthcare Enterprise) compliance standards. It is a query from the SAP
Patient Management system, playing the role of Patient Demographics Source, to an external system (playing the role of
Patient Demographics Consumer).

To search for a patient record, at least one of the following attributes must be provided:

The name of the patient (PatientName element)

The gender of the patient (PatientGenderCode element)

The identi er of the hospital (PatientHospitalPartyID element)This element is mandatory when patients are stored as
institution-speci c.

A range of birth dates for the patient (SelectionByPatientBirthDate element)

The identi ers of the patient (PatientIdenti cation and PatientID elements)

The address of the patient (PatientAddress element)

For more information about the elements, and an example input, see the PatERPBscDataByBscDataQryMsg_s message data
type.

You must also provide values for the processing conditions. You can either specify that all results be returned at once, or limit
the amount of results to a certain number. If you limit the amount of results, you can call the operation again, starting from a
certain ID (for example, the ID of the last patient returned in a previous search).

Display all results (Query Hits Maximum Indicator)

Display a certain number of results (Query Hits Maximum Number Value)

This is custom documentation. For more information, please visit the SAP Help Portal 48
 6/6/2023
The ID of the last result returned in a previous search (Last Returned Object ID)

Example Input

This is an example set of input data for this operation. It will search for all patients with the last name Wilson. The processing
conditions specify that a maximum of 200 results are to be returned, and all results are to be displayed.

<PatientBasicDataSelectionByBasicData>

<PatientName>

<FamilyName> Wilson </FamilyName>

</PatientName>

</PatientBasicDataSelectionByBasicData>

<ProcessingConditions>

<QueryHitsMaximumNumberValue> 200 </QueryHitsMaximumNumberValue>

<QueryHitsUnlimitedIndicator> true </QueryHitsUnlimitedIndicator>

</ProcessingConditions>

Error Handling
For information about error handling, see "Con guring Enterprise Services for SAP Patient Management" on the Enterprise
Services wiki (). From here, select the ES Bundle Patient Administration , and then select the child page Service Con guration .

Message Types
PatientERPBasicDataByBasicDataQuery_sync

PatientERPBasicDataByBasicDataResponse_sync

Constraints
The PatientGenderCode element cannot be used as the sole search criteria.

In the PatientName element, only the components GivenName, FamilyName and BirthName are supported.

In the PatientGenderCode element, only the values '0' (Unknown), '1' (Male) and '2' (Female) are supported.

In the InclusionExclusionCode element, only the value 'I' (Inclusion) is supported.

In the IntervalBoundaryTypeCode element, only the values '1' (single value), '3' (interval closed lower and upper) and '7'
(interval with unlimited lower and closed upper boundary) are supported.

Patient Encounter Management

De nition

This is custom documentation. For more information, please visit the SAP Help Portal 49
 6/6/2023
This component stores and manages information about patient encounters like inpatient stays or visits to healthcare providers.
Data is processed for both actual (history) and planned (future) patient encounters.

Technical Data

Entity Type Process Component

Software Component Version ESM ERP 606

Technical Name PatientEncounterManagement

Namespace http://sap.com/xi/ESM/ERP

Business Context and Use

The Patient Encounter Management process component facilitates the creation and administration of patient encounters,
represented by the Patient Encounter business object. It allows healthcare institutions to record patients' encounters with the
healthcare system.

The Patient Encounter business object is used to record these real-world encounters. The Patient Encounter business object
stores information on each patient encounter.

Related Process Components

The Healthcare Business Partner Data Management process component manages patient details.

The Patient Financials process component manages billable treatments and groups them by patient.

Patient Encounter

De nition
A Patient Encounter describes an interaction between a Patient and a healthcare provider. A Patient Encounter spans a period
of time, the length and detail of which may vary according to local procedures and conventions. Examples may be: Inpatient
Stay, Outpatient Visit, Patient's General Practitioner Visit, Telephone Consultation.

Technical Data

Entity Type Business Object

Software Component Version ESM ERP 605

Technical Name PatientEncounter

Object Category Business Process Object

Business Context and Use

Overview

The Patient Encounter business object is used to manage information on a patient's stay in the hospital. A patient ( Patient
business object) is assigned to a patient encounter, which is then assigned to a billing patient encounter group ( Billing Patient
Encounter Group business object. If no billing patient encounter group exists when a patient encounter is created, the system

This is custom documentation. For more information, please visit the SAP Help Portal 50
 6/6/2023
also creates an instance of the Billing Patient Encounter Group business object. A patient encounter is uniquely identi ed by a
PatientEncounterID.

Patient encounters are delimited by events such as admission, discharge, and transfer.

There are four categories of patient encounter, speci ed by the CategoryCode element:

Inpatient Stay (CategoryCode with value '01')

Absence (CategoryCode with value '02')

Visit (CategoryCode with value '03')

Procedural Visit (CategoryCode with value '04')A procedural visit is a visit for the purpose of a planned
medical procedure (for example, an X-ray).

The Patient Encounter Management process component provides service operations to maintain and search for patient
encounters, and to view the details of patient encounters.

Use Cases

1. A nurse admits a patient, but does not know when the patient will be discharged. The nurse enters any information that
is available, and the Create Patient Encounter service operation is called to create an instance of the Patient Encounter
business object of category 'Inpatient Stay' for the patient. However, no end date is speci ed. Five days later, the patient
has been treated and the discharge date is now known. The nurse again enters the system and adds the discharge date
to the patient encounter, which is carried out using the Update Patient Encounter service operation. The back-
end creates a discharge for the patient.

2. A nurse admits a patient, knowing when the patient will be discharged. The Create Patient Encounter service operation
is called, as above, to create the instance of the Patient Encounter business object (including the discharge
date). However, the patient must later be transferred to another department. The nurse enters the transfer into the
system and adds the relevant organizational data that speci es the new organizational unit. On creating the transfer,
the Create Patient Encounter operation is called again and creates the transfer in the back-end system.

Notes on SAP Implementation

Mapping of Patient Encounter Categories to Movement Categories in SAP Patient Management

This section explains how the four patient encounter categories are derived from the six movement categories in the SAP
Patient Management back-end system.

In SAP Patient Management, the following movement categories exist:

Admission (movement category 1)

Transfer (movement category 3)

Discharge (movement category 2)

Start of Absence (movement category 6)

End of Absence (movement category 7)

Outpatient Visit (movement category 4)Including sub-types such as 'Outpatient Surgery'

'Inpatient Stay' patient encounters describe a period in time, delimited by the following movements in SAP Patient
Management:

This is custom documentation. For more information, please visit the SAP Help Portal 51
 6/6/2023
The period starting from an admission movement only (no end date of the inpatient stay speci ed)

The period between an admission movement and a discharge movement

The period between an admission movement and a transfer movement

The period between a transfer movement and a transfer movement

The period between a transfer movement and a discharge movementThese periods are determined by the start and end
date of the patient encounter, and can be controlled either when creating the encounter (using the Create Patient
Encounter service operation), or when changing the encounter (using the Update Patient Encounter service operation).

'Absence' patient encounters run in parallel to inpatient stays and do not interrupt them. They correspond to the following
movements in SAP Patient Management:

Start of absence and end of absence

'Visit' patient encounters correspond to:

One outpatient visit movement (containing the start and end time of the visit) of any type other than outpatient surgery

'Procedural Visit' patient encounters correspond to:

One outpatient surgery movement (containing the start and end time of the visit) of type outpatient surgery

Terminology Mapping

Billing patient encounter group maps to the SAP Patient Managment concept case

HospitalParty maps to the SAP Patient Management concept institution

Customizing

Several elements of this business object (treatment codes, movement types, referral type, external codes, and so
on) require you to make Customizing settings to map external data to internal data. You make these settings
in Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication -> Preparation
for Service-Enabling -> Inbound Processing -> Assign GDTs to Customizing Data -> Patient Encounter.

You must maintain the supplementary component (SC) information for internal and external identi ers. For more
information on SCs, see Scheme Attributes at IDs and Codes . Find the Customizing for supplementary components in
SAP Healthcare - Industry-speci c Components for Hospitals under Communication -> Preparation for Service
Enabling -> Inbound Processing -> Maintain Validation Parameters -> Maintain Business Object Identi cation. The
context NBEW - LFDNR is used for the internal identi cation, and the context NBEW - BEXNR is used for the external
identi cation.

Manage Patient Encounter In

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

This is custom documentation. For more information, please visit the SAP Help Portal 52
 6/6/2023
The Manage Patient Encounter In inbound service interface groups service operations that query to, and receive information
from, the Patient Encounter Management process component to maintain an instance of the Patient Encounter business
object. These service operations can be used to create, update, read, and cancel patient encounters.

Cancel Patient Encounter

De nition
To cancel an instance of the Patient Encounter business object, and return a con rmation that the cancellation was successful.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientEncounterERPCancelRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatEncCancelRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

The Cancel Patient Encounter inbound operation cancels an instance of a Patient Encounter business object. This can be done,
for example, to remove an incorrect data entry.

Related Operations

The Create Patient Encounter and Update Patient Encounter operations are used to create and update instances of
the Patient Encounter business object.

The Read Patient Encounter operation is used to view the details of a patient encounter.

Features
This synchronous inbound operation cancels an instance of the Patient Encounter business object, speci ed by either its
internal (from SAP Patient Management) or its external (from a partner application) identi cation. It can be performed exactly
once for a given set of input data. For information on Exactly Once (Idempotent) behavior, see Idempotent Service .

This is custom documentation. For more information, please visit the SAP Help Portal 53
 6/6/2023
To cancel a patient encounter, the following information is required:

The identi er of the patient encounter (PatientEncounterID element)

The following information additional information can also be supplied, but is not mandatory:

The reason for cancelling the patient encounter (CancellationReasonCode element)

Example Input

This is an example set of input data for this operation. Both the identi er of the patient encounter and a cancellation reason
have been provided.

<PatientEncounter>

<ID> 0001000500100500002 </ID>

<CancellationReasonCode listID ="Str 193" listVersionID ="Str 194" listAgencyID ="Str 195" > INVALID
</CancellationReasonCode >

</PatientEncounter>

Message Types
PatientEncounterERPCancelCon rmationMessage_sync

PatientEncounterERPCancelRequestMessage_sync

Prerequisites
An instance of the Patient Encounter business object can only be cancelled if there are no dependent objects (for
example, medical records, diagnoses or medical activities) still assigned to it. You must cancel all dependent
objects before you can cancel it.

If you want to use cancellation reasons, you must rst make the settings for cancellation reasons in Customizing for SAP
Healthcare - Industry-Speci c Components for Hospitals under Communication -> Preparation for Service Enabling ->
Inbound Processing -> Assign GDT to Customizing -> Patient Encounter -> Assign Cancellation Reasons.

Notes on SAP Implementation

Cancellation Behavior

Examples of certain cancellation behaviors in the SAP Patient Management back-end system:

Example 1 You want to cancel an 'Inpatient Stay' patient encounter which has no end date. There is only one admission
movement in the back-end system. The Cancel Patient Encounter operation cancels the admission (including the case).

Example 2 You want to cancel an 'Inpatient Stay' patient encounter. There are two movements in the back-end system: one
admission and one discharge . The Cancel Patient Encounter operation cancels the admission and discharge
movements. Note: It is not possible to cancel the discharge only with this operation. You can only cancel the whole patient
encounter (both admission and discharge in the back-end). However, you can cancel the discharge movement by using the
Update Patient Encounter operation to remove the EndDate of the patient encounter.

Example 3 You want to cancel an 'Inpatient Stay' patient encounter. There are four movements in the back-end system: an
admission , a start of absence , an end of absence and a discharge . The patient encounter cannot be cancelled before the

This is custom documentation. For more information, please visit the SAP Help Portal 54
 6/6/2023
absence movement is cancelled. You can only cancel an 'Inpatient Stay' patient encounter with a corresponding admission in
the back-end system if no other patient encounters are assigned to the billing patient encounter group.

Example 4 You want to cancel an 'Inpatient Stay' patient encounter which starts on [time2] and ends on [time3]. There are four
movements in the back-end system: admission on [time1], transfer on [time2], transfer on [time3] and a discharge on [time4].
These four movements relate to three patient encounters:

Inpatient Stay from [time1] to [time2]

Inpatient Stay from [time2] to [time3]

Inpatient Stay from [time3] to [time4]

The Cancel Patient Encounter operation cancels the transfer on [time2]. The remaining three movements in the back-end
system relate to two patient encounters:

Inpatient Stay from [time1] to [time3]

Inpatient Stay from [time3] to [time4]

Create Patient Encounter

De nition
To create an instance of the Patient Encounter business object, and send a con rmation that the encounter has been created.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientEncounterERPCreateRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientEncounterERPCrtRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

The Patient Encounter business object is used to document a patient's contact with a healthcare provider. There are four
categories of patient encounter ('Inpatient Stay', 'Absence', 'Visit', and 'Procedural Visit'), all of which can be created by this
This is custom documentation. For more information, please visit the SAP Help Portal 55
 6/6/2023
service operation.

The Create Patient Encounter inbound operation creates an instance of a patient encounter (the Patient Encounter business
object) for a patient (the Patient business object).

Related Operations

The Update Patient Encounter and Cancel Patient Encounter service operations are used to update or cancel an
existing instance of the Patient Encounter business object.

The Read Patient Encounter service operation is used to view the details of a patient encounter.

Features
This synchronous inbound operation creates patient encounters of all four categories (Inpatient Stay, Absence, Visit
and Procedural Visit). For more information about the different categories, see the documentation for the Patient Encounter
business object.

This operation can be performed exactly once for a given set of input data. For information on Exactly Once (Idempotent)
behavior, see Idempotent Service .

To create a patient encounter, the following information is required:

The identi er of the hospital (HospitalPartyID element)

The identi er of the patient (PatientID element)

The category of patient encounter to be created (CategoryCode element)

You can also provide more information as optional input, but not all elements are supported by all categories of Patient
Encounter business object.

When an instance of the Patient Encounter business object is created, the system assigns a primary PatientEncounterID
and uses the external ID (provided as input) as an additional identi er. When creating a patient encounter, you can only enter an
external ID.

Example Input

This is an example set of input data for this operation. The identi ers of the patient, hospital, room, bed, departmental unit,
nursing unit, and admitting physician have been provided. Additionally, the patient encounter category code and a note have
been entered.

<PatientEncounter>

<ID schemeID="" schemeVersionID="" schemeAgencyID=" " > </ID>

<PatientID> 2012416 </PatientID>

<HospitalPartyID> 0001 </HospitalPartyID>

<RoomID> M012Z1 </RoomID>

<BedLocationID> M012Z1B1 </BedLocationID>

<CategoryCode> 1 </CategoryCode>

This is custom documentation. For more information, please visit the SAP Help Portal 56
 6/6/2023
<Note> Patient has been admitted </Note>

<DepartmentalUnitParty>

<ID> M01 </ID>

</DepartmentalUnitParty>

<NursingUnitParty>

<ID> M012 </ID>

</NursingUnitParty>

<AdmittingPhysicianParty>

<ID> GUTMANN </ID>

</AdmittingPhysicianParty>

</PatientEncounter>

Message Types
PatientEncounterERPCreateCon rmation_sync

PatientEncounterERPCreateRequest_sync

Constraints
An instance of the Patient business object must exist before a patient encounter can be assigned to it.

For the elements StartSchedulingStatusCode, EndSchedulingStatusCode, and

PatientRoomAssignmentSchedulingStatusCode, only the values 'planned' and 'actual' are supported.

Notes on SAP Implementation

Con guration for Procedural Visits

For Procedural Visits (Outpatient surgery), set the AMBOP (Table TN14B) indicator in Customizing for SAP Healthcare -
Industry-Speci c Components for Hospitals under Patient Management -> Movements -> De ne Movement Types. In the
detail screen, choose the visit type 'Outpatient surgery'.

Scenarios

Since there are four patient encounter categories that correspond to six movement categories in the back-end system, these
scenarios explain how movements are created in the back-end for a given set of input data in the service interface. The main
factor is whether or not the new patient encounter is to be assigned to an existing instance of the Billing Patient Encounter
Group business object ( case in the back-end). BillingPatientEncounterGroupID provided

Case in back-end system is Outpatient

When you create a 'Visit' or a 'Procedural Visit' patient encounter , an outpatient visit movement is created.

When you create an ʻInpatient Stay’ patient encounter:

This is custom documentation. For more information, please visit the SAP Help Portal 57
 6/6/2023
If an in nite value (99991231) is supplied for the EndDate (or a value is not supplied), the case type is changed from
outpatient to inpatient for a given BillingPatientEncounterGroupID, and a new admission movement is created with the
EndDate '99991231'.

If a de nite value (for example, 20080101) is supplied for the EndDate, the case type is changed from outpatient to
inpatient , and two new movements (of types admission and discharge ) are created.

Case in back-end system is Inpatient

When you create an ʻInpatient Stay’ patient encounter:

If a de nite value (for example, 20080101) is supplied for the EndDate, a transfer and a discharge movement are
created with the EndDate '20080101'. (You can only discharge a patient when a de nite EndDate has been provided.)

If an in nite value (99991231) is supplied for the EndDate, or a value is not supplied for the EndDateTime, a transfer
movement is created.

When you create an 'Absence' patient encounter, t wo new movements ( absence from and absence to ) are created.

When you create a ʻVisit’ or ʻProcedural Visit’ patient encounter, an outpatient visit movement is created.

BillingPatientEncounterGroupID not provided

When you create either a 'Visit' or a 'Procedural Visit' patient encounter, a new outpatient case and an outpatient visit
movement are created.

When you create an 'Inpatient Stay' patient encounter:

I f an in nite value (99991231) is supplied for the EndDate (or a value is not supplied), a new inpatient case and a new
admission movement are created, with the EndDate ʻ99991231’.

If a de nite value (for example, 20080101) is supplied for the EndDate, a new inpatient case and two new movements (of
types admission and discharge ) are created.

W hen you create an ʻAbsence’ patient encounter, the system displays the error message 'Absence cannot be created as patient
has not been admitted'.

More Information
Default Values

If no values are provided for the following elements, the default values are:

StartDateTime - system sets the time to the back-end timestamp

EndDateTime - in nite

RoomTVAssignedIndicator - false

EmergenyAdmissionIndicator - false

Read Patient Encounter

De nition

This is custom documentation. For more information, please visit the SAP Help Portal 58
 6/6/2023
To display the details of an instance of the Patient Encounter business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientEncounterERPByIDQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PATENCRBYIDQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

The Read Patient Encounter operation displays the details of a speci ed instance of the Patient Encounter business object, for
example, to learn the discharge date of a certain patient.

Related Operations

The Create Patient Encounter , Update Patient Encounter , and Cancel Patient Encounter operations are used to
manage instances of the Patient Encounter business object.

Features
This synchronous inbound operation returns the details of an instance of the Patient Encounter business object,
speci ed by either its internal (from SAP Patient Management) or external identi cation (from a partner application).

To read the details of a patient encounter, the following information is required:

The identi er of the patient encounter (PatientEncounterID element)

Example Input

This is an example set of input data for this operation.

<PatientEncounterSelectionByID>

<PatientEncounterID schemeID=" " schemeAgencyID=" "> 0001000500111700001 </PatientEncounterID>

</PatientEncounterSelectionByID>

This is custom documentation. For more information, please visit the SAP Help Portal 59
 6/6/2023

Message Types
PatientEncounterERPByIDQuery_sync

PatientEncounterERPByIDResponse_sync

Update Patient Encounter

De nition
To update an instance of the Patient Encounter business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientEncounterERPUpdateRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatientEncounterERPUpdRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior Type3

P2P Communication Enabled true

Business Context and Use

This operation updates the details of a patient encounter ( Patient Encounter business object), for example, when the
patient's stay in hospital is extended beyond the initial duration. It can be used when you need to change any details of a patient
encounter.

Related Operations

The Create Patient Encounter and Cancel Patient Encounter operations are used to create and cancel instances of the
Patient Encounter business object.

The Read Patient Encounter operation is used to view the details of a patient encounter.

Features
This synchronous inbound operation updates an existing instance of the Patient Encounter business object. The elements
supported for each category of patient encounter can be updated using this service operation. It can be performed exactly once

This is custom documentation. For more information, please visit the SAP Help Portal 60
 6/6/2023
for a given set of input data. For information on Exactly Once (Idempotent) behavior, see Idempotent Service .

To update a patient encounter, the following information is required to identify it:

The identi er of the patient encounter (PatientEncounterID element)

The category of patient encounter (CategoryCode element)

The current status of the patient encounter (ChangeStateID element)The ChangeStateID status can be found using the
Read Patient Encounter operation.

In addition to this, provide vales for the attributes that are to be updated. The values provided replace the stored values. You
cannot update the mandatory parameters.

Example Input

This is an example set of input data for this operation. The identi er of the patient, the category code of the patient encounter,
and the current status of the patient encounter have been provided. A new value has been provided for the estimated
treatment duration, and a note has been entered about this.

<PatientEncounter identi cationCompleteTransmissionIndicator=" true ">

<ID schemeID=" " schemeVersionID=" " schemeAgencyID=" "> 0001000500118800001 </ID >

<PatientID schemeID="" schemeAgencyID="" schemeAgencySchemeID="" schemeAgencySchemeAgencyID=""> 2012542

</PatientID>

<<CategoryCode> 1 </CategoryCode>

<NoteLanguageCode="EN"> Updating estimated treatment duration. </Note>

<EstimatedTreatmentDuration> P1D </EstimatedTreatmentDuration>

<ChangeStateID> 2B2370C7A8BB7A5397B8EBD8D0DB5CA5034C0D09 </ChangeStateID>

</PatientEncounter>

Message Types
PatientEncounterERPUpdateCon rmation_sync

PatientEncounterERPUpdateRequest_sync

Prerequisites
The instance of the Patient Encounter business object must exist in the system.

Constraints
Since the same message structure is used to update all patient encounters, not all elements are supported for all
encounter categories.

Notes on SAP Implementation

This is custom documentation. For more information, please visit the SAP Help Portal 61
 6/6/2023
Special Scenarios

Since there are four patient encounter categories (Inpatient Stay, Absence, Visit, Procedural Visit) that correspond to six
movement categories in the back-end system, these scenarios explain how the movements assigned to a given Patient
Encounter business object are updated in the back-end system for a given set of input data.

Note: Each of these scenarios also apply if an outpatient visit movement for an outpatient case exists.

You update the EndDate of a patient encounter that corresponds to an admission movement in the back-end system:

The system updates the admission movement to include the end date, and creates a discharge movement.

You update the EndDate of a patient encounter that corresponds to both an admission and a discharge movement in the back-
end system:

The system updates both the admission and discharge movements.

You update the EndDate of a patient encounter that corresponds to an admission , and also update the organization and
building unit data (RoomID, BedLocationID, DepartmentalUnitPartyID and NursingUnitPartyID):

The system updates the admission movement and organization and building unit data (RoomID, BedLocationID,
DepartmentalUnitPartyID and NursingUnitPartyID). The system updates the admission movement and creates a
discharge movement.

You update the EndDate of a patient encounter that corresponds to an admission and a transfer movement in the back-end
system:

The system updates the transfer movement, and creates a discharge movement.

You update the EndDate of an patient encounter that covers the period between an admission and a transfer
movement. Another inpatient stay patient encounter exists that covers the period between the transfer and a discharge
movement in the back-end system:

The system updates the transfer movement, and also automatically updates the StartDate of the second inpatient stay.

More Information
Change/Update Behavior

This operation is an 'update' service operation. It updates data so that it changes consistently from a 'before' image to an 'after'
image. Concurrent changes are not overwritten; only the rst concurrent change is saved, and others fail due to an invalid
ChangeStateID. For more information on the Change/Update Behavior of this service operation, see Change / Update Behavior
Type 3 .

Default Values

If no values are supplied for the following elements, the default values are:

StartDateTime - system sets the time to the back-end timestamp

RoomTVAssignedIndicator - false

EmergencyAdmissionIndicator - false

This is custom documentation. For more information, please visit the SAP Help Portal 62
 6/6/2023

Query Patient Encounter In

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Query Patient Encounter In inbound service interface contains an operation that queries the Patient Encounter
Management process component for a list of patients.

Find Patient Encounter Patient List by Elements

De nition
To nd a list of patients that meet certain criteria based on patient encounter information.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name PatientEncounterERPPatientListByElementsQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PatEncERPPatientListQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

The Find Patient Encounter Patient List by Elements operation searches for and displays a list of patients ( Patient business
object) whose assigned patient encounters ( Patient Encounter business object) meet the criteria speci ed. It can be used
to answer questions such as:

This is custom documentation. For more information, please visit the SAP Help Portal 63
 6/6/2023
Which patients have been admitted during the last month?

What are the planned discharges for the next week?

What transfers have taken place between departments last week?

Who are the discharged patients of a physician?

How many transfers are planned for the next week?

Related Operations

The Read Patient and Read Patient Encounter service operations are used to view the details of patients and patient
encounters.

The Find Patient by Basic Data and Find Patient by Identifying Elements service operations are used to search for
instances of the Patient business object using various criteria.

Features
This synchronous inbound operation returns a list of Patient business objects with basic patient encounter information and the
corresponding patient data.

If you anticipate a large amount of results, you can use processing conditions to limit the data returned. This allows you to
retrieve data in packages of a prede ned size, and the next set of data can then be started from the nal ID returned
by the rst search.

To nd a patient encounter patient list, the following information is required:

The identi er of the hospital (HospitalPartyID element)

You can also provide any other elements as optional input.

Example Input

This is an example set of input data for this operation. The identi er of the hospital, patient, and billing patient encounter group
have been provided. Addtionally, the category code of the patient encounter and the admission date of the patient encounter
have been provided.

<PatientEncounterPatientListSelectionByElements>

<PatientID> 1234567890 </PatientID>

<PatientEncounterBillingPatientEncounterGroupID> 0987654321 </PatientEncounterBillingPatientEncounterGroupID>

<PatientEncounterHospitalPartyID> 1234 </PatientEncounterHospitalPartyID>

<PatientEncounterCategoryCode> 1 </PatientEncounterCategoryCode>

<SelectionByPatientEncounterAdmissionDate>

<IntervalBoundaryTypeCode> 1 </IntervalBoundaryTypeCode>

<InclusionExclusionCode> I </InclusionExclusionCode>

<LowerBoundaryPatientEncounterAdmissionDate> 2005-05-22 </LowerBoundaryPatientEncounterAdmissionDate>

This is custom documentation. For more information, please visit the SAP Help Portal 64
 6/6/2023
<UpperBoundaryPatientEncounterAdmissionDate> 2005-05-22 </UpperBoundaryPatientEncounterAdmissionDate>

</SelectionByPatientEncounterAdmissionDate>

</PatientEncounterPatientListSelectionByElements>

Message Types
PatientEncounterERPPatientListByElementsQuery_sync

PatientEncounterERPPatientListByElementsResponse_sync

Constraints
For the IntervalBoundaryTypeCode element, only the values '1', '3', and '7' are supported.

For the InclusionExclusionCode element, only the value 'I' is supported.

Patient Encounter Record

De nition
A carrier of information about a patient encounter, along with associated medical and billing data.

Technical Data

Entity Type Business Object

Software Component Version ESM ERP 605

Technical Name PatientEncounterRecord

Object Category Transformed Object

Business Context and Use

The Patient Encounter Record transformed object aggregates information about the following business objects:

Patient ( Patient business object)

Patient encounter ( Patient Encounter business object)

Billing patient encounter group ( Billing Patient Encounter Group business object)

Medical diagnoses ( Medical Diagnosis business object)

Medical procedures

Medical activities ( Medical Activity business object)

The main purpose of this business object and its operations is to provide a stronger support for the Health Level 7 (HL7)
industry standard (which is strongly event-based) and to allow easy mapping between the operation concepts and data types,
and those used for HL7 messaging.

This is custom documentation. For more information, please visit the SAP Help Portal 65
 6/6/2023
A patient encounter record could be, for example, an admission noti cation or a surgery report.

Use Cases

1. In the context of a surgery, this transformed object can be used to transmit the complete set of information to be
documented from the operation room system to SAP Patient Management (Maintain Surgery based on Patient
Encounter Record Surgery Noti cation operation). This covers the information about the surgery itself (such as date
and time, organizational units, and operating surgeon) as well as the documented procedures and diagnoses, and
performed medical activities.

2. After a day in the ICU, the patient’s condition has improved, and the patient is transferred to a regular bed. The hospital
ADT system sends a Patient Transfer message to hospital ancillary systems, with the outbound noti cation of the
transfer ( Inform of Patient Encounter Record operation) carrying the relevant data necessary to generate the HL7 A02
event/message.

Features
The Patient Encounter Record business object is a transformed business object, which means that the nodes of its
structure consist of other business objects. The high-level structure of this transformed object is shown below. For the structure
of the individual business objects, see the relevant documentation.

Note: As there are no dedicated operations assigned to the Medical Procedure business object, information that relates to it is
documented here.

Patient Encounter RecordThe root node contains no elements other than the sub-nodes.

PatientContains information about the patient for whom this patient encounter record is relevant. For more
information, see the Patient business object.

Patient EncounterContains information about the patient encounter. For more information, see the Patient
Encounter business object.

Billing Patient Encounter GroupContains information about the billing patient encounter group. For more
information, see the Billing Patient Encounter Group business object.

Medical DiagnosisContains information about the medical diagnoses made as part of this patient encounter
record. For more information, see the Medical Diagnosis business object.

Medical ProcedureContains information about the medical procedures carried out as part of this patient
encounter record.A medical procedure is a course of action intended to care for a person with health problems.
The Medical Procedure business object is used to access and manage medical procedures for patient encounters
and billing patient encounter groups.The MedicalProcedure node contains identifying, administrative, and
technical information about the medical procedure and the patient encounter or billing patient encounter group
to which it is assigned.

HospitalPartyContains information about the hospital in which the patient is being treated.

DepartmentalUnitPartyContains information about the department in which the procedure is being

performed.

NursingUnitPartyContains information about the nursing unit where the patient is being treated.

PartyContains information about any other related parties, such as a physician or an organization.

AlternativeIdenti cationAllows speci cation and handling of procedures through alternative external IDs
(for example, from third-party systems).

Medical ActivityContains information about the medical activities performed as part of this patient encounter
record. For more information, see the Medical Activity business object.

This is custom documentation. For more information, please visit the SAP Help Portal 66
 6/6/2023

Constraints
The Patient Encounter Record business object currently does not cover any data on healthcare smart or electronic cards.

Notes on SAP Implementation

Con guration for Medical Procedure

The transactions NP36 and NP37 can be used to view the effect of movement-related medical procedures in the backend. The
transactions NP47 and NP48 can be used to view the effect of case-related medical procedures in the backend.

The following Customizing activities are required for the Medical Procedure business object:

Surgical procedure codes and surgical procedure types Customizing for SAP Healthcare - Industry-Speci c Components
for Hospitals under Medical/Nursing Documentation Maintain Surgery Types . For more information, see
Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Hospital Basic Data Catalogs
Surgeries Import ICPM Catalog .

Code ValuesCustomizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication
Preparation Service-Enabling Inbound Processing Assign GDTs to Customizing Data Procedures .

Con guration for Patient Encounter Record

Events supported for outbound processingCustomizing for SAP Healthcare - Industry-Speci c Components for
Hospitals under Communication Preparation Service-Enabling Asynchronous Outbound Processing Assign
Relevant EDI Events for Service Enabling The business scope eld is lled with event type information. This event
type information can be used for HL7 mapping. For example (where NP11I0 is the event code):

<BusinessScope> <TypeCode> 3 </TypeCode> <ID schemeID=" 10555 " schemeAgencyID=" 310 "> NP11I0
</ID></BusinessScope>

In the above example, this event of type NP11IO can be mapped to HL7 event A01 - Admit/Visit Noti cation (Inpatient)

Code ValuesCustomizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication
Preparation for Service Enabling Preparation for Service Enabling Inbound Processing Assign GDTs to
Customizing Data

Business Object Identi cation Customizing for SAP Healthcare - Industry-speci c Components for Hospitals under
Communication Preparation for Service Enabling Inbound Processing Maintain Validation Parameters Maintain
Business Object Identi cation . For more information, see Scheme Attributes at IDs and Codes .

More Information
For more information about con guring Healthcare service operations, see SAP Note 1461621 .

Patient Encounter Record Event Out

De nition
An interface to notify connected systems of any changes to a patient encounter record.

Technical Data

This is custom documentation. For more information, please visit the SAP Help Portal 67
 6/6/2023

Entity Type Service Interface

Category SAP A2A

Direction outbound

Business Context and Use

The Patient Encounter Record Event Out outbound service interface contains an operation to send information about a patient
encounter record to connected systems.

Inform of Patient Encounter Record

De nition
To inform third-party systems about an event that relates to a patient encounter and its related data.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 605

Release State released

Technical Name PatientEncounterRecordERPInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

An employee creates, updates, or cancels a patient encounter (for example, to admit a new patient). The Inform of Patient
Encounter Record operation sends information about the patient encounter ( Patient Encounter business object) to third-party
systems.

Related Operations

The Maintain Surgery based on Patient Encounter Record Surgery Noti cation operation is used to maintain a surgery
(patient encounter) based on noti cation from a third-party system.

Features

This is custom documentation. For more information, please visit the SAP Help Portal 68
 6/6/2023
This asynchronous outbound operation informs third-party systems of an event related to a patient encounter ( Patient
Encounter Record business object) from the Patient Encounter Management process component. This operation is triggered
when a patient encounter ( Patient Encounter business object) or any associated data (such as diagnoses) is created, updated
or cancelled.

The purpose of this operation (and the Patient Encounter Record business object) is to provide stronger support for the Health
Level 7 (HL7) industry standard (which is strongly event-based) and to allow easy mapping between the operation concepts and
data types and those used for HL7 messaging. In addition to information about the patient encounter, this operation sends
comprehensive information about the patient ( Patient business object), billing patient encounter group ( Billing Patient
Encounter Group business object), and diagnoses ( Medical Diagnosis business object).

The information sent by this operation can consist of data about the following:

Inpatient events (such as admissions, transfers, discharges, visits, and absences)

Outpatient events (such as visits)

Changes of case type (such as inpatient to outpatient)

The information about the event type is contained in the business scope eld . This event type information can be used for HL7
mapping. For example (where NP11I0 is the event code):

<BusinessScope> <TypeCode> 3 </TypeCode> <ID schemeID="10555" schemeAgencyID="310"> NP11I0 </ID>

</BusinessScope>

In the above example, this event of type NP11IO can be mapped to HL7 event A01 - Admit/Visit Noti cation (Inpatient).

The PatientEncounterEvent node contains additional information about the event that triggered the operation. This information
includes the movement ID and the PreviousIndicator element, which enables mapping to the German-speci c ZBE HL7-
Segment and allows handling of the HL7 historical movement concept, that is, a movement in SAP Patient Management that is
not current. (For information about how movements in SAP Patient Management correspond to patient encounters, see the
Patient Encounter business object.)If the event that triggers this operation is the maintenance of a historical movement, the
value of the PreviousIndicator element in the PatientEncounterEvent node is set as ʻtrue’, and the actionCode attribute of the
node is set as follows:

Creation of a movement: actionCode 01

Update of a movement: actionCode 02

Cancellation of a movement: actionCode 03

Error Handling
If communication errors occur during express dispatch, the event is processed by the normal dispatch report.

The Inform of Patient Encounter Record operation supports Forward Error Handling (FEH). The following error category is
used:

PRE: Processing Error

Message Types
PatientEncounterRecordERPInformation

Notes on SAP Implementation

This is custom documentation. For more information, please visit the SAP Help Portal 69
 6/6/2023
This operation is triggered when a movement in the backend is created, updated, or cancelled with the Clinical Process Builder
(transaction NV2000). Each movement action is mapped to an event. For example, the creation of an inpatient admission
movement with the status ʻactual’ is mapped to NP11I0, and the creation of a discharge movement with the status ʻactual’ is
mapped to NP97I0.

In more detail: events occur whenever a creation, change, or cancellation is made to an instance of the following object types.

Inpatient Admission

Outpatient Admission

Transfer

Discharge

Visit

Begin or end of an absence

Events are also triggered when the case type is changed, when a case classi cation is maintained, or when a case-related
insurance relationship is maintained. For example, the creation of a case classi cation is one event, and the cancellation of an
outpatient admission is another.A full list of events which trigger this operation can be found at the end of this section.

The operation may then be mapped to the following HL7 events:

A01 – Admit/visit noti cation (Inpatient)

A02 – Transfer a patient

A03 – Discharge/end visit

A04 – Register a patient (Outpatient)

A05 – Pre-admit a patient

A06 – Change an outpatient to an inpatient

A07 – Change an inpatient to an outpatient

A08 – Update patient information

A11 – Cancel admit/visit noti cation

A12 – Cancel transfer

A13 – Cancel discharge/end visit

A14 – Pending admit

A15 – Pending transfer

A16 – Pending discharge

A21 – Patient goes on a leave of absence

A22 – Patient returns from a leave of absence

A PI mapping with the corresponding XML representation of the mentioned HL7 messages is also available. For more
information, see SAP Note 1461621. Depending on the event in the backend, the information will be sent in one of two modes.
Information on the following events is triggered immediately and is sent almost synchronously:

Creation of an inpatient admission

This is custom documentation. For more information, please visit the SAP Help Portal 70
 6/6/2023
Creation of an outpatient visit

All other events are normally dispatched, with their information being sent during the regularly scheduled run.

In those cases where two noti cations about the same object are queued for normal dispatch, consolidation logic combines the
two and sends them as a single information message as follows:

If an object is created, and later updated, only the creation information is sent. However, this includes the updated data.

If an object is created, and later cancelled, only the cancellation information is sent.

If an object is updated, and later cancelled, only the cancellation information is sent.

The following list contains all events that trigger the Inform of Patient Encounter Record operation:

NP11I0 Inpat. Admission: Create Actual Admission Data

NP11P0 Inpat. Admission: Create Planned Admission Data

NP12I0 Inpat. Admission: Change Actual Admission Data

NP12IS Inpat. Admission: Cancel Actual Admission Data

NP12IV Inpat. Admission: Change Actual Length of Stay

NP12P0 Inpat. Admission: Change Planned Admission Data

NP12PS Inpat. Admission: Cancel Planned Admission Data

NP4000 Outpatient Admission: Create Case

NP400S Outpat. Admission: Cancel Case

NP40K0 Outpat. Quick Admission: Create Case

NP40N0 Outpat. Emergency Admission: Create Case

NP41I0 Outpatient Admission: Create Actual Visit Data

NP41P0 Outpatient Admission: Create Planned Visit Data

NP42I0 Outpatient Admission: Change Actual Visit Data

NP42IS Outp. Admission: Cancel Actual Visit Data

NP42PS Outpatient Admission: Cancel Planned Visit Data

NP5500 Maintain Case Classi cation

NP55E0 Create Single Case Classi cation

NP55E1 Change Single Case Classi cation

NP55ES Cancel/Delete Single Case Classi cation

NP91BI Create Actual Absence Start

NP91BP Create Planned Absence Start

NP91EI Create Actual Absence End

NP91EP Create Planned Absence End

NP92BI Change Actual Absence Start

This is custom documentation. For more information, please visit the SAP Help Portal 71
 6/6/2023
NP92BP Change Planned Absence Start

NP92BS Cancel Actual Absence Start

NP92BT Cancel Planned Absence Start

NP92EI Change Actual Absence Start

NP92EP Change Planned Absence End

NP92ES Cancel Actual Absence End

NP92ET Cancel Planned Absence End

NP97I0 Discharge: Create Actual Discharge Data

NP97P0 Discharge: Create Planned Discharge Data

NP98I0 Discharge: Change Actual Discharge Data

NP98IS Discharge: Cancel Actual Discharge Data

NP98P0 Discharge: Change Planned Discharge Data

NP98PS Discharge: Cancel Planned Discharge Data

NV04I0 Inpat. Quick Admission: Create Actual Adm. Data

NV04P0 Inpat. Quick Admission: Create Planned Adm. Data

NV05I0 Inpat. Quick Admission: Change Actual Adm. Data

NV05P0 Inpatient Quick Admission: Change Planned Adm.Data

NV07I0 Inpat. Emerg. Admission: Create Actual Adm. Data

NV07P0 Inpat. Emerg. Admission: Create Planned Adm. Data

NV08I0 Inpat. Emerg. Admission: Change Actual Adm. Data

NV08P0 Inpat. Emerg. Admission: Change Planned Adm. Data

NV11I0 Transfer: Create Actual Transfer

NV11P0 Transfer: Create Planned Transfer

NV12I0 Transfer: Change Actual Transfer

NV12IS Transfer: Cancel Actual Transfer

NV12P0 Transfer: Change Planned Transfer

NV12PS Transfer: Cancel Planned Transfer

NV33E0 Create Single Case-Related Insurance Relationship

NV33E1 Change Single Case-Related Insurance Relationship

NV33ES Cancel Single Case-Related Insurance Relationship

NV44I0 Outpat. Quick Adm.: Create Actual Visit Data

NV44IO Create Actual Surgery (Mvmt) - Quick Admission

NV44P0 Outpat. Quick Adm.: Create Planned Visit Data

NV44PO Create Planned Surgery (Mvmt) - Quick Admission

This is custom documentation. For more information, please visit the SAP Help Portal 72
 6/6/2023
NV45I0 Outpat. Quick Adm.: Change Actual Visit Data

NV45IO Change Actual Surgery (Mvmt) - Quick Admission

NV45P0 Outpat. Quick Adm.: Change Planned Visit Data

NV45PO Change Planned Surgery (Mvmt) - Quick Admission

NV47I0 Outpat. Emerg. Adm.: Create Actual Visit Data

NV47IO Create Actual Surgery (Mvmt) - Emergency Adm.

NV47P0 Outpat. Emerg. Adm.: Create Planned Visit Data

NV47PO Create Planned Surgery (Mvmt) - Emergency Adm.

NV48I0 Outpat. Emerg. Adm.: Change Actual Visit Data

NV48IO Change Actual Surgery (Mvmt) - Emergency Adm.

NV48P0 Outpat. Emerg. Adm.: Change Planned Visit Data

NV48PO Change Planned Surgery (Mvmt) - Emergency Adm.

NWFAKI Quick Change Case Type Outpat.-> Inpatient Actual

NWFAKP Quick Change Case Type Outpat.-> Inpatient Planned

NWFANI Emerg. Change Case Type Outpat. -> Inpat. Actual

NWFANP Emerg. Change Case Type Outpatient -> Inpat.Plann.

NWFASI Change Case Type from Outpat. to Inpatient (Act.)

NWFASP Change Case Type from Outpat. to Inpatient (Plan.)

NWFSAI Change Case Type from Inpat. to Outpatient (Act.)

NWFSAP Change Case Type from Inpat. to Outpatient (Plan.)

NWFSKI Quick Case Type Change Inpatient -> Outpat. Actual

NWFSKP Quick Case Type Change Inpatient -> Outpat. Plann.

NWFSNI Emerg. Case Type Change Inpatient -> Outpat.Actual

NWFSNP Emerg. Case Type Change Inpatient -> Outpat.Plann.

More Information
For information about the MDT of this operation, see SAP Note 1461661 .

Patient Encounter Record In

De nition
An interface to maintain a patient encounter record based on noti cation from a connected system.

Technical Data

This is custom documentation. For more information, please visit the SAP Help Portal 73
 6/6/2023
Entity Type Service Interface

Category SAP A2A

Direction inbound

Business Context and Use

The Patient Encounter Record In inbound service interface contains an operation to maintain a patient encounter record based
on noti cation from a connected system.

Maintain Surgery based on Patient Encounter Record Surgery

Noti cation

De nition
To maintain the administrative documentation of a surgery based on a noti cation from a third-party system.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 605

Release State released

Technical Name PatientEncounterRecordERPSurgeryNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_PATENCRCDSURGERYNOTIF

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

A patient undergoes surgery, which is documented in the operation room system. Based on noti cation received from this
system, the Maintain Surgery based on Patient Encounter Record Surgery Noti cation operation maintains a patient
encounter ( Patient Encounter business object) and all related data, such as medical activities ( Medical Activity business
object), medical procedures (see the Patient Encounter Record business object), and medical diagnoses ( Medical Diagnosis
business object), to re ect the surgery.

Related Operations

The Inform of Patient Encounter Record operation sends information about the maintenance of a patient encounter
record to third-party systems.

This is custom documentation. For more information, please visit the SAP Help Portal 74
 6/6/2023

Features
A surgery consists of a patient encounter ( Patient Encounter business object) of the type ʻprocedural visit’. This asynchronous
inbound operation creates, updates, or cancels procedural visit patient encounters. It also allows the simultaneous
maintenance of all associated documentation, including medical activities ( Medical Activity business object), medical
procedures (see the Patient Encounter Record business object), and medical diagnoses ( Medical Diagnosis business object).

The mandatory input for using this operation in various scenarios is listed below, but additional information can be provided if
necessary. For more information about the structure of the business object, see the Patient Encounter Record business object.
For more information about the structure of the medical diagnosis, medical activity, and medical procedure nodes, see the
respective business objects.

 Note
Wherever IDs for patient encounters, diagnoses, activities, and procedures are required, you can also use external IDs by
entering them in the AlternativeID element in the respective nodes.

To create a surgery:

The ID of the billing patient encounter group for which the surgery is to be created (BillingPatientEncounterGroup node -
> ID element)

The hospital in which the patient is being treated (HospitalPartyID)

The code 04, to create a procedural visit patient encounter (PatientEncounter node -> CategoryCode element)

actionCode 01 (Create)

The code of the reason for the initiation of this surgery (InitiationReasonCode)For example, dental surgery.

The physician who referred the patient (ReferringPhysicianID)

The physician who is treating the patient (AttendingPhysicianID)

Information about the diagnosis (MedicalDiagnosis node)

actionCode 01 (Create)

The code of the diagnosis to be created and the catalogue in which it is de ned (MedicalDiagnosisCatalogueID
and MedicalDiagnosisCatalogueItemID)

Any other related informationFor more information about input data for the Diagnosis node, see the Maintain
Medical Diagnosis based on Medical Diagnosis Collection Noti cation operation.

Information about the medical activity (MedicalActivity node)

actionCode 01 (Create)

The code of the activity to be created and the catalogue in which it is de ned
(PublishedMedicalServiceCatalogueID and PublishedMedicalServiceCatalogueItemID)

Any other related informationFor more information about input data for the MedicalActivity node, see the
Maintain Medical Activity based on Medical Activity Collection Noti cation operation.

Information about the medical procedure (MedicalProcedure node)

actionCode 01 (Create)

The code of the procedure to be created and the catalogue in which it is de ned (MedicalProcedureCatalogueID
and MedicalProcedureCatalogueItemID)

This is custom documentation. For more information, please visit the SAP Help Portal 75
 6/6/2023
Any other related informationFor more information about input data for the MedicalProcedure node, see the
Patient Encounter Record business object.

To update a surgery:

The ID of the patient encounter (PatientEncounterID)

actionCode 02 (Update)

New values for any elements that are to be updated

This operation allows you to create, change, or cancel all diagnoses, activities, and procedures that are part of a surgery.
Detailed information about the input for each node (that is, each component business object) can be found in the
following:

Maintain Medical Diagnosis based on Medical Diagnosis Collection Noti cation operation (for medical diagnoses)

Maintain Medical Activity based on Medical Activity Collection Noti cation operation (for medical activities)

Patient Encounter Record business object (for medical procedures)

To cancel a surgery:

The ID of the patient encounter (PatientEncounterID)

actionCode 03 (Cancel) Note: You cannot cancel a surgery if dependent data exists for that surgery. Any dependent data
(such as diagnoses or procedures) must be cancelled either before cancelling the surgery, or by cancelling them as part
of this call.

Error Handling
If you try to create a surgery and get an error, check that the billing patient encounter group (case in the backend) you
supplied for the BillingPatientEncounterGroupID element exists, and that the ID (case number) is correct.

If you try to update a surgery and get an error, check that the patient encounter you supplied for the PatientEncounterID
element exists, and that the ID (that is, the concatenation of the hospital number, case number, and movement number
in the backend) is correct. For more information on the patient encounter ID, see the Patient Encounter business object.

If you try to update a surgery by changing the patient encounter status from ʻactual’ to ʻplanned’, an error occurs. You
cannot change the status of a patient encounter from ʻactual’ to ʻplanned’.

If general errors occur when you attempt to execute this operation, check that you are supplying the correct actionCode
and other mandatory information.

If you execute this operation with a patient encounter start date/time that is in the future, but with status ʻactual’, an
error occurs. Change the start date/time or the status as appropriate.

If you try to cancel a surgery that has dependent data, an error occurs. Cancel the dependent data either before
cancelling the surgery, or during the same call.

The Maintain Surgery based on Patient Encounter Record Surgery Noti cation operation supports Forward Error Handling
(FEH). The following error category is used:

PRE: Processing Error

Message Types
PatientEncounterRecordERPSurgeryNoti cation

This is custom documentation. For more information, please visit the SAP Help Portal 76
 6/6/2023

Notes on SAP Implementation

This operation creates, updates and cancels movements of the type ʻsurgery’ in the backend. You can access a surgery that was
created with this operation through the transactions NP36 or NP37 by providing the patient number and case number.
Conversely, you can use this operation to update or cancel a surgery that was created through these transactions.

Con guration

You have maintained Business Object Identi cation for the patient encounter, medical diagnosis, medical procedure,
medical activity, and billing patient encounter group in Customizing for SAP Healthcare – Industry-Speci c Components
for Hospitals under Communication Preparation for Service Enabling Inbound Processing Maintain Validation
Parameters Maintain Business Object Identi cation .For more information, see Scheme Attributes at IDs and Codes
.

You have maintained general Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under
Communication Preparation for Service Enabling . For more information about speci c Customizing for each of the
business objects that form the nodes of the Patient Encounter Record transformed business object, see the relevant
business object documentation.

Enhancements

The BAdI ISH_SE_CL_ISH_PER_SURY_NO is available for this operation. You can use this BAdI as an interface to enhance this
operation as required (for example, to access and maintain new elds in the service interface).

More Information
For information about the MDT of this operation, see SAP Note 1461660 .

Patient Financials

De nition
This component ensures a comprehensive view of the nancial aspects (costs and revenues) of patients treated and supports
all necessary data processing steps. In addition, this EPC acts as an intermediate component to Financials, Accounting and
Analytics.

Technical Data

Entity Type Process Component

Software Component Version ESM ERP 606

Technical Name PatientFinancials

Namespace http://sap.com/xi/ESM/ERP

Business Context and Use

The Patient Financials process component ensures a comprehensive view of the nancial aspects (costs and revenues) of
patients treated, and supports all necessary data processing steps. In addition, it acts as an intermediate component to
Financials, Accounting and Analytics.

This is custom documentation. For more information, please visit the SAP Help Portal 77
 6/6/2023
This process component offers the Medical Activity and Billing Patient Encounter Group business objects. The Medical
Activity business object documents real-world medical treatments, while the Billing Patient Encounter Group business object
groups a set of patient encounters ( Patient Encounter business object).

Related Process Components

The Healthcare Business Partner Data Management process component manages patient details.

The Patient Encounter Management process component manages patient encounters.

Billing Patient Encounter Group

De nition
A Billing Encounter Group is a set of patient encounters grouped together following the legal requirements of a speci c context
(e.g. country) with the aim of creating bills.

Technical Data

Entity Type Business Object

Software Component Version ESM ERP 606

Technical Name BillingPatientEncounterGroup

Object Category Business Process Object

Business Context and Use

Overview

The Billing Patient Encounter Group business object is a set of patient encounters ( Patient Encounter business object). A
patient encounter represents a single patient ( Patient business object) contact with the healthcare system, and represents
the most granular level of grouping of medical activities ( Medical Activity business object) that can be treated as a whole.

Use Case

For nancial reporting, a hospital controller needs to calculate the accrued revenues of a patient currently in treatment. The
system calls the Calculate Accrual service operation to calculate the accrued revenue of the billing patient encounter group (
Billing Patient Encounter Group business object) associated with the patient ( Patient business object). With the accrued
revenues provided, the hospital controller can supply accurate gures for the nancial report.

Notes on SAP Implementation

Billing patient encounter group maps to the SAP Patient Management concept case

Medical activity maps to the SAP Patient Management concept performed service

Billing Patient Encounter Group Action In

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 78
 6/6/2023

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Billing Patient Encounter Group Action In inbound service interface contains an operation that calculates the accrued
revenue of a billing patient encounter group.

Calculate Accrual

De nition
To calculate the accrued revenue of a billing patient encounter group.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name BillingPatientEncounterGroupERPAccrualCalculateQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_BPEGACCRCALCTQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

If necessary, the accrued revenue for a billing patient encounter group can be calculated without billing the patient. The accrued
revenue can be calculated up to the current date, or to a date speci ed by the consumer. The Calculate Accrual inbound
operation provides the expected revenue for the non-billed medical activities of the given billing patient encounter group.

Features
This synchronous inbound operation calculates the accrued revenue for a given billing patient encounter group for a given
moment in time. The amount of money represented by accruals is itemized on the medical activity level.

This is custom documentation. For more information, please visit the SAP Help Portal 79
 6/6/2023
A test billing run is initiated for the selected billing patient encounter group, either until the present date (determined by the
current date in the back-end system) or until a date speci ed by the consumer. Neither the insurance coverage nor the
assignment of a contract scheme is required for this test billing. If such coverage exists, the system simply uses the insurance
provider with the highest rank for the calculation of the accruals.

To calculate the accrued revenue, the following information is required:

The identi er of the billing patient encounter group (BillingPatientEncounterGroupID element)

The identi er of the hospital (HospitalPartyID element)

The following information is optional:

The date to which the accrual value is to be calculated (AccrualValueCalculationReferenceDate element)

The operation returns the accrued revenue for the speci ed billing patient encounter group.

Message Types
BillingPatientEncounterGroupERPAccrualCalculateQuery_sync

BillingPatientEncounterGroupERPAccrualCalculateResponse_sync

Prerequisites
An instance of the Billing Patient Encounter Group business object must exist in the system.

A billable medical activity must be assigned to the billing patient encounter group.

Constraints
For the two response elements MedicalActivityStartTime and MedicalActivityEndTime elements, the representation within the
response of the service operation can be slightly different from the representation in the SAP Patient Management back-end
system. This deviation occurs in the following scenarios classi ed by the corresponding element:

MedicalActivityStartTimeIn the back-end system, the end of a day is described by the time stamp 24:00:00. This time
cannot be represented in XML format, however, this is technically represented by 00:00:00 the following day. The
corresponding MedicalActivityStartDate is therefore increased by one (for example, 24:00:00 on 20.02.2008 becomes
00:00:00 on 21.02.2008).

MedicalActivityEndTimeIn the back-end system, the end of a day is described by the time stamp 24:00:00. This time
cannot be represented in XML format, however, this is technically represented by 00:00:00 the following day. The
corresponding MedicalActivityEndDate is therefore increased by one (as above), with one exception: 31.12.9999 remains
as is. In this case, 24:00:00 is converted to 23:59:59.

Medical Activity

De nition
A Medical Activity is a provided service product for medical purposes. It includes simple and complex administrative and billing-
relevant tasks.

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 80
 6/6/2023

Entity Type Business Object

Software Component Version ESM ERP 606

Technical Name MedicalActivity

Object Category Business Process Object

Business Context and Use

Overview

The Medical Activity business object is used to document the real-world medical treatments rendered (for example, x-rays
and blood tests) and administrative tasks (for example, single room surcharges and telephone fees). Medical activities are
assigned to a patient encounter (Patient Encounter business object), which in turn is assigned to a billing patient encounter
group (Billing Patient Encounter Group business object). Medical activities are documented for the purpose of billing and cost
controlling.

An instance of the Medical Activity business object is uniquely identi ed in the system through an identi er,
the MedicalActivityID.

The Medical Activity business object is contained under the Patient Financials process component. This process
component provides service operations to maintain, search for, and view the details of medical activities.

Use Case

A nurse wants to check the medical activities associated with a patient. The system calls the Find Medical Activity by Elements
service operation to display a list of all instances of the Medical Activity business object associated with the patient (through
the patient encounter and billing patient encounter group). Next, the nurse wants to view one of the medical activities in
detail. For this, the system calls the Read Medical Activity service operation to nd all detailed information on that medical
activity. Finally, the nurse wants to change the existing medical activity and add a new one. The system calls the Maintain
Medical Activity service operation to change the existing instance of the Medical Activity business object, and add a new one
to the patient encounter.

Notes on SAP Implementation

Terminology

Billing patient encounter group maps to the SAP Patient Management concept case

HospitalParty maps to the SAP Patient Management concept institution

Medical activity maps to the SAP Patient Management concept performed service

Service Master: You must enter the medical activities you wish to provide into the Service Master (in the SAP Patient
Management system) before you can assign them to a patient encounter using the Maintain Medical Activity service
operation.)

Customizing: The following Customizing settings must be maintained:

Customizing for code values in SAP Healthcare - Industry-Speci c Components for Hospitals under Communication -
> Preparation for Service Enabling -> Inbound Processing -> Assign GDTs to Customizing Data -> Medical Service
Performed -> Assign Service Assignments ( eld ServiceProductAssignmentTypeCode ).

Customizing for Supplementary Components (SCs) in SAP Healthcare - Industry-speci c Components for Hospitals
under Communication -> Preparation for Service Enabling -> Inbound Processing -> Maintain Validation Parameters ->

This is custom documentation. For more information, please visit the SAP Help Portal 81
 6/6/2023
Maintain Business Object Identi cation. For more information on SCs, see Scheme Attributes at IDs and Codes.

Manage Medical Activity In

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Manage Medical Activity In inbound service interface groups operations that query or request to, and receive response or
con rmation from, the Patient Financials process component to maintain or read the details of a medical activity.

Maintain Medical Activity

De nition
To collectively maintain a set of medical activities for a patient encounter.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name CollectiveMedicalActivityERPRequestCon rmation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_CollectiveMedlActyRC

Category A2X

Direction inbound

Mode synchronous

Idempotency yes

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

This is custom documentation. For more information, please visit the SAP Help Portal 82
 6/6/2023
This inbound operation is used to manage a set of medical activities. It can create new instances of the Medical Activity
business object and change or cancel existing ones at one time, to ensure the consistency of the whole set.

Related Operations

The Find Medical Activity by Elements operation is used to search for a medical activity.

The Read Medical Activity operation is used to read the details of a medical activity.

Features
This synchronous inbound operation is a 'modify multiple' operation. It maintains a set of medical activities collectively, either
creating, changing or cancelling (depending on the action speci ed for each). If one requested change fails, the whole set of
requested changes is discarded. Either all changes are made, or none are.

This operation can be performed exactly once for a given set of input data. For information on Exactly Once (Idempotent)
behavior, see Idempotent Service .

The following information is required to create a medical activity in the set.

One (or all) of the following:

The identi er of the patient (PatientID element)

The identi er of the billing patient encounter group (BillingPatientEncounterGroupID element)

The identi er of the patient encounter (PatientEncounterID element)

Both of the following:

The medical activity which is to be created (PublishedMedicalServiceCatalogueItemID element)

The catalog in which details of this medical activity are stored (PublishedMedicalServiceCatalogueID element)

Additonally, provide values for any elements that are to be created in the CollectiveMedicalActivity node, and specify the
'Create' actionCode ('01').

If the BillingPatientEncounterGroupID and/or PatientID are provided (but not the PatientEncounterID), the system
automatically determines the patient encounter to which the medical activity will be assigned. This is determined by the
start/end date and time proved. If no start/end date and times are provided, the operation returns an error.

If the PatientEncountertID is provided, the medical activity is created for that patient encounter.

Do not provide a value for the MedicalActivityID element when creating a medical activity.

The following information is required to change a medical activity in the set:

The identi er of the medical activity (MedicalActivityID element)

Additionally, provide values for any elements that are to be maintained in the CollectiveMedicalActivity node, and specify the
'Insert Update' actionCode ('02').

To cancel a medical activity in the set:

Provide the identi er of the medical activity (MedicalActivityID element)

Specify the 'Cancel' actionCode ('03')

This is custom documentation. For more information, please visit the SAP Help Portal 83
 6/6/2023

Message Types
CollectiveMedicalActivityERPCon rmation_sync

CollectiveMedicalActivityERPRequest_sync

Prerequisites
An instance of the Patient Encounter business object must exist for an instance of the Billing Patient Encounter Group business
object in the system.

Constraints
Unit Code and decimal values are not supported for the ServiceProductQuantity element.

More Information
For information about the Change/Update Behavior of this service operation, see Change / Update Behavior Type 3.

Read Medical Activity

De nition
To read the detailed information of an instance of the Medical Activity business object.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalActivityERPByIDQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_MedlActyERPByIDQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

This is custom documentation. For more information, please visit the SAP Help Portal 84
 6/6/2023
The Read Medical Activity inbound operation returns the details of a single medical activity ( Medical Activity business object).

Related Operations

The Find Medical Activity by Elements operation is used to search for instances of the Medical Activity business object by
element values.

The Maintain Medical Activity operation is used to maintain instances of the Medical Activity business object.

Features
This synchronous inbound operation returns the details of an instance of the Medical Activity business object speci ed by its
identi er (MedicalActivityID). This identi er can be found using the Find Medical Activity by Elements operation.

To read a medical activity, the following information is required:

The internal or external identi er of the medical activity (MedicalActivityID or MedicalActivityAlternativeID elements)

Message Types
MedicalActivityERPByIDQuery_sync

MedicalActivityERPByIDResponse_sync

Prerequisites
The instance of the Medical Activity business object must exist in the system.

Medical Activity In

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction inbound

Business Context and Use

The Medical Activity In inbound service interface contains an opertaion to maintain medical activities based on noti cation from
connected systems.

Maintain Medical Activity based on Medical Activity Collection

Noti cation

De nition
To nd a list of instances of the Medical Activity business object, using element values as the search criteria.

This is custom documentation. For more information, please visit the SAP Help Portal 85
 6/6/2023

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalActivityERPCollectionNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_MDCLACTYCOLLNNO

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

This operation is used whenever performed medical activities are documented in a third-party system, and this information
must be transmitted to SAP Patient Management for billing purposes. In contrast to the Maintain Medical ActivityMaintain
Medical Activity operation, this operation is asynchronous (no con rmation message is returned).

For example: In a third-party system, an employee creates a new medical activity, updates several existing ones, and cancels
another, across several billing patient encounter groups or hospital wards. When noti ed by the third-party system, the
Maintain Medical Activity based on Medical Activity Collection Noti cation operation carries out the maintenance of each
medical activity (Medical ActivityMedical Activity business object) for the billing patient encounter groups (Billing Patient
Encounter GroupBilling Patient Encounter Group business object) or hospital wards (cost center determining parties).

Related Operations

The Maintain Medical ActivityMaintain Medical Activity operation can also be used to maintain medical activities
synchronously (that is, a con rmation message is returned).

The Read Medical ActivityRead Medical Activity operation can be used to view the details of a medical activity.

The Find Medical Activity by ElementsFind Medical Activity by Elements operation can be used to search for medical
activities by attributes.

Features
This asynchronous inbound operation handles the creation, updating, and cancellation of a group of medical activities (Medical
ActivityMedical Activity business object) for multiple billing patient encounter groups (Billing Patient Encounter GroupBilling
Patient Encounter Group business object) or cost center determining parties.

You might want to maintain medical activities for cost center determining parties in situations where an activity has been
performed on all patients in a single hospital ward (that is, a single organizational unit). In this case, the organizational unit is
billed for the performed medical activities and can then, for example, absorb the cost itself or pass the billing on to patients at a
later stage.

This is custom documentation. For more information, please visit the SAP Help Portal 86
 6/6/2023
The mandatory input for using this operation in various scenarios is listed below. You can also supply additional information for
any elements that are not mandatory, if required. Any combination of the actions below can be used for any group of medical
activities (for example, you can create one, update another, and cancel a third during the same call of this operation).

Maintaining an activity for a billing patient encounter group:

Create medical activity (for a billing patient encounter group)

The ID of the billing patient encounter group of the patient ( root node BillingPatientEncounterGroupID
element )

The ID of the hospital in which the patient is being treated ( HospitalParty node ID element )

The catalog and catalog item for this medical activity ( root node PublishedMedicalServiceCatalogueID and
PublishedMedicalServiceCatalogueItemID elements )

actionCode 01 (Create)

Update medical activity

The ID of the medical activity which is to be updated ( root node ID element ).You can nd the ID of a medical
activity using the Find Medical Activity by ElementsFind Medical Activity by Elements operation.

actionCode 02 (Update)

New data for any elements that are to be updated

Create a relationship between medical activities

Create a medical activity as described above, including a value for the SenderTechnicalID element in the root
node

Create another medical activity, and supply the SenderTechnicalID of the rst activity in the
MedicalActivitySenderTechnicalID element in the Relationship node

You can also use this method to create a relationship between two existing medical activities when updating
them

Cancel medical activity

The ID of the medical activity which is to be cancelled ( root node ID element )

actionCode 03 (Cancel)

Maintaining an activity for a cost center determining party:

Create medical activity

The ID of the organizational unit ( CostCentreDeterminingParty node ID element )

Do not supply a value for the BillingPatientEncounterGroupID, PatientID or PatientEncounterID elements.

The ID of the hospital in which the patient is being treated ( HospitalParty node ID element )

The catalog and catalog item for this medical activity ( root node PublishedMedicalServiceCatalogueID and
PublishedMedicalServiceCatalogueItemID elements )

actionCode 01 (Create)

Update medical activity

The ID of the medical activity which is to be updated ( root node ID element )

This is custom documentation. For more information, please visit the SAP Help Portal 87
 6/6/2023
The ID of the hospital in which the patient is being treated ( HospitalParty node ID element )

actionCode 02 (Update)

New data for any elements that are to be updated

Create a relationship between medical activities

Create a medical activity as described above, including a value for the SenderTechnicalID element in the root
node

Create another medical activity, and supply the SenderTechnicalID of the rst activity in the
MedicalActivitySenderTechnicalID element in the Relationship node

You can also use this method to create a relationship between two existing medical activities when updating
them.

Cancel medical activity

The ID of the medical activity which is to be cancelled ( root node ID element )

The ID of the hospital in which the patient is being treated ( HospitalParty node ID element )

actionCode 03 (Cancel)

Cancel medical activity

The ID of the medical activity which is to be cancelled ( root node ID element )

actionCode 03 (Cancel)

Note: The following elements and nodes are not relevant when maintaining medical activities for cost center determining
parties:

SenderTechnicalID

MedicalAnalysisPerformanceTypeCode

CostObjectIndicator

PublishedMedicalServiceCatalogueID

ServiceAssignmentTypeCode

AccountRelevanceIndicator

ChargeAmount

ChargeValue

PriceMultiplicationFactor

MedicalActivityChargeClassi cationKey

Relationship node

Party node

Error Handling
If an error about an invalid input value occurs, check that you have used the correct value for the medical activity ID,
billing patient encounter group ID, catalog, or catalog item ID.

This is custom documentation. For more information, please visit the SAP Help Portal 88
 6/6/2023
If you supply contradictory input data, such as attempting to update a medical activity which does not exist or is not
assigned to the speci ed patient, or cancelling a medical activity for a billing patient encounter group that does not have
any assigned medical activities, an error occurs. Check your input data and that you have supplied the correct action
code.

If you attempt to maintain medical activities for both a billing patient encounter group and a cost center determining
party in one execution, an error occurs. You can only maintain medical activities for either billing patient encounter
groups or cost center determining parties at one time.

The Maintain Medical ActivityMaintain Medical Activity supports Forward Error Handling (FEH). The following error category is
used:

PRE: Processing Error

Message Types
MedicalActivityERPCollectionNoti cation

Constraints
You can use this operation to maintain multiple medical activities for either multiple billing patient encounter groups or multiple
cost center determining parties, but not both during the same call.

Notes on SAP Implementation

As this operation is asynchronous, no con rmation is returned. You can view the results of this operation in the back-end in the
table NLEI. You can also use Maintain Services (transaction code NL10N) to view the maintained medical activity for a case
(billing patient encounter group), or Maintain OU-Related Service Entry (transaction code NL04N) for an organizational unit
(cost center determining party).

The ID of a medical activity can be found in the backend table NLEI, eld NRLS.

More Information
For information about the MDT of this operation, see SAP Note 1461673 .

Query Medical Activity In

Technical Data

Entity Type Service Interface

Category A2X

Direction inbound

Business Context and Use

The Query Medical Activity In inbound service interface contains an operation that queries to, and receives a response from,
the Patient Financials process component for a list of medical activities.

This is custom documentation. For more information, please visit the SAP Help Portal 89
 6/6/2023

Find Medical Activity by Elements

De nition
To nd a list of instances of the Medical Activity business object, using element values as the search criteria.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalActivityERPBasicDataByElementsQueryResponse_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_MedlActyBscDtByEleQR

Category A2X

Direction inbound

Mode synchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled true

Business Context and Use

This operation can be used to nd, for example, new medical activities that a patient has received, or to nd a particular
MedicalActivityID to use as input for the Read Medical Activity operation. This inbound operation returns a list of medical
activities ( Medical Activity business object) that exist for the patient encounters of a given billing patient encounter group (
Billing Patient Encounter Group business object).

Related Operations

The Read Medical Activity service operation is used to display the details of a medical activity.

The Maintain Medical Activity service operation is used to maintain instances of the Medical Activity business object.

Features
This synchronous inbound operation searches for a list of medical activities for the speci ed billing patient encounter
group under a HospitalParty. It returns this list with basic data for each instance of the Medical Activity business object found.

To search for a list of medical activities, the following information is required:

The identi er of the billing patient encounter group (BillingPatientEncounterGroupID element)

The identi er of the hospital under which the billing patient encounter group exists (HospitalPartyID element)

This is custom documentation. For more information, please visit the SAP Help Portal 90
 6/6/2023
Other information can be provided as optional input, such as:

The department which requested the medical activity (DepartmentalRequestorParty element)

The person who performed the medical activity (ServicePerformerParty element)

Message Types
MedicalActivityERPBasicDataByElementsQuery_sync

MedicalActivityERPBasicDataByElementsResponse_sync

Prerequisites
The instance of the Billing Patient Encounter Group business object must exist in the system.

Medical Documentation Management

De nition
This process component supports the classi cation of patients' sicknesses and coding of surgical and therapeutical
interventions or other preventive and diagnostic procedures. It also supports the management of the availability of patient
records and their assignment to patients through the business object medical record folder.

Technical Data

Entity Type Process Component

Software Component Version ESM ERP 606

Technical Name MedicalDocumentationManagement

Namespace http://sap.com/xi/ESM/ERP

Business Context and Use

The Medical Documentation Management process component facilitates the treatment of patients by supporting the
classi cation of illnesses (diagnoses) and the coding of surgical and therapeutical interventions. The Medical Diagnosis business
object and related operations are used to manage diagnoses. Medical diagnoses are also used as part of the Patient Encounter
Record transformed business object, which is part of the Patient Encounter Management process component.

This process component also allows the organization and tracking of patient records with the Medical Record Folder business
object, which is used as a container in which to store medical records relating to a patient.

Medical Diagnosis

De nition
An identi cation and designation of an illness.

This is custom documentation. For more information, please visit the SAP Help Portal 91
 6/6/2023

Technical Data

Entity Type Business Object

Software Component Version ESM ERP 606

Technical Name MedicalDiagnosis

Object Category Business Process Object

Business Context and Use

The Medical Diagnosis business object is used to access and manage medical diagnoses for patients. Diagnoses can be
associated with patients on the billing patient encounter group ( Billing Patient Encounter Group business object) level and on
the patient encounter ( Patient Encounter business object) level Medical diagnoses can be created either directly (as free-
texts) or in encoded form (by referring to a previously-de ned catalog of diagnoses). Some use cases in which a medical
diagnosis might be used are listed below.

Use cases

1. During his examination of a patient, a physician documents the diagnoses he makes. A subset of these diagnoses is
relevant for billing and must be communicated to the insurance provider. These diagnoses are sent asynchronously from
the Clinical System to SAP Patient Management using the Maintain Medical Diagnosis based on Medical Diagnosis
Collection Noti cation operation.

2. During a surgery, the surgical team documents a set of medical parameters for the surgery ( Patient Encounter business
object). These parameters include diagnoses ( Medical Diagnosis business object), medical activities ( Medical Activity
business object), and medical procedures (see the Patient Encounter Record business object). Once the surgery is
completed and documented, SAP Patient Management receives information about the surgery from the Operating
Room system through the Maintain Surgery based on Patient Encounter Record Surgery Noti cation operation of
the Patient Encounter Record business object.

3. When a patient is admitted to a hospital, a set of data (such as admission date and time, referring doctor, and referral
diagnosis) is documented in SAP Patient Management. For further patient treatment and documentation by subsystems
(such as lab systems and clinical systems), this information is sent with the HL7 message A01. The basis for this HL7
message is the Inform of Patient Encounter Record operation, which covers such business objects as the Patient
Encounter and Medical Diagnosis.

Related Business Objects

Billing Patient Encounter Group

Patient Encounter

Patient Encounter Record

Related Business Objects

Billing Patient Encounter Group

Patient Encounter

Patient Encounter Record

Features

This is custom documentation. For more information, please visit the SAP Help Portal 92
 6/6/2023
This business object allows you to document both free-text and encoded diagnoses. The name of free-text diagnoses is stored in
the Name element. Encoded diagnoses can be represented by different catalogs with different functions (for example, the rst
catalog could be used for billing). Up to three coding catalogs are supported for a diagnosis:

1 (First) For an encoded diagnosis, at least one catalog must be speci ed.

2 (Second) A second catalog can be speci ed if required.

3 (Reference) This catalog is only intended for informational purposes, and is evaluated automatically by the system. You
cannot supply a value for a reference catalog.

This business object is also designed to allow the linking of diagnoses. An example of this linking is the Kreuz-Stern (Dagger-
Asterisk) relationships of the German extension to the ICD-10 coding system (ICD-10-GM). SAP Patient Management supports
two types of diagnoses for the country versions Germany and Austria:

Primary (etiology) A primary diagnosis are the diagnosis of the cause of a medical condition

Secondary (manifestation) A secondary diagnosis is the diagnosis of the signs or symptoms of a medical condition

Primary diagnoses are represented by the + (dagger) symbol, and secondary diagnoses are represented by the * (asterisk)
symbol.The type of diagnosis is speci ed in the MedicalDiagnosisICDClassi cationCode element.

The message structure of this business object contains the following nodes:

Medical DiagnosisThe root node contains overall information about the diagnosis, such as the billing patient encounter
group it is assigned to, start date and time, category, and so on. It also contains the Name element, which is used for
free-text diagnoses.

NoteContains additional information about the diagnosis.

CatalogueReferenceContains information about the encoding of the diagnosis (for encoded diagnoses).

NetRelationshipContains information about the relationship with other diagnoses (for a linked diagnosis).

HospitalPartyContains information about the hospital in which the patient is being treated.

DiagnosingPartyContains information about the physician who made the diagnosis.

DepartmentalUnitPartyContains information about the organizational unit of the patient (for example, the ward
in which the patient is being treated).

Identi cationAllows speci cation and handling of procedures through alternative external IDs (for example, from
third-party systems).

You can maintain medical diagnoses using either the internal ID (root node -> ID element) or an external ID (Identi cation node
-> AlternativeID element).

Constraints
It is not possible to create a diagnosis for a patient ( Patient business object).

Notes on SAP Implementation

Medical diagnoses are uniquely identi ed by a 17 character ID that is formed by a concatenation of 4 characters of the
HospitalPartyID, 10 characters of the BillingPatientEncounterGroupID, and 3 characters of the
MedicalDiagnosisSequenceNumber. A medical diagnosis can also be identi ed by its external ID (AlternativeID element).

This is custom documentation. For more information, please visit the SAP Help Portal 93
 6/6/2023
To use encoded diagnoses, you must de ne the catalog and items within it. Make these settings in the following Customizing
activities:

Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Hospital Basic Data Catalogs
Diagnoses De ne Catalog Categories

Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Hospital Basic Data Catalogs
Diagnoses Maintain Codes

For some elements of this business object (such as the DiagnosticSupplementCode, DiagnosticCertaintyCode, and
AnatomicalLocationCode), Customizing is necessary to map external to internal data. Make these settings in:

Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication Preparation
Service-Enabling Inbound Processing Assign GDTs to Customizing Data Diagnoses .

If you want to transmit or receive alternative identi cation for medical diagnoses, you must maintain the business object
identi cation. For more information, see Scheme Attributes at IDs and Codes . Make these settings in:

Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Communication Preparation
for Service Enabling Inbound Processing Maintain Validation Parameters Maintain Business Object Identi cation
.

More Information
This business object is also used by the Patient Encounter Record transformed object, where it is contained as one node
of the overall structure, and the Inform of Patient Encounter Record and Maintain Surgery based on Patient Encounter
Record Surgery Noti cation operations.

For more information about con guring Healthcare service operations, see SAP Note 1461621 .

Medical Diagnosis In

De nition
An interface to notify of any changes to Medical Diagnosis in Medical Documentation Management

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction inbound

Business Context and Use

The Maintain Medical Diagnosis based on Medical Diagnosis Collection Noti cation inbound service interface contains an
operation to maintain a medical diagnosis based on noti cation from a connected system.

Maintain Medical Diagnosis based on Medical Diagnosis

Collection Noti cation
This is custom documentation. For more information, please visit the SAP Help Portal 94
 6/6/2023

De nition
To maintain multiple medical diagnoses based on noti cation from a third-party system.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalDiagnosisERPCollectionNoti cation_In

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Web Service De nition (Back End) ISH_MEDDIAGERPCOLLNNO

Category SAP A2A

Direction inbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Features
This asynchronous inbound operation handles the creation, updating, and cancellation of multiple medical diagnoses ( Medical
Diagnosis business object) at one time. It can be executed for a billing patient encounter group ( Billing Patient Encounter
Group business object) or patient encounter ( Patient Encounter business object), and also allows you to link multiple diagnoses
within a billing patient encounter group (BPEG) or patient encounter.

The ID of an existing medical diagnosis can be found in the outbound message of the Inform of Patient Encounter Record
operation. The format of the medical diagnosis ID is a concatenation of 4 characters of a HospitalPartyID, 10 characters of a
BillingPatientEncounterGroupID and 3 characters of a MedicalDiagnosisSequenceNumber.

Note: Where values for ID elements are required (for example, PatientEncounterID), you can also use external IDs by entering
them in the respective elements.

The mandatory input data for using this operation in various scenarios is listed below.

To create a diagnosis:

The level on which the diagnosis is to be created

To create the diagnosis on the billing patient encounter group level, supply the ID of the billing patient
encounter group ( MedicalDiagnosis node -> BillingPatientEncounterGroupID)

To create the diagnosis on the patient encounter level, supply the ID of the patient encounter (
MedicalDiagnosis node -> PatientEncounterID)

You can also create the diagnosis on the encounter level without the encounter ID, by supplying the ID of
the billing patient encounter group and the start date/time of the encounter ( MedicalDiagnosis node ->

This is custom documentation. For more information, please visit the SAP Help Portal 95
 6/6/2023
PatientEncounterStartDate, PatientEncounterStartTime).Note: You can provide either the start date or
both the start date and start time, but not the start time only.

The institution ( MedicalDiagnosis node -> HospitalPartyID)

One of the following, as appropriate

The coded diagnosis and the catalog where the code is de ned (CatalogueReference node):

The coding catalog in which the diagnosis is de ned (MedicalDiagnosisCatalogueID element)For

example, 09 for ICD-10 v2009.

The diagnosis code, in the context of the catalog (MedicalDiagnosisCatalogueItemID element)For

example, J18.9 for Pneumonia.

The assignment to a catalog type in SAP Patient Management (MedicalDiagnosisCatalogueCode

element)Values can be 1, 2 and 3, for rst, second and reference catalogs.

A free-text for a diagnosis that is not maintained in a catalog ( MedicalDiagnosis node -> Name)

The category of medical diagnosis ( MedicalDiagnosis node -> MedicalDiagnosisCategoryCode)Values can be 1

(Referral ) or 2 (Treatment). If no value is speci ed, the default is 2.

actionCode 01 (Create)

Values for any other elements (if necessary)Note: if you do not specify a value for the
MedicalDiagnosisICDClassi cationCode element, the system sets it based on the default value in the catalog.

To change a diagnosis:

The ID of the medical diagnosis (MedicalDiagnosis node -> ID)

actionCode 02 (Update)

New values for the elements which are to be changed

To link diagnoses:

Create one diagnosis with the following input:

The ID of the billing patient encounter group (MedicalDiagnosis node -> BillingPatientEncounterGroupID
element)

The ID of the patient encounter (MedicalDiagnosis node -> PatientEncounterID element)

The coded diagnosis and the catalog where the code is de ned (CatalogueReference node):

The coding catalog in which the diagnosis is de ned (MedicalDiagnosisCatalogueID element)For

example, 09 for ICD-10 v2009.

The diagnosis code, in the context of the catalog (MedicalDiagnosisCatalogueItemID element)For

example, J18.9 for Pneumonia.

The assignment to a catalog type in SAP Patient Management (MedicalDiagnosisCatalogueCode

element)Values can be 1, 2 and 3, for rst, second and reference catalogs.

actionCode 01 (Create)

ICD classi cation code + (dagger) (CatalogueReference node -> MedicalDiagnosisICDClassi cationCode
element)

The sender technical ID (NetRelationship node -> PrimaryMedicalDiagnosisSenderTechnicalID element)

Any other values

This is custom documentation. For more information, please visit the SAP Help Portal 96
 6/6/2023
Create another diagnosis with the following input:

The ID of the billing patient encounter group (MedicalDiagnosis node -> BillingPatientEncounterGroupID
element)

The ID of the patient encounter (MedicalDiagnosis node -> PatientEncounterID element)

The coded diagnosis and the catalog where the code is de ned (CatalogueReference node):

The coding catalog in which the diagnosis is de ned (MedicalDiagnosisCatalogueID element)For

example, 09 for ICD-10 v2009.

The diagnosis code, in the context of the catalog (MedicalDiagnosisCatalogueItemID element)For

example, J18.9 for Pneumonia.

The assignment to a catalog type in SAP Patient Management (MedicalDiagnosisCatalogueCode

element)Values can be 1, 2 and 3, for rst, second and reference catalogs.

actionCode 01 (Create)

ICD classi cation code * (asterisk) (CatalogueReference node -> MedicalDiagnosisICDClassi cationCode
element)

In the NetRelationship node, supply the PrimaryMedicalDiagnosisSenderTechnicalID of the rst

diagnosis.Note: to link a diagnosis to an existing diagnosis, supply the PrimaryMedicalDiagnosisID of the
existing diagnosis instead of the PrimaryMedicalDiagnosisSenderTechnicalID.

Any other values

Note: Free-text diagnoses cannot be linked.

An example set of input data for linking diagnoses is provided below, where the diagnosis H06.1 (the primary diagnosis) is linked
to diagnosis H10.1 (the secondary diagnosis). This is not a full set of input data, and the values provided are examples only.

Diagnosis1 BillingPatientEncounterGroupID: 0001111111 MedicalDiagnosisCatalogueID: 09 MedicalDiagnosisCatalogueItemID:

H06.1 HospitalPartyID: 0001 actionCode: 01 MedicalDiagnosisICDClassi cationCode: +
PrimaryMedicalDiagnosisSenderTechnicalID: 123456

Diagnosis2 BillingPatientEncounterGroupID: 0009999999 MedicalDiagnosisCatalogueID: 09

MedicalDiagnosisCatalogueItemID: H10.1 HospitalPartyID: 0001 actionCode: 01 MedicalDiagnosisICDClassi cationCode: *
PrimaryMedicalDiagnosisSenderTechnicalID: 123456

To cancel a diagnosis:

ID of the medical diagnosis (MedicalDiagnosis node -> ID element)

actionCode 03 (Cancel)

Error Handling
If an error about an invalid input value occurs, check that you have used the correct ID for the billing patient encounter
group, patient encounter, or diagnosis.

If an error about an invalid actionCode occurs, check that you have used the correct code (01 - Create, 02 - Change, or 03
- Cancel). Additionally, ensure you have used the correct billing patient encounter group (that is, that you haven't
speci ed the Cancel action code for a billing patient encounter group that has not been assigned a diagnosis).

If you maintain a diagnosis with the classi cation code * (asterisk), but do not assign it to another diagnosis (in the
NetRelationship node), an error occurs. All * diagnoses must be assigned to a + (dagger) diagnosis.

This is custom documentation. For more information, please visit the SAP Help Portal 97
 6/6/2023
If you cannot cancel a diagnosis, check the MedicalDiagnosisICDClassi cationCode. You cannot cancel a + diagnosis that
has been assigned a * diagnosis. To cancel linked diagnoses, either cancel both in the same execution of this operation,
or cancel the * diagnosis before cancelling the + diagnosis.

The Maintain Medical Diagnosis based on Medical Diagnosis Collection Noti cation operation supports Forward Error Handling
(FEH) The following error category is used:

PRE: Processing Error

Message Types
MedicalDiagnosisERPCollectionNoti cation

Constraints
It is not possible to create a diagnosis on patient level ( Patient business object).

Notes on SAP Implementation

The ID of a diagnosis can be found in the back-end table NDIA. For example, the table NDIA contains the following values:

EINRI: 0001 (Institution)

FALNR: 0005000007 (Case number)

LFDNR: 001 (Medical diagnosis sequence number)

The concatenation of these three values gives the diagnosis ID: 00010005000007001.

As mentioned in the mandatory input section, this operation can be used to create a diagnosis on the patient encounter level
without supplying the ID of the encounter. This is useful when systems that do not support the concept of encounters send
diagnoses to SAP Patient Management. These diagnoses are automatically attached to the correct encounter depending on
the form of documentation set for the given institution. The form of documentation is maintained in Customizing for SAP
Healthcare – Industry-Speci c Components for Hospitals under Medical/Nursing Documentation -> Set Parameters for
Diagnosis Documentation .

With the ID of the billing patient encounter group and the start date/time of the patient encounter supplied, the diagnosis is
created as follows:

Form of documentation 1 (Case-related per departmental stay and per outpatient visit)The diagnosis is created under
the patient encounter that matches the start date/time.

Form of documentation 2 (Case-related per department)The diagnosis is created under the patient encounter that
matches the start date/time.

Form of documentation 3 (For the complete case)The start date/time is ignored, and the diagnosis is created for the
billing patient encounter group, but technically attached to the most recent patient encounter.

Medical diagnoses created or modi ed with this operation are saved in the same database tables as diagnoses created or
modi ed through Maintain Diagnoses for Case/Department (transaction code NP61).

Con guration

If you want to create an encoded diagnosis, you must have maintained the catalogs and catalog items in the following
Customizing activities:

This is custom documentation. For more information, please visit the SAP Help Portal 98
 6/6/2023
Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Hospital Basic Data -> Catalogs ->
Diagnoses – De ne Catalog Categories

Customizing for SAP Healthcare - Industry-Speci c Components for Hospitals under Hospital Basic Data -> Catalogs ->
Diagnoses – Maintain Codes

Enhancements

The Business Add-In (BAdI) IS-H Medical Diagnosis (ISH_SE_CL_ISH_MDIAG_NO_AI) is available for this operation. This BAdI
can be used as an interface to enhance this operation (for example, to access and maintain new elds in the service interface).

Enhancements

The Business Add-In (BAdI) IS-H Medical Diagnosis (ISH_SE_CL_ISH_MDIAG_NO_AI) is available for this operation. This BAdI
can be used as an interface to enhance this operation (for example, to access and maintain new elds in the service interface).

More Information
For information about the MDT of this operation, see SAP Note 1461659.

Medical Record Folder

De nition
A container for storing clinical documents for a patient, typically managed within one hospital. It can consist of one or several
volumes that can be created and borrowed independently.

Technical Data

Entity Type Business Object

Software Component Version ESM ERP 606

Technical Name MedicalRecordFolder

Object Category Business Process Object

Business Context and Use

The Medical Record Folder business object allows the manipulation of the physical container in which patient-related records
are stored (for example, a binder or a jacket). The Medical Documentation Management process component supports the
organization of medical records within a hospital by managing the availability of medical records and their assignment to
patients. It also supports the borrowing of medical records and the creation of reminders for overdue borrowed records.

Use Cases

1. A patient is admitted to a hospital which he has never visited before. When he is admitted, a medical record folder is
automatically created to store all medical documents related to him (such as X-rays, lab results, and physician letters).

2. A physician participates in a clinical study to evaluate the effects of a special drug. As part of this, she borrows the
medical records of patients who have been administered the drug.

Features
This is custom documentation. For more information, please visit the SAP Help Portal 99
 6/6/2023
You can maintain multiple medical record folders for a patient, depending on your requirements (for example, one for lab
reports and another for X-ray results).This business object contains administrative data about the medical record folder, such
as the following:

Status (for example, borrowed or archived)

Borrowing information

Archiving location

External document number

The high-level nodes of this business object are as follows:

MedicalRecordFolderThe root node contains identifying, administrative, and technical information about the medical
record folder and the patient to whom it’s assigned.

DescriptionContains a description of the medical record folder.

HospitalPartyContains the identi er of the hospital in which the patient is being treated.

ArchivingPartyContains information about the organizational unit where the medical record folder is archived.

DocumentingPartyContains information about the organizational unit with responsibility for documenting the
medical record folder

DepartmentalPartyContains information about the organizational unit with responsibility for the patient

NursingPartyContains information about the nursing unit with responsibility for the patient

BorrowerPartyContains information about the party that has borrowed the medical record folder. This can be
either a person or a department.

PartyContains information about any other parties related to the medical record folder, such as a physician or an
organization

Identi cationAllows speci cation and handling of medical record folders through alternative external IDs (for
example, from third-party systems).

Constraints
Operations are not provided to create, edit, or manage the contents of medical records or other documentation types.

Notes on SAP Implementation

Con guration

You have made settings for code values in Customizing for SAP Healthcare – Industry-Speci c Components for Hospitals
under Communication -> Preparation for Service Enabling -> Inbound Processing -> Assign GDTs to Customizing Data ->
Medical Record -> Assign Document Types (Field Type Code) .

More Information
For more information about con guring Healthcare service operations, see SAP Note 1461621.

Medical Record Folder Event Out

This is custom documentation. For more information, please visit the SAP Help Portal 100
 6/6/2023

De nition
An interface to inform of the creation, change, cancellation, or changed status of medical record folders.

Technical Data

Entity Type Service Interface

Category SAP A2A

Direction outbound

Business Context and Use

The Medical Record Folder Event Out outbound service interface groups operations that sends information about medical
record folders to connected systems.

Inform of Medical Record Folder Cancellation

De nition
To inform third-party systems about a cancelled medical record folder.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalRecordFolderERPCancelledInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

An employee cancels a medical record folder. The Inform of Medical Record Folder Cancellation operation sends information
about the changed data of the medical record folder ( Medical Record Folder business object) to third-party systems.

Related Operations

This is custom documentation. For more information, please visit the SAP Help Portal 101
 6/6/2023
The Inform of Medical Record Folder Creation operation informs third-party systems about a created medical record
folder.

The Inform of Medical Record Folder Change operation informs third-party systems about a changed medical record
folder.

The Inform of Medical Record Folder Status Change operation informs third-party systems about the changed status of
a medical record folder.

Features
This asynchronous outbound operation informs third-party systems of the cancellation of a medical record folder ( Medical
Record Folder business object) from the Medical Documentation Management process component. This operation is triggered
when a medical record folder is cancelled. It sends information to third-party systems that a medical record folder has been
cancelled, allowing them to mirror the cancellation.

Message Types
MedicalRecordFolderERPCancelledInformation

Notes on SAP Implementation

This operation is triggered by the cancellation of a medical record folder in the backend (event MRSTO). When this event occurs,
the information is queued for dispatch as part of a regularly scheduled run.

In cases where two noti cations about the same medical record folder are queued, consolidation logic combines the two and
sends them as a single information message as follows:

If a medical record folder is created, and later cancelled, both events are ignored and connected systems receive no
information.

If a medical record folder is changed, and later cancelled, only the cancellation information is sent.

If a medical record folder has its status changed, and is later cancelled, only the cancellation information is sent.

Con guration

You have mapped the medical record folder type codes in Customizing for SAP Healthcare - Industry-Speci c Components for
Hospitals under Communication -> Preparation for Service Enabling -> Assign GDTs to Customizing Data -> Medical Record
Management .

More Information
For information about the MDT of this operation, see SAP Note 1461658.

Inform of Medical Record Folder Change

De nition
To inform third-party systems about a changed medical record folder.

Technical Data
This is custom documentation. For more information, please visit the SAP Help Portal 102
 6/6/2023

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalRecordFolderERPChangedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Direction outbound

Mode asynchronous

Idempotency not applicable

P2P Communication Enabled yes

Business Context and Use

An employee changes a medical record folder (for example, to change the organizational unit that is responsible for the folder).
The Inform of Medical Record Folder Change operation sends information about the changed data of the medical record folder
( Medical Record Folder business object) to third-party systems.

Related Operations

The Inform of Medical Record Folder Creation operation informs third-party systems about a created medical record
folder.

The Inform of Medical Record Folder Cancellation operation informs third-party systems about a cancelled medical
record folder.

The Inform of Medical Record Folder Status Change operation informs third-party systems about the changed status of a
medical record folder.

Features
This asynchronous outbound operation informs of the change of a medical record folder ( Medical Record Folder business
object) from the Medical Documentation Management process component. This operation is triggered when a medical record
folder is changed. It sends information to third-party systems that a medical record folder has been changed, allowing them to
mirror the changed data.

Message Types
Medical Record Folder ERP Changed Information

Notes on SAP Implementation

This operation is triggered by the changing of a medical record folder in the backend (event MRUPD). When this event occurs,
the information is queued for dispatch as part of a regularly scheduled run.

In cases where two noti cations about the same medical record folder are queued, consolidation logic combines the two and
sends them as a single information message as follows:

This is custom documentation. For more information, please visit the SAP Help Portal 103
 6/6/2023
If a medical record folder is created, and later changed, only the creation information is sent. However, this includes the
changed data.

If a medical record folder is changed, and later cancelled, only the cancellation information is sent.

Con guration

You have mapped the medical record folder type codes in Customizing for SAP Healthcare - Industry-Speci c Components for
Hospitals under Communication -> Preparation for Service Enabling -> Assign GDTs to Customizing Data -> Medical Record
Management .

More Information
For information about the MDT of this operation, see SAP Note 1461655.

Inform of Medical Record Folder Creation

De nition
To inform third-party systems about the creation of a medical record folder.

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalRecordFolderERPCreatedInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Application Component IS-H

Category SAP A2A

Direction outbound

Mode asynchronous

Idempotency not applicable

Change/Update Behavior not applicable

P2P Communication Enabled yes

Business Context and Use

An employee creates a new medical record folder (for example, to store documents relating to a new patient). The Inform of
Medical Record Folder Creation operation sends information about the new medical record folder ( Medical Record Folder
business object) to third-party systems.

Related Operations

This is custom documentation. For more information, please visit the SAP Help Portal 104
 6/6/2023
The Inform of Medical Record Folder Change operation informs third-party systems about a changed medical record
folder.

The Inform of Medical Record Folder Cancellation operation informs third-party systems about a cancelled medical
record folder.

The Inform of Medical Record Folder Status Change operation informs third-party systems about the changed status of
a medical record folder.

Features
This asynchronous outbound operation informs of the creation of a medical record folder ( Medical Record Folder business
object) from the Medical Documentation Management process component. This operation is triggered when a medical record
folder is created. It sends information to third-party systems that a new medical record folder has been created, allowing them
to mirror the new data.

Message Types
Medical Record Folder ERP Created Information

Notes on SAP Implementation

This operation is triggered by the creation of a medical record folder in the backend (event MRINS). When this event occurs, the
information is queued for dispatch as part of a regularly scheduled run.

In cases where two noti cations about the same medical record folder are queued, consolidation logic combines the two and
sends them as a single information message as follows:

If a medical record folder is created, and later changed, only the creation information is sent. However, this includes the
changed data.

If a medical record folder is created, and later cancelled, both events are ignored and connected systems receive no
information.

If a medical record folder is created, and later has its status changed, only the creation information is sent. However, the
changed status is incorporated into the creation information.

Con guration

You have mapped the medical record folder type codes in Customizing for SAP Healthcare - Industry-Speci c Components for
Hospitals under Communication -> Preparation for Service Enabling -> Assign GDTs to Customizing Data -> Medical Record
Management .

More Information
For information about the MDT of this operation, see SAP Note 1461654.

Inform of Medical Record Folder Status Change

De nition
To inform third-party systems about the changed status of a medical record folder.

This is custom documentation. For more information, please visit the SAP Help Portal 105
 6/6/2023

Technical Data

Entity Type Service Operation

Software Component Version IS-H 606

Release State released

Technical Name MedicalRecordFolderERPStatusChangeInformation_Out

Namespace http://sap.com/xi/IS-H/Global2

Direction outbound

Mode asynchronous

Idempotency no

Change/Update Behavior not applicable

P2P Communication Enabled no

Business Context and Use

A physician borrows a medical record folder (for example, to evaluate the results of administering a certain drug to patients).
The Inform of Medical Record Folder Status Change operation sends information to third-party systems that the status of the
medical record folder ( Medical Record Folder business object) has changed to 'borrowed'.

Related Operations

The Inform of Medical Record Folder Creation operation informs third-party systems about a created medical record
folder.

The Inform of Medical Record Folder Change operation informs third-party systems about a changed medical record
folder.

The Inform of Medical Record Folder Cancellation operation informs third-party systems about a cancelled medical
record folder.

Features
This asynchronous outbound operation informs of the changed status of a medical record folder ( Medical Record Folder
business object) from the Medical Documentation Management process component. This operation is triggered when the
status of a medical record folder is changed (for example, when the folder has been borrowed). It sends information to third-
party systems that the status of a medical record folder has been changed, allowing them to mirror the change.

Message Types
MedicalRecordFolderERPStatusChangedInformation

Notes on SAP Implementation

This operation is triggered by the changing status of a medical record folder in the backend. The following events are relevant:

MRBOR1 (Request for a medical record folder)

MRBOC (Deleted request for a medical record folder)

This is custom documentation. For more information, please visit the SAP Help Portal 106
 6/6/2023
MRBOR2 (Borrowing of a medical record folder)

MRBCK (Return of a borrowed medical record folder)

When any of these events occur, this information is queued for dispatch as part of a regularly scheduled run.

In cases where two noti cations about the same medical record folder are queued, consolidation logic combines the two and
sends them as a single information message as follows:

If a medical record folder is created and has its status changed in a single instance, only the information about the
creation is sent. However, this includes the changed status.

If a medical record folder is cancelled and has its status changed in a single instance, only the cancellation is sent.

Con guration

You have mapped the medical record folder type codes in Customizing for SAP Healthcare – Industry-Speci c Components for
Hospitals under Communication -> Preparation for Service Enabling -> Assign GDTs to Customizing Data -> Medical Record
Folder Management .

More Information
For information about the MDT of this operation, see SAP Note 1461656.

Medical Documentation Master Data

De nition
This component supports the handling of the medical master data catalogues required for medical documentation.

Technical Data

Entity Type Process Component

Software Component Version ESM ERP 606

Technical Name MedicalDocumentationMasterData

Namespace http://sap.com/xi/ESM/ERP

This is custom documentation. For more information, please visit the SAP Help Portal 107