Package org.emau.icmvc.ganimed.ttp.cm2

Interface GICSFhirService

public interface GICSFhirService

An interface for import and export of consent-templates using custom fhir formats for details read our publication.

Author:

bialkem

Method Summary

Modifier and Type	Method	Description
String	exportDefinition(String domainName, FhirExportMode exportMode, List<String> itemList, boolean exportLogo, String fileFormat)	export domain-, policy-, module- and template definitions for selected domain
ImportResultDTO	importDefinition(String definition, boolean allowUpdates, String fileFormat, boolean finalizeElements, String targetDomainName, boolean ignoreDomainConfig)	Import domain-, policy-, module- and template definitions
ImportResultDTO	previewImportDefinition(String definition, boolean allowUpdates, String fileFormat, boolean finalizeElements, String targetDomainName, boolean ignoreDomainConfig)	Import domain-, policy-, module- and template definitions

Method Details

importDefinition

ImportResultDTO importDefinition(String definition,
 boolean allowUpdates,
 String fileFormat,
 boolean finalizeElements,
 String targetDomainName,
 boolean ignoreDomainConfig)
                          throws InvalidExchangeFormatException,
InternalException

Import domain-, policy-, module- and template definitions

Parameters:

definition - content of definition to import

allowUpdates - true if existing definitions are allowed to be updated

fileFormat - format of definition (e.g. xml or json)

finalizeElements - bool to finalize all imports

targetDomainName - the name of the domain into which the data should be imported

ignoreDomainConfig - whether the domain configuration should be overwritten when importing into an existing domain

Returns:

Map with Lists of add, updated and ignored items.

Throws:

InvalidExchangeFormatException

InternalException

previewImportDefinition

ImportResultDTO previewImportDefinition(String definition,
 boolean allowUpdates,
 String fileFormat,
 boolean finalizeElements,
 String targetDomainName,
 boolean ignoreDomainConfig)
                                 throws InvalidExchangeFormatException,
InternalException

Import domain-, policy-, module- and template definitions

Parameters:

definition - content of definition to import

allowUpdates - true if existing definitions are allowed to be updated

fileFormat - format of definition (e.g. xml or json)

finalizeElements - bool to finalize all imports

targetDomainName - the name of the domain into which the data should be imported

ignoreDomainConfig - whether the domain configuration should be overwritten when importing into an existing domain

Returns:

Map with Lists of add, updated and ignored items.

Throws:

InvalidExchangeFormatException

InternalException

exportDefinition

String exportDefinition(String domainName,
 FhirExportMode exportMode,
 List<String> itemList,
 boolean exportLogo,
 String fileFormat)
                 throws InternalException,
InvalidExchangeFormatException

export domain-, policy-, module- and template definitions for selected domain

Parameters:

domainName - Name of selected domain

exportMode - mode of export: all, domain, policies, modules, templates, specify

itemList - specify items by key (domain, name, version) to be exported, processed only when ExportMode.SPECIFY is used

exportLogo - true, if export should contain base64 encoded domain logo if available

fileFormat - format of definition (e.g. xml or json)

Returns:

definition with export information

Throws:

UnknownDomainException

InternalException

InvalidExchangeFormatException