Classes
Class EHR Index Services

Business Services
   |
   +--EHR Index Services

The EHR Index records summary information about patient clinical events recorded in the EHR. It maintains a sequential list of all events that affect the client / patient. It also provides the location where the data relevant to each event is kept in the EHRi. It can be used to retrieve the history of events for a client or to trace the information about a specific event.

General Info
Name	EHR Index Services
Visibility	public
Active	false
Abstract	false
Leaf	false
Root	false
Owner	Classes

Operations
Name	Return Type
Get EHR Index Event()
List EHR Index Events()
Put Deactivate EHR Index Event()
Put New EHR Index Event()
Put Update EHR Index Event()

Relations
Name	Type	Begins	Ends
	generalization	EHR Index Services	Business Services

---

Operation  Get EHR Index Event

Allows a calling service to obtain the detailed metadata about a single event in the EHR Index. Since events in the EHR Index can be nested, this may return a structure containing the data of multiple events. Parameters when invoking this service include the specific Event ID of the event being accessed. EHR index data must have been queried prior to this service being used.

General Info
Name	Get EHR Index Event
Owner	EHR Index Services
Concurrency	sequential
Query	false
Visibility	public
Scope	instance
Abstract	false
Leaf	false
Root	false

---

Operation  List EHR Index Events

Allows a calling service to obtain a list of events from the EHR Index. Parameters when invoking this service focus on search parameters including client, provider, location ID, date range, type or type(s) or events, type or types of medical acts tracked by the EHR Index. The response includes basic data about each event including URLs usable to query the details of any single event found in the Index.

General Info
Name	List EHR Index Events
Owner	EHR Index Services
Concurrency	sequential
Query	false
Visibility	public
Scope	instance
Abstract	false
Leaf	false
Root	false

---

Operation  Put Deactivate EHR Index Event

This transaction is triggered by a domain repository service as part of the process to complete a clinical data delete transaction. As a principle, data in the EHR is never deleted, rather, it is identified as being inactive or logically deleted. The LRS will search for the existing original event, turn its status to inactive, create a new special type of event to identify this data record in the client EHR as deleted along with the specific subject identifiers describing the context of the deletion including client, provider, location, user, PoS application, source ID. It would also link this new delete event to the EHR Index entry being inactivated. Any subsequent queries towards the LRS EHR Index not find this data as part of the EHR of the client. Special types of maintenance processes can be used to access these records for audit, archiving purposes.

General Info
Name	Put Deactivate EHR Index Event
Owner	EHR Index Services
Concurrency	sequential
Query	false
Visibility	public
Scope	instance
Abstract	false
Leaf	false
Root	false

---

Operation  Put New EHR Index Event

Allows invoking the EHR Index to record a new event entry in it. This transaction is triggered by a domain repository service as part of the process to complete a clinical data insert (or create) transaction and its goal is to make the EHR Index aware of the existence of the new piece of data relevant to a client’s EHR. Invocation parameters include all of the data and metadata maintained by the EHR Index. This data includes basic subject identifiers (client, provider, location, user, pos application, source id) as well as event typing data so that the event is adequately categorised and searchable in the Index. The data created as part of an Index entry also includes a Unique Resource Identifier (URI) acting as the callable address to be used later in the context of access transactions to this specific event. See functioning principles for details. The LRS will search for any existing duplicate to protect integrity of the EHR Index and proceed to create a new event with an active status. Any subsequent queries towards the LRS EHR Index would be able to find the newly available data in the person’s EHR.

General Info
Name	Put New EHR Index Event
Owner	EHR Index Services
Concurrency	sequential
Query	false
Visibility	public
Scope	instance
Abstract	false
Leaf	false
Root	false

---

Operation  Put Update EHR Index Event

This transaction is triggered by a domain repository service as part of the process to complete a clinical data update transaction. This transaction pattern is used to complete a clinical data update transaction. The LRS will search for the existing original event, turn its status to inactive, create a new event and link the new and old events. Any subsequent queries towards the LRS EHR Index should only find the corrected and most up-to-date event as active.

General Info
Name	Put Update EHR Index Event
Owner	EHR Index Services
Concurrency	sequential
Query	false
Visibility	public
Scope	instance
Abstract	false
Leaf	false
Root	false