Package oracle.hsgbu.hdr.hl7.mastercatalog

During persistence all Act, Role and Entity objects are validated against the master catalog, which defines the allowable class code, mood code, determiner code, code, player entity, and/or scoper entity for these objects.

See: Description

Interface Summary

Interface	Description
ActMasterCatalogQueryCriteria
EntityMasterCatalogQueryCriteria
MasterCatalog
MasterCatalogFocalClassStateTransition
MasterCatalogQueryCriteria
MasterCatalogService
RoleMasterCatalogQueryCriteria

Package oracle.hsgbu.hdr.hl7.mastercatalog Description

During persistence all Act, Role and Entity objects are validated against the master catalog, which defines the allowable class code, mood code, determiner code, code, player entity, and/or scoper entity for these objects. Master Catalog defines the allowable ETS values for all Act, Role, and Entity objects used in an implementation or solution. The allowable values can either be explicit in the Master Catalog specifying the ID of the concept, or indicating that no values (null) are required, or that all ETS concepts are valid.

Classes in the Master Catalog package also handle state transitions. A state transition is defined as the change in state in an Act, Role, Entity during the create or update process. The transition occurs from a beginning state to an ending state for an Act, Role and Entity.

APIs in this service allows users to create, update and search master catalog and focal class state transition entries.

Determining the Focal Class

Each submission must have a valid focal class. The focal class is determined by the following rules:

• If the Act connected to the ControlAct by an outbound Subject (SUBJ) ActRelationship is not a Registry (REG) Act, then that Subject Act is the focal class.
• If the Subject Registry (REG) Act has a Subject (SBJ) Participation to either:
  • a Role with a null status code, or
  • an Identified Entity (IDENT) Role.
  then the focal class is the Role's player Entity.
• Otherwise, the focal class is the Role connected to the Registry (REG) Act by a Subject (SBJ) Participation.

Focal Class State Transition & Business Event Validation

The focal class state transition/Business Event validation is performed as follows:

1. Determine the focal class of the submission (see above).
2. Determine the state transition of the focal class object.
   
   • If the object is being created, the start state will be null, otherwise the start state will be the status code from the previous version of the object.
   • The end state will always be the status code on the focal class object.
3. Determine the MasterCatalog Id's of both the focal class object and the submission ControlAct.
4. Validate that there is a MasterCatalogFocalClassStateTransition entry with matching ControlAct MasterCatalogId, FocalClass MasterCatalogId, and a state transition from:
   • startState to endState
   • startState to 'any'
   • 'any' to endState
   • 'any' to 'any'
5. The Business Event code on the submission ControlAct must match the MasterCatalogFocalClassStateTransition.getTriggerEventCode() attribute.

Criteria based Search

This feature allows user to search Master Catalog entries based on search criteria. User can dynamically build criteria for one or more attributes.

The following are code examples to show basic Master Catalog Search Criteria creation:

(1a) Find all Act Master Catalog entries, for class code = "OBS" and mood code = "EVN"

// get an instance of the Master Catalog Act Criteria

ActMasterCatalogQueryCriteria actSearchCriteria = MasterCatalogFactory.getInstance().newActMasterCatalogQueryCriteria();

// set the class code

SearchTerm searchTerm = actSearchCriteria.equalsClassCode("OBS");

// set the mood code

searchTerm = actSearchCriteria.and(searchTerm, actSearchCriteria.equalsMoodCode("EVN"));

// set the root search term

actSearchCriteria.setRootSearchTerm(searchTerm);

// retrieve act master catalog entries

MasterCatalog [] fetchedMasterCatalog = masterCatalogService.findMasterCatalogEntries(actSearchCriteria);

(1b) Find Master Catalog Entry, for code type = "ID" and coding scheme name = "HTB Supplemental", coding scheme version name = "HTB Supplemental (2005-04-08)" and concept code = "001827"

// get an instance of the Master Catalog Criteria

MasterCatalogQueryCriteria masterCatalogSearchCriteria = MasterCatalogFactory.getInstance().newMasterCatalogQueryCriteria();

SearchTerm searchTerm = masterCatalogSearchCriteria.equalsCode("HTB Supplemental", "HTB Supplemental (2005-04-08)", "001827");

// set the code type to ID

searchTerm = masterCatalogSearchCriteria.and(searchTerm, masterCatalogSearchCriteria.equalsCodeType(MasterCatalog.ID_CODE_TYPE));

// set the root search term

masterCatalogSearchCriteria.setRootSearchTerm(searchTerm);

// retrieve master catalog entry

MasterCatalog [] fetchedMasterCatalog = masterCatalogService.findMasterCatalogEntries(masterCatalogSearchCriteria);

Master Catalog Cache Details

The Master Catalog API uses the CTBCacheService for caching the Master Catalog and Master Catalog Focal Class State Transition entries.

Following are the cache names used to store the objects

CtbCoreMcActEntriesCache - This is the cache name for Master Catalog Act entries.

CtbCoreMcEntityEntriesCache - This is the cache name for Master Catalog Entity entries.

CtbCoreMcRoleEntriesCache - This is the cache name for Master Catalog Role entries.

CtbCoreMcStTrnstnsCache - This is the cache name for Master Catalog Focal Class State Transition entries.