Index (api 0.21.0 API)

A B C D E F G H I J L N O P Q R S T U V X
All Classes All Packages

A

adminDelete(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Admin method to delete a Composition from the DB.
adminDelete(UUID) - Method in interface org.ehrbase.api.service.ContributionService: Admin method to delete a Contribution from the DB.
adminDeleteAllTemplates() - Method in interface org.ehrbase.api.service.TemplateService: Deletes all templates from target template storage and returns the number of deleted templates.
adminDeleteEhr(UUID) - Method in interface org.ehrbase.api.service.EhrService: Admin method to delete an EHR from the DB.
adminDeleteFolder(UUID) - Method in interface org.ehrbase.api.service.FolderService: Admin method to delete a Folder from the DB.
adminDeleteOrphanHistory() - Method in interface org.ehrbase.api.service.EhrService
adminDeleteTemplate(String) - Method in interface org.ehrbase.api.service.TemplateService: Deletes a given template from storage physically.
adminPurgePartyIdentified() - Method in interface org.ehrbase.api.service.EhrService
adminUpdateTemplate(String, String) - Method in interface org.ehrbase.api.service.TemplateService: Replaces a given template in the storage and updates the cache with the new template content.
AQL - org.ehrbase.api.definitions.QueryMode

B

BadGatewayException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
BadGatewayException(String) - Constructor for exception org.ehrbase.api.exception.BadGatewayException
BadGatewayException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.BadGatewayException
BaseService - Interface in org.ehrbase.api.service: Basic service interface, foundation of all service interfaces
BETTER - org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
buildComposition(String, CompositionFormat, String) - Method in interface org.ehrbase.api.service.CompositionService
buildExample(String) - Method in interface org.ehrbase.api.service.TemplateService

C

check(Composition) - Method in interface org.ehrbase.api.service.ValidationService: initially check if the composition is valid for further processing
check(EhrStatus) - Method in interface org.ehrbase.api.service.ValidationService: initially check if ehrstatus is valid for further processing
check(String, Composition) - Method in interface org.ehrbase.api.service.ValidationService: check a composition based on the operation template constraints
checkEhrExists(UUID) - Method in interface org.ehrbase.api.service.EhrService: Checks if an EHR with the given UUID exists.
checkEhrExistsAndIsModifiable(UUID) - Method in interface org.ehrbase.api.service.EhrService: Checks if the EHR with the given UUID is modifiable.
commitContribution(UUID, String, CompositionFormat) - Method in interface org.ehrbase.api.service.ContributionService: Commit a CONTRIBUTION containing any number of serialized VERSION objects.
CompositionService - Interface in org.ehrbase.api.service
ContributionService - Interface in org.ehrbase.api.service: Interface for contribution service roughly based on openEHR SM "I_EHR_CONTRIBUTION Interface", see: https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_i_ehr_contribution_interface
create(UUID, EhrStatus) - Method in interface org.ehrbase.api.service.EhrService: Creates new EHR instance, with default settings and values when no status or ID is supplied.
create(UUID, T) - Method in interface org.ehrbase.api.service.VersionedObjectService: Creation with default audit meta-data.
create(UUID, T, UUID) - Method in interface org.ehrbase.api.service.VersionedObjectService: Creation with a given contribution, and its audit meta-data.
create(UUID, T, UUID, UUID, String) - Method in interface org.ehrbase.api.service.VersionedObjectService: Creation with given audit meta-data.
create(OPERATIONALTEMPLATE) - Method in interface org.ehrbase.api.service.TemplateService
createStoredQuery(String, String, String) - Method in interface org.ehrbase.api.service.QueryService

D

delete(UUID, ObjectVersionId) - Method in interface org.ehrbase.api.service.VersionedObjectService: Deletion with default audit meta-data.
delete(UUID, ObjectVersionId, UUID) - Method in interface org.ehrbase.api.service.VersionedObjectService: Deletion with a given contribution, and its audit meta-data.
delete(UUID, ObjectVersionId, UUID, UUID, String) - Method in interface org.ehrbase.api.service.VersionedObjectService: Deletion with given audit meta-data.
deleteStoredQuery(String, String) - Method in interface org.ehrbase.api.service.QueryService
doesEhrExist(UUID) - Method in interface org.ehrbase.api.service.EhrService: Checks if there is an ehr entry existing for specified ehrId.
DTS4 - org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
DuplicateObjectException - Exception in org.ehrbase.api.exception
DuplicateObjectException(String, String) - Constructor for exception org.ehrbase.api.exception.DuplicateObjectException
DuplicateObjectException(String, String, Throwable) - Constructor for exception org.ehrbase.api.exception.DuplicateObjectException

E

EhrService - Interface in org.ehrbase.api.service
EQUIVALENT - org.ehrbase.api.service.TerminologyServer.SubsumptionResult
exists(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Checks if given ID is a valid composition ID.
expand(ID) - Method in interface org.ehrbase.api.service.TerminologyServer: Expands the value set identified by the provided ID.
expandWithParameters(ID, U...) - Method in interface org.ehrbase.api.service.TerminologyServer: Expands the value set identified by the provided ID.

F

FHIR - org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
findBySubject(String, String) - Method in interface org.ehrbase.api.service.EhrService
findOperationalTemplate(String, OperationalTemplateFormat) - Method in interface org.ehrbase.api.service.TemplateService: Finds and returns the given operational template as string represented in requested format.
findTemplate(String) - Method in interface org.ehrbase.api.service.TemplateService
FolderService - Interface in org.ehrbase.api.service
formatMessage(Enum<?>, String) - Static method in exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt die Message der UnexpectedSwitchCaseException anhand der übergebenen Parameter mit Ausgabe von enumValue.getClass().getSimpleName().
Ausgegeben in der Exception-Message wird enumValue.name(), damit z.B.
formatMessage(Object, String) - Static method in exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt die Message der UnexpectedSwitchCaseException anhand der übergebenen Parameter.
formatMessage(String, Object, String) - Static method in exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt die Message der UnexpectedSwitchCaseException anhand der übergebenen Parameter.
from(UUID, Composition) - Static method in interface org.ehrbase.api.service.CompositionService

G

GeneralRequestProcessingException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
GeneralRequestProcessingException(String) - Constructor for exception org.ehrbase.api.exception.GeneralRequestProcessingException
GeneralRequestProcessingException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.GeneralRequestProcessingException
get(ObjectVersionId, String) - Method in interface org.ehrbase.api.service.FolderService: Retrieves a folder from database identified by object_version_uid and extracts the given sub path of existing.
getAdapterId() - Method in enum org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
getAllTemplates() - Method in interface org.ehrbase.api.service.TemplateService
getAqlDepth() - Method in interface org.ehrbase.api.definitions.ServerConfig
getAqlIterationSkipList() - Method in interface org.ehrbase.api.definitions.ServerConfig
getArchieVersion() - Method in interface org.ehrbase.api.service.StatusService: Returns current version of archie which has been used to build the running EHRbase instance.
getByTimeStamp(ObjectVersionId, Timestamp, String) - Method in interface org.ehrbase.api.service.FolderService: Fetches an folder entry from database identified by the root folder uid and the given timestamp.
getCode() - Method in enum org.ehrbase.api.definitions.QueryMode
getContribution(UUID, UUID) - Method in interface org.ehrbase.api.service.ContributionService: Return the Contribution with given id in given EHR.
getCreationTime(UUID) - Method in interface org.ehrbase.api.service.EhrService
getCurrentVersionUid() - Method in exception org.ehrbase.api.exception.PreconditionFailedException
getDatabaseInformation() - Method in interface org.ehrbase.api.service.StatusService: Returns information on the current connected Database instance version.
getDirectoryId(UUID) - Method in interface org.ehrbase.api.service.EhrService: Reads the EHR entry from database and returns the ID of the root directory entry.
getEhrbaseVersion() - Method in interface org.ehrbase.api.service.StatusService: Returns current version of EHRbase build that is running.
getEhrId(UUID) - Method in interface org.ehrbase.api.service.CompositionService
getEhrStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Gets latest EHR_STATUS of the given EHR.
getEhrStatusAtVersion(UUID, UUID, int) - Method in interface org.ehrbase.api.service.EhrService: Gets particular EHR_STATUS matching the given version Uid.
getEhrStatusEhrScape(UUID, CompositionFormat) - Method in interface org.ehrbase.api.service.EhrService: Deprecated.
getEhrStatusVersionByTimestamp(UUID, Timestamp) - Method in interface org.ehrbase.api.service.EhrService: Get version number of EHR_STATUS associated with given EHR UID at given timestamp.
getEhrStatusVersionedObjectUidByEhr(UUID) - Method in interface org.ehrbase.api.service.EhrService: Helper to get (Versioned Object) Uid of EHR_STATUS of given EHR.
getJavaVMInformation() - Method in interface org.ehrbase.api.service.StatusService: Returns information on the current Java Virtual Machine that is running this EHRbase instance.
getLastVersionNumber(ObjectVersionId) - Method in interface org.ehrbase.api.service.FolderService: Searches the last version number of a given folder entry from database.
getLastVersionNumber(UUID) - Method in interface org.ehrbase.api.service.CompositionService
getLatest(ObjectVersionId, String) - Method in interface org.ehrbase.api.service.FolderService: Fetches the latest entry from database.
getLatestVersionUidOfStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Get latest version UID of an EHR_STATUS by given associated EHR UID.
getListOfTemplates(String, CompositionFormat) - Method in interface org.ehrbase.api.service.ContributionService: Extracts set of used templates in payload's compositions.
getNodename() - Method in interface org.ehrbase.api.definitions.ServerConfig
getOpenEHR_SDK_Version() - Method in interface org.ehrbase.api.service.StatusService: Returns the current version of openEHR_SDK which has been used to build the running EHRbase instance.
getOperatingSystemInformation() - Method in interface org.ehrbase.api.service.StatusService: Returns information on the current operating system this EHRbase instance is running on.
getOriginalVersionComposition(UUID, UUID, int) - Method in interface org.ehrbase.api.service.CompositionService: Gets Original Version container class representation of the given composition at given version.
getPort() - Method in interface org.ehrbase.api.definitions.ServerConfig
getRevisionHistoryOfVersionedComposition(UUID, UUID) - Method in interface org.ehrbase.api.service.CompositionService: Gets revision history of given composition.
getRevisionHistoryOfVersionedEhrStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Gets revision history of EhrStatus associated with given EHR.
getServerConfig() - Method in interface org.ehrbase.api.service.BaseService
getSubjectExtRef(String) - Method in interface org.ehrbase.api.service.EhrService: Helper to directly get the external subject reference form the linked subject to given EHR.
getSubjectExtRefs(Collection<String>) - Method in interface org.ehrbase.api.service.EhrService
getSubjectUuid(String) - Method in interface org.ehrbase.api.service.EhrService: Helper to directly get the linked subject ID to given EHR.
getSystemUuid() - Method in interface org.ehrbase.api.service.BaseService
getTemplateIdFromInputComposition(String, CompositionFormat) - Method in interface org.ehrbase.api.service.CompositionService: Helper function to read the template ID from given composition input in stated format.
getType() - Method in exception org.ehrbase.api.exception.DuplicateObjectException
getType() - Method in exception org.ehrbase.api.exception.ObjectNotFoundException
getUidFromInputComposition(String, CompositionFormat) - Method in interface org.ehrbase.api.service.CompositionService: Helper function to read UUID from given composition input in stated format.
getUrl() - Method in exception org.ehrbase.api.exception.PreconditionFailedException
getVersionByTimestamp(UUID, LocalDateTime) - Method in interface org.ehrbase.api.service.CompositionService: Gets the version of a composition that is closest in time before timestamp
getVersionedComposition(UUID, UUID) - Method in interface org.ehrbase.api.service.CompositionService: Gets version container Composition associated with given EHR and Composition ID.
getVersionedEhrStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Gets version container EhrStatus associated with given EHR.
getVersionNumberForTimestamp(ObjectVersionId, Timestamp) - Method in interface org.ehrbase.api.service.FolderService: Searches for the folder version that was the current version at the given timestamp.

H

hasContribution(UUID, UUID) - Method in interface org.ehrbase.api.service.ContributionService: Check if given contribution exists and is part of given EHR.
hasEhr(UUID) - Method in interface org.ehrbase.api.service.EhrService: Return True if a EHR with identifier ehrId exists.
hasStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Return True if a EHR_STATUS with identifier statusId exists.

I

INDIZEN - org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
InternalServerException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
InternalServerException(String) - Constructor for exception org.ehrbase.api.exception.InternalServerException
InternalServerException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.InternalServerException
InternalServerException(Throwable) - Constructor for exception org.ehrbase.api.exception.InternalServerException
InvalidApiParameterException - Exception in org.ehrbase.api.exception
InvalidApiParameterException(String) - Constructor for exception org.ehrbase.api.exception.InvalidApiParameterException
InvalidApiParameterException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.InvalidApiParameterException
isAdapterSupported(String) - Static method in enum org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
isDeleted(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Checks if given composition ID is ID of a logically deleted composition.
isDisableStrictValidation() - Method in interface org.ehrbase.api.definitions.ServerConfig
isModifiable(UUID) - Method in interface org.ehrbase.api.service.EhrService: Returns true if an EHR_STATUS for the given EHR ID exists and has the is_modifiable flag set to true.

J

JSON - org.ehrbase.api.definitions.OperationalTemplateFormat

L

lookUp(ID) - Method in interface org.ehrbase.api.service.TerminologyServer: Searches all the attributes associated with the concept that corresponds to the provided ID.

N

NotAcceptableException - Exception in org.ehrbase.api.exception
NotAcceptableException(String) - Constructor for exception org.ehrbase.api.exception.NotAcceptableException
NOTSUBSUMED - org.ehrbase.api.service.TerminologyServer.SubsumptionResult

O

ObjectNotFoundException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
ObjectNotFoundException(String, String) - Constructor for exception org.ehrbase.api.exception.ObjectNotFoundException
ObjectNotFoundException(String, String, Throwable) - Constructor for exception org.ehrbase.api.exception.ObjectNotFoundException
OCEAN - org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
OperationalTemplateFormat - Enum in org.ehrbase.api.definitions
org.ehrbase.api.definitions - package org.ehrbase.api.definitions
org.ehrbase.api.exception - package org.ehrbase.api.exception
org.ehrbase.api.mapper - package org.ehrbase.api.mapper
org.ehrbase.api.service - package org.ehrbase.api.service

P

PreconditionFailedException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
PreconditionFailedException(String) - Constructor for exception org.ehrbase.api.exception.PreconditionFailedException
PreconditionFailedException(String, String, String) - Constructor for exception org.ehrbase.api.exception.PreconditionFailedException
PreconditionFailedException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.PreconditionFailedException

Q

query(String, Map<String, Object>, QueryMode, boolean, Map<String, Set<Object>>) - Method in interface org.ehrbase.api.service.QueryService: simple query where the full json expression contains both query (key = 'q') and optional parameters (key = 'query-parameters')
QueryMode - Enum in org.ehrbase.api.definitions
QueryService - Interface in org.ehrbase.api.service

R

removeDirectory(UUID) - Method in interface org.ehrbase.api.service.EhrService: Removes the directory information from EHR table entry after deletion of the corresponding folder from folders table.
retrieve(UUID, UUID, Integer) - Method in interface org.ehrbase.api.service.CompositionService
retrieveStoredQueries(String) - Method in interface org.ehrbase.api.service.QueryService
retrieveStoredQuery(String, String) - Method in interface org.ehrbase.api.service.QueryService

S

serialize(Folder, StructuredStringFormat) - Method in interface org.ehrbase.api.service.FolderService: Serializes folder content from request body into a structured string that can be used by database save mechanism to parse in into jsonb format that will be saved at the database.
serialize(CompositionDto, CompositionFormat) - Method in interface org.ehrbase.api.service.CompositionService: Public serializer entry point which will be called with composition dto fetched from database and the desired target serialized string format.
serialize(StructuredString, JsonGenerator, SerializerProvider) - Method in class org.ehrbase.api.mapper.StructuredStringJSonSerializer
ServerConfig - Interface in org.ehrbase.api.definitions
setNodename(String) - Method in interface org.ehrbase.api.definitions.ServerConfig
setPort(int) - Method in interface org.ehrbase.api.definitions.ServerConfig
SQL - org.ehrbase.api.definitions.QueryMode
StateConflictException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
StateConflictException(String) - Constructor for exception org.ehrbase.api.exception.StateConflictException
StateConflictException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.StateConflictException
StatusService - Interface in org.ehrbase.api.service: Status service to get information about the running EHRbase instance
StructuredStringJSonSerializer - Class in org.ehrbase.api.mapper
StructuredStringJSonSerializer() - Constructor for class org.ehrbase.api.mapper.StructuredStringJSonSerializer
SUBSUMEDBY - org.ehrbase.api.service.TerminologyServer.SubsumptionResult
subsumes(T, T) - Method in interface org.ehrbase.api.service.TerminologyServer: Evaluates if the concept B subsumes concept A.
SUBSUMES - org.ehrbase.api.service.TerminologyServer.SubsumptionResult

T

TemplateService - Interface in org.ehrbase.api.service
TerminologyServer<T,ID,U> - Interface in org.ehrbase.api.service
TerminologyServer.SubsumptionResult - Enum in org.ehrbase.api.service: Possible subsumption evaluation results.
TerminologyServer.TerminologyAdapter - Enum in org.ehrbase.api.service

U

UnexpectedSwitchCaseException - Exception in org.ehrbase.api.exception: Diese Exception wird geworfen, wenn in einem Switch-Block ein Case eingetreten ist, der nicht korrekt behandelt werden kann.
UnexpectedSwitchCaseException(Enum<?>) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen enumValue eine message.
Ausgegeben in der Exception-Message wird enumValue.name(), damit z.B.
UnexpectedSwitchCaseException(Enum<?>, String) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen enumValue eine message.
Ausgegeben in der Exception-Message wird enumValue.name(), damit z.B.
UnexpectedSwitchCaseException(Integer) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen intValue eine message.
UnexpectedSwitchCaseException(Integer, String) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen intValue eine message.
UnexpectedSwitchCaseException(String) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen stringValue eine message.
UnexpectedSwitchCaseException(String, String) - Constructor for exception org.ehrbase.api.exception.UnexpectedSwitchCaseException: Erzeugt aus dem übergebenen stringValue eine message.
UnprocessableEntityException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
UnprocessableEntityException(String) - Constructor for exception org.ehrbase.api.exception.UnprocessableEntityException
UnsupportedMediaTypeException - Exception in org.ehrbase.api.exception: Runtime Exception to handle a not supported media type which a client has specified as the response type.
UnsupportedMediaTypeException(String) - Constructor for exception org.ehrbase.api.exception.UnsupportedMediaTypeException
UnsupportedMediaTypeException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.UnsupportedMediaTypeException
update(UUID, ObjectVersionId, T) - Method in interface org.ehrbase.api.service.VersionedObjectService: Update with default audit meta-data.
update(UUID, ObjectVersionId, T, UUID) - Method in interface org.ehrbase.api.service.VersionedObjectService: Update with a given contribution, and its audit meta-data.
update(UUID, ObjectVersionId, T, UUID, UUID, String) - Method in interface org.ehrbase.api.service.VersionedObjectService: Update with given audit meta-data.
updateStatus(UUID, EhrStatus, UUID) - Method in interface org.ehrbase.api.service.EhrService: Update the EHR_STATUS linked to the given EHR
updateStoredQuery(String, String, String) - Method in interface org.ehrbase.api.service.QueryService

V

validate(T, ID) - Method in interface org.ehrbase.api.service.TerminologyServer: Evaluates if the concept provided T belongs to the value set identified by the provided ID.
validate(U...) - Method in interface org.ehrbase.api.service.TerminologyServer: Evaluates if the concept provided as one operationParams belongs to the value set provided as another operationParam.
ValidationException - Exception in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
ValidationException(Exception) - Constructor for exception org.ehrbase.api.exception.ValidationException
ValidationException(String) - Constructor for exception org.ehrbase.api.exception.ValidationException
ValidationException(String, Throwable) - Constructor for exception org.ehrbase.api.exception.ValidationException
ValidationService - Interface in org.ehrbase.api.service: ValidationService
valueOf(String) - Static method in enum org.ehrbase.api.definitions.OperationalTemplateFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehrbase.api.definitions.QueryMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehrbase.api.service.TerminologyServer.SubsumptionResult: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehrbase.api.service.TerminologyServer.TerminologyAdapter: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.ehrbase.api.definitions.OperationalTemplateFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehrbase.api.definitions.QueryMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehrbase.api.service.TerminologyServer.SubsumptionResult: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehrbase.api.service.TerminologyServer.TerminologyAdapter: Returns an array containing the constants of this enum type, in the order they are declared.
VersionedObjectService<T extends com.nedap.archie.rm.archetyped.Locatable,U> - Interface in org.ehrbase.api.service: Service layer interface for versioned openEHR objects.
Helps to always handle the necessary metadata and streamlines C(R)UD operations.
Retrieval is

X

XML - org.ehrbase.api.definitions.OperationalTemplateFormat

A B C D E F G H I J L N O P Q R S T U V X
All Classes All Packages