Function documentationExternal Data Modules

 

External data modules (EDMs) are used to integrate external data (data from other applications or other parts of the medical documentation) in parameterized documents. You can also use EDMs to save data that was entered in parameterized documents in other applications and to provide input help. For example, if you wish to include the patient's age in a field of your document (this value is known within the system - as part of the patient's master data), an appropriate external data module would allow you to refer to this field from the patient master in order to copy the content of the field into a field in your document.

An EDM is assigned to the documentation elements of a definite document category, in the abstract or definite design.

Note Note

External data modules are independent of the document category and can thus be re-used. However, they require separate master data management.

In comparison, user exits, which also enable the integration of external data modules, are dependent on the document category.

End of the note.

Source of External Data

EDMs can provide data from other parameterized documents or process such data, if the source is outside the parameterized documentation (fixed entities, external objects). This can be, for example, patient master data, case or request data, services, movement data, diagnoses, the current user or system data (e.g. system time, system date).

Integration of External Data

External data modules can be assigned to normal non-structured documentation elements, long text fields, normal structures and multiple structures. The type of elements or structures supplied by an external data module is one of its characteristic qualities.

External Data from Other Parameterized Documents

External data modules which provide data from other parameterized documents, can be created via a dialog function. From the SAP Easy Access screen you select Start of the navigation path Clinical System Next navigation step Basic Clinical Data Next navigation step Clinical Documentation Next navigation step External Data Module Next navigation step Document Definition Next navigation step Maintain End of the navigation path.

External Data from External Objects

External data modules which process data from external objects must be created and developed manually if they are not already available from another application context.

If an EDM is included to provide external data from external entities, for which an input screen for the fixed parameter for controlling the EDM was implemented using the function module PARAMSTR, a pushbutton will be activated during external data inclusion, when documentation elements and document element assignments are created and changed (definite design); you can use this pushbutton to toggle to the screen for entering fixed parameter values.

Formats and Semantics

For the smooth processing of external data, the formats of the data sources and the data destinations must be identical. When supplying simple and multiple structures, the target elements (name of the documentation elements, which should be integrated into external data supply) are predetermined by EDM semantics. In the case of external data modules that provide data from other parameterized documents, these are the names of the documentation elements of the source structure. In the case of external data modules which process data from fixed entities, these are the names which were agreed when creating the external data module.

Properties of External Data Modules

Reference

External data can be integrated as a reference or as a copy:

  • In maintenance (creating and updating, but not reproduction) referenced data always reflects the current status of the external document.

  • As default entries, unless it has been further updated in the current document, copied data reflects the historically correct status of the external data at the time the document was created. It is not automatically updated during later processing of the document.

  • If this field is selected, integration as a reference is desired. If it is not selected, the external data module is used for default entry.

Change

Select the Change field if an update module is also to be used for updating external data integration. Updating external data integration means that, when the data in the document currently being processed is saved, the relevant data is also saved or updated in the external data source. Updating external data integration is only available for those external data modules that allow the processing of the data of fixed external entities (objects).

Input Help

Select the Input Help field if the general selection help (input help) which is implemented for an external data module is to be used. In the case of input help functions for single or multiple structures, you must select the field for the structure and for the documentation elements.

Fixed Parameter

You can enter fixed parameters (already known at the time of parameterization) in the Fixed Parameters field as a character string. Possible values accepted by the EDM are preset by the module and can be found in its documentation. The values entered in the documentation element in the Fixed Parameters field have priority over those which were entered when creating the external data module.

New Search

If New Search is selected, a new search is carried out every time rather than using a result from the EDM memory which may already exist. For example, you should use the New Search field if two different references in the same entity should be referred to at different points in the document.

Reference Field

The name of the reference field that is to be created for the external data is stored in this field. A table field, in which references can be stored, is created under this name in the transparent table for table maintenance named under 'Database Table'. The name of the reference field may not be deleted, since the existence of a reference field is an essential requirement for the generation of the dialog application.

Note Note

Plausibility checks are carried out during the processing of an external data integration in the documentation element or in the definite design (DocElement assignment). The type of DocElement, the options for the external data integration and the characteristics of the external data module are included in the check.

End of the note.
Generation Processes

When you create the definite design, the system will firstly transfer the entries found for the relevant documentation elements, to the External Data Integration field group. In addition, for each documentation element which has an external data module assigned to it, the system will create the field name for a table field, where the reference key will be stored.

External data integration entries can be changed in the definite design.

When generating the dialog application with the Reference, Change, Input Help (F4) and New Search options, the system will generate corresponding program parts which activate these properties for the integrated EDM. For example, you provide input help for a specific documentation element, refresh the transferred external data in the change function, save the changed external data in the external entity or initiate a new external data search when you repeat the external data module call in a document. As a prerequisite, the external data module must actually be a reference, change or input help module.

Caution Caution

If you use Generator Version 2, you should refer to the deviations described in Generator Version 2.

End of the caution.