Classes
Class EHRi Interface
EHRi Services
|
+--EHRi Interface
This class summarizes all the EHRi Interface Identifiers that are part of the generic EHRi Interface.
These attributes are common to all EHR Communication Step interactions between a Point of Service system and the EHRi.
| General Info |
| Name | EHRi Interface |
| Visibility | public |
| Active | false |
| Abstract | false |
| Leaf | false |
| Root | false |
| Owner | Classes |
Attribute Break The Glass Requestor ID
A unique identifier, identical to a EHRi User ID representing
the identity of a user who authorized an exceptional request to
override masked patient data and allow the data to be viewed in a
session.
This Id is:
- Part of the payload in an Unmask Patient Data transaction
- A subtype of EHRi User ID
| General Info |
| Name | Break The Glass Requestor ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHR Event ID
The identifier of the clinical event assigned after it is
recorded in the EHRi system by a PoS system.
- The EHR Event ID must be an OID
- An EHR Event Id may be referenced to get a details of a
specific event after a list transaction for example
Attribute EHRi Client ID - eCID
The ID that uniquely identifies a client in the EHRi where a
transaction is being conducted. It is used only internally within
the EHRi, and is never disclosed to POS applications.
- Each is a composite data element made up of the identifier of a
client identification domain and a meaningless but unique number
(MBUNs).
- Each eCID is an OID
- The eCID persists in the EHR Index and Repositories
- POS Applications will never see the Ecid
| General Info |
| Name | EHRi Client ID - eCID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi Domain ID
The identifier of the jurisdiction where one or more related EHRi Systems are instantiated.
Attribute EHRi Event Class
The event class represents an overarching classification that
stands as the highest topology of event items in the EHR
Event Class values include:
- Encounter Events
- Scheduling Events
- Clinical Act Events
- Workflow Events
| General Info |
| Name | EHRi Event Class |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi Interaction Type Identifier
A unique identifier representing the type of interaction to be invoked in the EHRi to execute a given transaction.
This field represents the "transaction call" to the EHRi from the perspective of the PoS application.
| General Info |
| Name | EHRi Interaction Type Identifier |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi Provider ID - EPID
A unique identifier representing the health professional involved in the health transaction that is requiring an interaction with the EHRi. This is meant to identify the health professional who is responsible for the clinical event occuring. It is managed by the EHRi Provider Registry and is established as part of the context of a transaction as the result of a resolution process. This resolution process is based on data provided by the PoS application to identify the provider.
| General Info |
| Name | EHRi Provider ID - EPID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi System ID
The ID of the EHRi System instance
- There are many EHRi System IDs for one EHRi Domain ID
- Must be the root of the OID scheme for EHR Event ID
Attribute EHRi Transaction Client ID
A temporary ID used by a PoS after a PoS has resolved a Public
Person Identifier (e.g. Health Card Number) with the Client
Registry. This ID is the patient/person who is the subject of the
access being performed by a provider This ID is only known as long
as the PoS session is active
Note: transactions that are not about a client may be also
conducted with the EHRi.
| General Info |
| Name | EHRi Transaction Client ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi User ID - EUID
A unique identifier representing the end-user involved with a PoS Application that is connecting to the EHRi. The EHRi user IDs are created and maintained by the EHRi as a function of its ongoing operational management. It is considered as an independent identifier from the ID used in a PoS Application. This identifier is established by the EHRi when a transaction begins and normally as part of the authentication process. It is the result of a resolution process involving data coming from the PoS application to describe who the active user is.
| General Info |
| Name | EHRi User ID - EUID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute EHRi User Role ID
A unique identifier representing the type of role assigned to an EHRi user in the context of a transaction. The role ID is established by the EHRi at the beginning of a transaction and is provided to the PoS application.
| General Info |
| Name | EHRi User Role ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute External Ecid
EHRi Client Identifiers representing the resolved identification of a client in another EHRi than the one where a transaction is being processed. Such External Ecids may be used to query other EHRis for data about the client.
Attribute PoS Application EHRi Session ID
A unique identifier representing a transaction session established between a POS Application and an EHRi at a given point in time to support an instance of a communication. This unique identifier is only valid for the duration of a single instance of a communication.
| General Info |
| Name | PoS Application EHRi Session ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute PoS Application Instance ID
A unique identifier of the PoS application that interacts with the EHRi system. These identifiers would be assigned by the jurisdictional administrators of an EHRi system
| General Info |
| Name | PoS Application Instance ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute PoS Application Location ID
A unique identifier of the location where the PoS system interacting with the EHRi is installed. These identifiers are assigned by administrators of an EHRi system implementation within a given jurisdiction to uniquely identify each location connecting to the EHRi.
| General Info |
| Name | PoS Application Location ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute PoS Application Organization ID
A unique identifier of the organization responsible for the operational management of the PoS system.
| General Info |
| Name | PoS Application Organization ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
Attribute PoS Application User ID
A unique identifier used by a PoS application to represent the active user involved when a transaction is made to the EHRi. Usually, it is the ID that a user of a PoS application uses to log into that PoS system or that application. Each PoS application user ID is the responsibility of the authority in charge of the operational management of that application.
| General Info |
| Name | PoS Application User ID |
| Owner | EHRi Interface |
| Changeability | changeable |
| Visibility | private |
| Ordering | unordered |
| Scope | instance |
