Index (api 2.18.0 API)

A B C D E F G H I J K L M N O P Q R S T U V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

action(ProceedingJoinPoint, List<Annotation>) - Method in interface org.ehrbase.api.aspect.AnnotationAspect
addError(String) - Method in class org.ehrbase.api.knowledge.TemplateMetaData
addOperationalTemplate(OPERATIONALTEMPLATE) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
adminDelete(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Admin method to delete a Composition from the DB.
adminDelete(UUID, 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, UUID) - Method in interface org.ehrbase.api.service.DirectoryService: Physical delete a folder with all History
adminDeleteTemplate(String) - Method in interface org.ehrbase.api.service.TemplateService: Deletes a given template from storage physically.
adminUpdateOperationalTemplate(InputStream) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
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.
AMENDMENT - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
AnnotationAspect - Interface in org.ehrbase.api.aspect
AQL_DRY_RUN - Static variable in class org.ehrbase.api.rest.EHRbaseHeader: Used by the /query endpoint to perform only a dry run query.
AQL_EXECUTED_SQL - Static variable in class org.ehrbase.api.rest.EHRbaseHeader: Used by the /query endpoint to provide the executed SQL statement in the return metadata.
AQL_QUERY_PLAN - Static variable in class org.ehrbase.api.rest.EHRbaseHeader: Used by the /query endpoint to provide the database query plan in the return metadata.
AqlFeatureNotImplementedException - Exception Class in org.ehrbase.api.exception
AqlFeatureNotImplementedException(String) - Constructor for exception class org.ehrbase.api.exception.AqlFeatureNotImplementedException
AqlQueryContext - Interface in org.ehrbase.api.dto
AqlQueryContext.EhrbaseMetaProperty - Enum Class in org.ehrbase.api.dto
AqlQueryContext.MetaProperty - Interface in org.ehrbase.api.dto
AqlQueryRequest - Record Class in org.ehrbase.api.dto: The requested AQL to be executed by AqlQueryService.query(AqlQueryRequest).
AqlQueryRequest(String, Map<String, Object>, Long, Long) - Constructor for record class org.ehrbase.api.dto.AqlQueryRequest: Creates an instance of a AqlQueryRequest record class.
AqlQueryService - Interface in org.ehrbase.api.service
AqlRuntimeException - Exception Class in org.ehrbase.api.exception
AqlRuntimeException(String) - Constructor for exception class org.ehrbase.api.exception.AqlRuntimeException
AqlRuntimeException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.AqlRuntimeException
AqlRuntimeException(Throwable) - Constructor for exception class org.ehrbase.api.exception.AqlRuntimeException
archetypeDetails() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the archetypeDetails record component.
archetypeNodeId() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the archetypeNodeId record component.
AuthorizationAspect - Interface in org.ehrbase.api.aspect

B

BadGatewayException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
BadGatewayException(String) - Constructor for exception class org.ehrbase.api.exception.BadGatewayException
BadGatewayException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.BadGatewayException
BEAN_NAME - Static variable in interface org.ehrbase.api.dto.AqlQueryContext
BETTER - Enum constant in enum class 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
bulkDelete(UUID, UUID, ItemTagDto.ItemTagRMType, Collection<UUID>) - Method in interface org.ehrbase.api.service.experimental.ItemTagService: Performs a bulk delete operation for the given ItemTag ids.
bulkUpsert(UUID, UUID, ItemTagDto.ItemTagRMType, List<ItemTagDto>) - Method in interface org.ehrbase.api.service.experimental.ItemTagService: Performs a bulk update/create operation for the given ItemTag into the tag list of the owner.

C

check(Composition) - Method in interface org.ehrbase.api.service.ValidationService: Initially check if the composition is valid for further processing.
check(EhrStatusDto) - Method in interface org.ehrbase.api.service.ValidationService: Initially check if ehrStatus is valid for further processing.
check(ContributionCreateDto) - Method in interface org.ehrbase.api.service.ValidationService: Initially check if contribution is valid for further processing.
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.
clear() - Static method in class org.ehrbase.api.rest.HttpRestContext
commitContribution(UUID, String) - Method in interface org.ehrbase.api.service.ContributionService: Commit a CONTRIBUTION containing any number of serialized VERSION objects.
COMPOSITION - Enum constant in enum class org.ehrbase.api.dto.experimental.ItemTagDto.ItemTagRMType
COMPOSITION_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
compositions() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the compositions record component.
CompositionService - Interface in org.ehrbase.api.service
CONTRIBUTION_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
contributions() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the contributions record component.
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
ContributionService.ContributionChangeType - Enum Class in org.ehrbase.api.service
create(UUID, Folder) - Method in interface org.ehrbase.api.service.DirectoryService: Create a new folder for Ehr with id equal ehrId
create(UUID, EhrStatusDto) - 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, 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: Deprecated, for removal: This API element is subject to removal in a future version.
create(OPERATIONALTEMPLATE) - Method in interface org.ehrbase.api.service.TemplateService
createMetaData(URI) - Method in interface org.ehrbase.api.dto.AqlQueryContext
createStoredQuery(String, String, String) - Method in interface org.ehrbase.api.service.StoredQueryService
CREATION - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
CtxAttr() - Constructor for class org.ehrbase.api.rest.HttpRestContext.CtxAttr

D

DEFAULT_LIMIT - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
delete(UUID, ObjectVersionId) - Method in interface org.ehrbase.api.service.DirectoryService: delete the folder for Ehr with id equal ehrId
delete(UUID, ObjectVersionId) - Method in interface org.ehrbase.api.service.VersionedObjectService: Deletion with default audit meta-data.
delete(UUID, ObjectVersionId, UUID, 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: Deprecated, for removal: This API element is subject to removal in a future version.
deleteAllOperationalTemplates() - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
deleteBy(UUID) - Method in interface org.ehrbase.api.repository.KeyValuePairRepository
DELETED - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
deleteOperationalTemplate(OPERATIONALTEMPLATE) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService: Deletes a given operational template physically from cache and from template storage and from cache.
deleteStoredQuery(String, String) - Method in interface org.ehrbase.api.service.StoredQueryService
DIRECTORY_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
DirectoryService - Interface in org.ehrbase.api.service
DRY_RUN - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
DTS4 - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter

E

EHR_DIRECTORY_FOLDER_IDX - Static variable in interface org.ehrbase.api.service.DirectoryService
EHR_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
EHR_STATUS - Enum constant in enum class org.ehrbase.api.dto.experimental.ItemTagDto.ItemTagRMType
EHRbaseHeader - Class in org.ehrbase.api.rest: EHRbase specific HTTP headers that are not part of the openEHR standard.
EhrbaseSecurity - Annotation Interface in org.ehrbase.api.annotations
EhrDto - Record Class in org.ehrbase.api.dto: Basic set of response data regarding EHR_STATUS. operations.
EhrDto(HierObjectId, HierObjectId, EhrStatusDto, DvDateTime, List<CompositionDto>, List<ContributionDto>) - Constructor for record class org.ehrbase.api.dto.EhrDto: Creates an instance of a EhrDto record class.
ehrId() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the ehrId record component.
ehrId() - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Returns the value of the ehrId record component.
EhrResult(UUID, ObjectVersionId, EhrStatusDto) - Constructor for record class org.ehrbase.api.service.EhrService.EhrResult: Creates an instance of a EhrResult record class.
EhrService - Interface in org.ehrbase.api.service
EhrService.EhrResult - Record Class in org.ehrbase.api.service: Wrapper for EhrService.create(UUID, EhrStatusDto) response that contains the EHR id as well as the EhrStatusDto and it's ObjectVersionId.
ehrStatus() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the ehrStatus record component.
EhrStatusDto - Record Class in org.ehrbase.api.dto: Request/Response data of an EHR_STATUS.
EhrStatusDto(UIDBasedId, String, DvText, Archetyped, FeederAudit, PartySelf, Boolean, Boolean, ItemStructure) - Constructor for record class org.ehrbase.api.dto.EhrStatusDto: Creates an instance of a EhrStatusDto record class.
equals(Object) - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.ehrbase.api.dto.EhrDto: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.ehrbase.api.dto.EhrStatusDto: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
equals(Object) - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Indicates whether some other object is "equal to" this one.
EQUIVALENT - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.SubsumptionResult
EXECUTED_SQL - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
exists(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Checks if given ID is already used.
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

feederAudit() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the feederAudit record component.
fetch() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns the value of the fetch record component.
FETCH - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
FHIR - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
findAllBy(String) - Method in interface org.ehrbase.api.repository.KeyValuePairRepository
findAllTemplateIds() - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
findAllTemplateIds() - Method in interface org.ehrbase.api.service.TemplateService
findBy(String, String) - Method in interface org.ehrbase.api.repository.KeyValuePairRepository
findBy(UUID) - Method in interface org.ehrbase.api.repository.KeyValuePairRepository
findBySubject(String, String) - Method in interface org.ehrbase.api.service.EhrService: Search for an EHR_STATUS based on the given subject id and namespace
findItemTag(UUID, UUID, ItemTagDto.ItemTagRMType, Collection<UUID>, Collection<String>) - Method in interface org.ehrbase.api.service.experimental.ItemTagService: Performs a bulk get operation for the given ItemTag IDs and/or keys.
findOperationalTemplate(String, OperationalTemplateFormat) - Method in interface org.ehrbase.api.service.TemplateService: Finds and returns the given operational template as string represented in requested format.
findTemplateIdByUuid(UUID) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
findUuidByTemplateId(String) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
findWebTemplate(String) - Method in interface org.ehrbase.api.service.TemplateService
formatMessage(Enum<?>, String) - Static method in exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates the message of a UnexpectedSwitchCaseException containing the simple class name of the enumValue parameter.
formatMessage(Object, String) - Static method in exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates the message of a UnexpectedSwitchCaseException based on the given parameters.
formatMessage(String, Object, String) - Static method in exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates the message of a UnexpectedSwitchCaseException based on the given parameters.
from(UUID, Composition) - Static method in interface org.ehrbase.api.service.CompositionService
fromAuditDetails(AuditDetails) - Static method in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType

G

GeneralRequestProcessingException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
GeneralRequestProcessingException(String) - Constructor for exception class org.ehrbase.api.exception.GeneralRequestProcessingException
GeneralRequestProcessingException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.GeneralRequestProcessingException
get(UUID, ObjectVersionId, String) - Method in interface org.ehrbase.api.service.DirectoryService: Get the Folder for Ehr with id equal ehrId
get(HttpRestContext.CtxAttr<T>) - Static method in class org.ehrbase.api.rest.HttpRestContext
get(HttpRestContext.CtxAttr<T>) - Method in interface org.ehrbase.api.rest.HttpRestContext.HttpCtx
getAdapterId() - Method in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
getAllTemplates() - Method in interface org.ehrbase.api.service.TemplateService
getArchieVersion() - Method in interface org.ehrbase.api.service.StatusService: Returns current version of archie which has been used to build the running EHRbase instance.
getByTime(UUID, OffsetDateTime, String) - Method in interface org.ehrbase.api.service.DirectoryService: Get the Folder for Ehr with id equal ehrId for a specific point in time;
getCode() - Method in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
getContext() - Method in interface org.ehrbase.api.repository.KeyValuePair
getContribution(UUID, UUID) - Method in interface org.ehrbase.api.service.ContributionService: Return the Contribution with given id in given EHR.
getCreatedOn() - Method in class org.ehrbase.api.knowledge.TemplateMetaData
getCreationTime(UUID) - Method in interface org.ehrbase.api.service.EhrService: Provides the creation time of the given EHR id.
getCurrentVersionUid() - Method in exception class org.ehrbase.api.exception.PreconditionFailedException
getDatabaseInformation() - Method in interface org.ehrbase.api.service.StatusService: Returns information on the current connected Database instance version.
getEhrbaseVersion() - Method in interface org.ehrbase.api.service.StatusService: Returns current version of EHRbase build that is running.
getEhrIdForComposition(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Gets the EHR id for the given Composition id.
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.
getEhrStatusVersionByTimestamp(UUID, OffsetDateTime) - Method in interface org.ehrbase.api.service.EhrService: Get version number of EHR_STATUS associated with given EHR UID at given timestamp.
getErrorList() - Method in class org.ehrbase.api.knowledge.TemplateMetaData
getId() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getId() - Method in interface org.ehrbase.api.repository.KeyValuePair
getInternalId() - Method in class org.ehrbase.api.knowledge.TemplateMetaData
getInternalTemplate(String) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
getJavaVMInformation() - Method in interface org.ehrbase.api.service.StatusService: Returns information on the current Java Virtual Machine that is running this EHRbase instance.
getKey() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getKey() - Method in interface org.ehrbase.api.repository.KeyValuePair
getLastVersionNumber(UUID, UUID) - Method in interface org.ehrbase.api.service.CompositionService: Retrieve the latest version number for the given composition ID.
getLatestVersionUidOfStatus(UUID) - Method in interface org.ehrbase.api.service.EhrService: Get latest version UID of an EHR_STATUS by given associated EHR UID.
getOpenEHR_SDK_Version() - Method in interface org.ehrbase.api.service.StatusService: Returns the current version of ehrbase 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.
getOperationaltemplate() - Method in class org.ehrbase.api.knowledge.TemplateMetaData
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.
getOwnerId() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
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.
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.
getSystemId() - Method in interface org.ehrbase.api.service.SystemService
getTarget() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getTargetPath() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getTargetType() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getType() - Method in exception class org.ehrbase.api.exception.ObjectNotFoundException
getUrl() - Method in exception class org.ehrbase.api.exception.PreconditionFailedException
getValue() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
getValue() - Method in interface org.ehrbase.api.repository.KeyValuePair
getVersionByTimestamp(UUID, OffsetDateTime) - 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.

H

handle(HttpRestContext.HttpCtx) - Method in interface org.ehrbase.api.rest.HttpRestContextHandler
handle(HttpRestContextHandler) - Static method in class org.ehrbase.api.rest.HttpRestContext
hasEhr(UUID) - Method in interface org.ehrbase.api.service.EhrService: Return True if a EHR with identifier ehrId exists.
hashCode() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns a hash code value for this object.
hashCode() - Method in record class org.ehrbase.api.dto.EhrDto: Returns a hash code value for this object.
hashCode() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns a hash code value for this object.
hashCode() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
hashCode() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Returns a hash code value for this object.
hashCode() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Returns a hash code value for this object.
hashCode() - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Returns a hash code value for this object.
HttpRestContext - Class in org.ehrbase.api.rest
HttpRestContext() - Constructor for class org.ehrbase.api.rest.HttpRestContext
HttpRestContext.CtxAttr<T> - Class in org.ehrbase.api.rest
HttpRestContext.HttpCtx - Interface in org.ehrbase.api.rest
HttpRestContextHandler - Interface in org.ehrbase.api.rest

I

IllegalAqlException - Exception Class in org.ehrbase.api.exception
IllegalAqlException(String) - Constructor for exception class org.ehrbase.api.exception.IllegalAqlException
IllegalAqlException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.IllegalAqlException
IllegalAqlException(Throwable) - Constructor for exception class org.ehrbase.api.exception.IllegalAqlException
INDIZEN - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
InternalServerException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
InternalServerException(String) - Constructor for exception class org.ehrbase.api.exception.InternalServerException
InternalServerException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.InternalServerException
InternalServerException(Throwable) - Constructor for exception class org.ehrbase.api.exception.InternalServerException
InvalidApiParameterException - Exception Class in org.ehrbase.api.exception
InvalidApiParameterException(String) - Constructor for exception class org.ehrbase.api.exception.InvalidApiParameterException
InvalidApiParameterException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.InvalidApiParameterException
isAdapterSupported(String) - Static method in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
isDeleted(UUID, UUID, Integer) - Method in interface org.ehrbase.api.service.CompositionService: Checks if given composition ID is ID of a logically deleted composition.
isDryRun() - Method in interface org.ehrbase.api.dto.AqlQueryContext
isModifiable() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the isModifiable record component.
isQueryable() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the isQueryable record component.
ItemTagDto - Class in org.ehrbase.api.dto.experimental
ItemTagDto() - Constructor for class org.ehrbase.api.dto.experimental.ItemTagDto
ItemTagDto(UUID, UUID, UUID, ItemTagDto.ItemTagRMType, String, String, String) - Constructor for class org.ehrbase.api.dto.experimental.ItemTagDto
ItemTagDto.ItemTagRMType - Enum Class in org.ehrbase.api.dto.experimental
ItemTagService - Interface in org.ehrbase.api.service.experimental: Service manages the ITEM_TAG Class.

J

JSON - Enum constant in enum class org.ehrbase.api.definitions.OperationalTemplateFormat

K

KeyValuePair - Interface in org.ehrbase.api.repository
KeyValuePairRepository - Interface in org.ehrbase.api.repository
KnowledgeCacheService - Interface in org.ehrbase.api.knowledge

L

listAllOperationalTemplates() - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService
LOCATION - Static variable in class org.ehrbase.api.rest.HttpRestContext
lookUp(ID) - Method in interface org.ehrbase.api.service.TerminologyServer: Searches all the attributes associated with the concept that corresponds to the provided ID.

M

matchAnnotations() - Method in interface org.ehrbase.api.aspect.AnnotationAspect
MAX_FETCH - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
MAX_LIMIT - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
MODIFICATION - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType

N

name() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the name record component.
NotAcceptableException - Exception Class in org.ehrbase.api.exception
NotAcceptableException(String) - Constructor for exception class org.ehrbase.api.exception.NotAcceptableException
NOTSUBSUMED - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.SubsumptionResult

O

ObjectNotFoundException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
ObjectNotFoundException(String, String) - Constructor for exception class org.ehrbase.api.exception.ObjectNotFoundException
ObjectNotFoundException(String, String, Throwable) - Constructor for exception class org.ehrbase.api.exception.ObjectNotFoundException
OCEAN - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter
of(String, String, String) - Static method in interface org.ehrbase.api.repository.KeyValuePair
of(UUID, String, String, String) - Static method in interface org.ehrbase.api.repository.KeyValuePair
offset() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns the value of the offset record component.
OFFSET - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
OPENEHR_REST_API_VERSION - Static variable in interface org.ehrbase.api.dto.AqlQueryContext
OperationalTemplateFormat - Enum Class in org.ehrbase.api.definitions
org.ehrbase.api.annotations - package org.ehrbase.api.annotations
org.ehrbase.api.aspect - package org.ehrbase.api.aspect
org.ehrbase.api.definitions - package org.ehrbase.api.definitions
org.ehrbase.api.dto - package org.ehrbase.api.dto
org.ehrbase.api.dto.experimental - package org.ehrbase.api.dto.experimental
org.ehrbase.api.exception - package org.ehrbase.api.exception
org.ehrbase.api.knowledge - package org.ehrbase.api.knowledge
org.ehrbase.api.mapper - package org.ehrbase.api.mapper
org.ehrbase.api.repository - package org.ehrbase.api.repository
org.ehrbase.api.rest - package org.ehrbase.api.rest
org.ehrbase.api.service - package org.ehrbase.api.service
org.ehrbase.api.service.experimental - package org.ehrbase.api.service.experimental
otherDetails() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the otherDetails record component.
ownerId() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Returns the value of the ownerId record component.
ownerId() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Returns the value of the ownerId record component.

P

parameters() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns the value of the parameters record component.
PreconditionFailedException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
PreconditionFailedException(String) - Constructor for exception class org.ehrbase.api.exception.PreconditionFailedException
PreconditionFailedException(String, String, String) - Constructor for exception class org.ehrbase.api.exception.PreconditionFailedException
PreconditionFailedException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.PreconditionFailedException
propertyName() - Method in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
propertyName() - Method in interface org.ehrbase.api.dto.AqlQueryContext.MetaProperty

Q

query(AqlQueryRequest) - Method in interface org.ehrbase.api.service.AqlQueryService: simple query where the full json expression contains both query (key = 'q') and optional parameters (key = 'query-parameters')
QUERY - Static variable in class org.ehrbase.api.rest.HttpRestContext
QUERY_EXECUTE_ENDPOINT - Static variable in class org.ehrbase.api.rest.HttpRestContext
QUERY_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
QUERY_PLAN - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
queryString() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns the value of the queryString record component.

R

register(HttpRestContext.CtxAttr<V>, V) - Static method in class org.ehrbase.api.rest.HttpRestContext
register(HttpRestContext.CtxAttr<V0>, V0, HttpRestContext.CtxAttr<V1>, V1) - Static method in class org.ehrbase.api.rest.HttpRestContext
register(HttpRestContext.CtxAttr<V0>, V0, HttpRestContext.CtxAttr<V1>, V1, HttpRestContext.CtxAttr<V2>, V2) - Static method in class org.ehrbase.api.rest.HttpRestContext
register(HttpRestContext.CtxAttr<V0>, V0, HttpRestContext.CtxAttr<V1>, V1, HttpRestContext.CtxAttr<V2>, V2, HttpRestContext.CtxAttr<V3>, V3) - Static method in class org.ehrbase.api.rest.HttpRestContext
REMOVED_PATIENTS - Static variable in class org.ehrbase.api.rest.HttpRestContext
RESULT_SIZE - Enum constant in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty
retrieve(UUID, UUID, Integer) - Method in interface org.ehrbase.api.service.CompositionService
retrieveOperationalTemplate(String) - Method in interface org.ehrbase.api.knowledge.KnowledgeCacheService: retrieve an operational template document instance
retrieveStoredQueries(String) - Method in interface org.ehrbase.api.service.StoredQueryService
retrieveStoredQuery(String, String) - Method in interface org.ehrbase.api.service.StoredQueryService
retrieveTemplateId(UUID) - Method in interface org.ehrbase.api.service.CompositionService: Retrieves the template ID associated with a given composition ID.
rewriteExplicitParameterTypes(Map<String, Object>) - Static method in record class org.ehrbase.api.dto.AqlQueryRequest

S

save(KeyValuePair) - Method in interface org.ehrbase.api.repository.KeyValuePairRepository
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
setCreatedOn(OffsetDateTime) - Method in class org.ehrbase.api.knowledge.TemplateMetaData
setExecutedAql(String) - Method in interface org.ehrbase.api.dto.AqlQueryContext
setId(UUID) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setInternalId(UUID) - Method in class org.ehrbase.api.knowledge.TemplateMetaData
setKey(String) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setMetaProperty(AqlQueryContext.MetaProperty, Object) - Method in interface org.ehrbase.api.dto.AqlQueryContext
setOperationalTemplate(OPERATIONALTEMPLATE) - Method in class org.ehrbase.api.knowledge.TemplateMetaData
setOwnerId(UUID) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setTarget(UUID) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setTargetPath(String) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setTargetType(ItemTagDto.ItemTagRMType) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
setValue(String) - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
showExecutedAql() - Method in interface org.ehrbase.api.dto.AqlQueryContext
showExecutedSql() - Method in interface org.ehrbase.api.dto.AqlQueryContext
showQueryPlan() - Method in interface org.ehrbase.api.dto.AqlQueryContext
StateConflictException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
StateConflictException(String) - Constructor for exception class org.ehrbase.api.exception.StateConflictException
StateConflictException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.StateConflictException
status() - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Returns the value of the status record component.
StatusService - Interface in org.ehrbase.api.service: Status service to get information about the running EHRbase instance
statusVersionId() - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Returns the value of the statusVersionId record component.
StoredQueryService - Interface in org.ehrbase.api.service
StructuredStringJSonSerializer - Class in org.ehrbase.api.mapper
StructuredStringJSonSerializer() - Constructor for class org.ehrbase.api.mapper.StructuredStringJSonSerializer
subject() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the subject record component.
SUBSUMEDBY - Enum constant in enum class 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 - Enum constant in enum class org.ehrbase.api.service.TerminologyServer.SubsumptionResult
SYNTHESIS - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
systemId() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the systemId record component.
SystemService - Interface in org.ehrbase.api.service

T

TEMPLATE_ID - Static variable in class org.ehrbase.api.rest.EHRbaseHeader
TEMPLATE_ID - Static variable in class org.ehrbase.api.rest.HttpRestContext
TemplateMetaData - Class in org.ehrbase.api.knowledge
TemplateMetaData() - Constructor for class org.ehrbase.api.knowledge.TemplateMetaData
TemplateService - Interface in org.ehrbase.api.service
TerminologyServer<T,ID,U> - Interface in org.ehrbase.api.service
TerminologyServer.SubsumptionResult - Enum Class in org.ehrbase.api.service: Possible subsumption evaluation results.
TerminologyServer.TerminologyAdapter - Enum Class in org.ehrbase.api.service
timeCreated() - Method in record class org.ehrbase.api.dto.EhrDto: Returns the value of the timeCreated record component.
timeCreated() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Returns the value of the timeCreated record component.
timeCreated() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Returns the value of the timeCreated record component.
toString() - Method in record class org.ehrbase.api.dto.AqlQueryRequest: Returns a string representation of this record class.
toString() - Method in record class org.ehrbase.api.dto.EhrDto: Returns a string representation of this record class.
toString() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns a string representation of this record class.
toString() - Method in class org.ehrbase.api.dto.experimental.ItemTagDto
toString() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Returns a string representation of this record class.
toString() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Returns a string representation of this record class.
toString() - Method in record class org.ehrbase.api.service.EhrService.EhrResult: Returns a string representation of this record class.
type() - Method in record class org.ehrbase.api.dto.EhrStatusDto
type() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto
type() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto

U

uid() - Method in record class org.ehrbase.api.dto.EhrStatusDto: Returns the value of the uid record component.
uid() - Method in record class org.ehrbase.api.dto.VersionedCompositionDto: Returns the value of the uid record component.
uid() - Method in record class org.ehrbase.api.dto.VersionedEhrStatusDto: Returns the value of the uid record component.
UnexpectedSwitchCaseException - Exception Class in org.ehrbase.api.exception: This exception is thrown when a case has occurred in a switch block that cannot be handled correctly.
UnexpectedSwitchCaseException(Enum<?>) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the enumValue parameter.
The message is based on enumValue.name(), so that the format is stable, e.g. in case of i18n.
UnexpectedSwitchCaseException(Enum<?>, String) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the enumValue parameter.
The message is based on enumValue.name(), so that the format is stable, e.g. in case of i18n.
UnexpectedSwitchCaseException(Integer) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the intValue parameter
UnexpectedSwitchCaseException(Integer, String) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the intValue parameter
UnexpectedSwitchCaseException(String) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the stringValue parameter
UnexpectedSwitchCaseException(String, String) - Constructor for exception class org.ehrbase.api.exception.UnexpectedSwitchCaseException: Creates a message from the stringValue parameter
UNKNOWN - Enum constant in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType
UnprocessableEntityException - Exception Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
UnprocessableEntityException(String) - Constructor for exception class org.ehrbase.api.exception.UnprocessableEntityException
UnprocessableEntityException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.UnprocessableEntityException
UnsupportedMediaTypeException - Exception Class 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 class org.ehrbase.api.exception.UnsupportedMediaTypeException
UnsupportedMediaTypeException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.UnsupportedMediaTypeException
update(UUID, Folder, ObjectVersionId) - Method in interface org.ehrbase.api.service.DirectoryService: Update the folder for Ehr with id equal ehrId
update(UUID, ObjectVersionId, T) - Method in interface org.ehrbase.api.service.VersionedObjectService: Update with default audit meta-data.
update(UUID, ObjectVersionId, T, UUID, 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: Deprecated, for removal: This API element is subject to removal in a future version.
updateStatus(UUID, EhrStatusDto, ObjectVersionId, UUID, UUID) - Method in interface org.ehrbase.api.service.EhrService: Update the EHR_STATUS linked to the given EHR

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 Class in org.ehrbase.api.exception: Project-custom exception that allows outbound APIs to react on backend problems.
ValidationException(Exception) - Constructor for exception class org.ehrbase.api.exception.ValidationException
ValidationException(String) - Constructor for exception class org.ehrbase.api.exception.ValidationException
ValidationException(String, Throwable) - Constructor for exception class org.ehrbase.api.exception.ValidationException
ValidationService - Interface in org.ehrbase.api.service: ValidationService
valueOf(String) - Static method in enum class org.ehrbase.api.definitions.OperationalTemplateFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.ehrbase.api.dto.experimental.ItemTagDto.ItemTagRMType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.ehrbase.api.service.TerminologyServer.SubsumptionResult: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.ehrbase.api.definitions.OperationalTemplateFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.ehrbase.api.dto.AqlQueryContext.EhrbaseMetaProperty: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.ehrbase.api.dto.experimental.ItemTagDto.ItemTagRMType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.ehrbase.api.service.ContributionService.ContributionChangeType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.ehrbase.api.service.TerminologyServer.SubsumptionResult: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.ehrbase.api.service.TerminologyServer.TerminologyAdapter: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class org.ehrbase.api.rest.HttpRestContext
VersionedCompositionDto - Record Class in org.ehrbase.api.dto: Response data of a VERSIONED_COMPOSITION.
VersionedCompositionDto(HierObjectId, ObjectRef<? extends ObjectId>, String) - Constructor for record class org.ehrbase.api.dto.VersionedCompositionDto: Creates an instance of a VersionedCompositionDto record class.
VersionedEhrStatusDto - Record Class in org.ehrbase.api.dto: Response data of a VERSIONED_EHR_STATUS.
VersionedEhrStatusDto(HierObjectId, ObjectRef<? extends ObjectId>, String) - Constructor for record class org.ehrbase.api.dto.VersionedEhrStatusDto: Creates an instance of a VersionedEhrStatusDto record class.
VersionedObjectService<T,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 - Enum constant in enum class org.ehrbase.api.definitions.OperationalTemplateFormat

A B C D E F G H I J K L M N O P Q R S T U V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form