IDENTIFIER OBJECT
- Jim Roldan
- Pedro Jose Sanchez Luling
- Josep Benavent
TYPES OF IDENTIFIERS
GLOBALLY UNIQUE IDENTIFIERS
IDENTIFIERS are values that permit to identify unambiguosly a CONTACT (USER, CASE or ASSOCIATE).
An IDENTIFIER is basically a pair of [label, value] where label is the name of the IDENTIFIER, and value is the value assigned for a particular CONTACT OBJECT which must be unique among all existing CONTACTs.
For example consider the "NAT_ES" IDENTIFIER (Spanish National Identifier): if a CONTACT has assigned the value "73738873X", then it is not possible to assign the same value for "NAT_ES" to another CONTACT.
Therefore, the restrictions are:
A CONTACT cannot have the same IDENTIFIER assigned twice with different values
Two different CONTACT OBJECT cannot have the same value
SUBSCRIPTION IDENTIFIERS
There exists a situation where it may be necessary to modify the 'uniqueness' restrictions so that they only apply into a particular SUBSCRIPTION. Therefore the uniqueness rules would be:
A CONTACT cannot have the same IDENTIFIER assigned twice with different values into the same SUBSCRIPTION
Two different CONTACT OBJECT cannot have the same value into the same SUBSCRIPTION
For this purpose, some IDENTIFIERS are categorized as "SUBSCRIPTION IDENTIFIERS". A SUBSCRIPTION is identified by a PROGRAM and a TEAM, and the "uniqueness" restriction is applied only into the same PROGRAM/TEAM
Currently only the following IDENTIFIERS are considered as "SUBSCRIPTION IDENTIFIERS":
Label | Description |
|---|---|
STUDY_REF | Normally used in medical trials where CASES are anonymous and a sequential number is assigned to identify each CASE. |
SUBSCRIPTION IDENTIFIERS can only be edited by a user with role "SERVICE" in the SUBSCRIPTION
TEAM IDENTIFIERS
TEAM IDENTIFIERS are used to ensure the uniqueness for a specific TEAM.
One of the advantages of these IDENTIFIERS is that it allows to have a unique ID across different SUBSCRIPTIONS where a particular TEAM is member. For example consider the following 'real-life' situation:
We have a project to perform a COVID19 antigen test to the participants of an event (e.g. a meeting) that will last several days. It is necessary to perform an antigen test each day to grant access to the event. Each participant has been provided with an anonymous identifier (participant reference). This identifier will be used to associate the antigen tests to each participant. Then, when the participant wants to go to the event, the organization can use the identifier to check if the antigen test was done and which was the last result. The identifier assigned to each participant is a sequential number, and we can only guarantee that it will be unique for this event. Due to the large amount of participants, we want to set several centers to perform the antigen tests (different SUBSCRIPTIONS), so that the members of each center can only see their own participants. We could use a SUBSCRIPTION IDENTIFIER to create each ADMISSION, but in this situation the Linkcare platform would create a different CASE if the same participant goes to different centers. This means that the system would consider that each test (ADMISSION) belongs to a different CASE instead of creating a unique CASE with all the ADMISSIONS. What we really want is to associate all the antigen tests of the same person to an unique CASE, so that a supervisor that has access to all the centers can see the list of all the participants and how many tests has each one. |
|---|
A TEAM IDENTIFIER allows to share the same value across different SUBSCRIPTIONS by associating the value to a particular TEAM.
TEAM IDENTIFIERS are sored as the concatenation of the identifier value and a TEAM CODE. For example, if the identifier has a value of 1234 and is associated to the TEAM "EEIB", it would be stored as "1234@EEIB"
To use TEAM IDENTIFIERS it is necessary to specify the name of the common TEAM in the definition of the FORMAT SETTINGS that will be used in each SUBSCRIPTION.
The following table shows the IDENTIFIERS currently considered as "TEAM IDENTIFIERS":
Label | Description |
|---|---|
PARTICIPANT_REF | This is the recommended IDENTIFIER for assigning unique references for patients in the context of a TEAM. Typical use case: When we want to store the reference assigned to the patients in an external HIS. In this case, the TEAM related with the IDENTIFIER could be the Hospital Organization |
EMPLOYEE_REF | This is the recommended IDENTIFIER for assigning unique references for professionals (doctor, nurse...) in the context of a TEAM. Typical use case: When we want to store the reference assigned to a professional in an external HIS. In this case, the TEAM related with the IDENTIFIER could be the Hospital Organization. Introduced in API Version 2.7.27 |
HR_REF | Reference to a Health Record number |
Edit permission
A TEAM IDENTIFIER is only editable when:
The TEAM IDENTIFIER has not been imported from a third party system (e.g. HIS). In this case, only an update received from the external system can modify the value
AND The TEAM IDENTIFIER is not self-generated.
AND The active user is
the patient to whom the IDENTIFIER is assigned to
or a professional with one of the following roles in the TEAM associated to the of the IDENTIFIER: CASE MANAGER, SERVICE, TEAM_MANAGER (direct member or indirect).
IDENTIFIER PROPERTIES
PROPERTY | TYPE | ||
|---|---|---|---|
#IDENTIFIER.CONTACT | Contact reference | Ref | See CONTACT OBJECT |
#IDENTIFIER.LABEL | Choice of IDENTIFIER code | String | An identifier label. See IDENTIFIER CODES |
#IDENTIFIER.COUNTRY | Country | COUNTRY CODE | See COUNTRY CODES and IDENTIFIER SETTINGS |
#IDENTIFIER.PROGRAM | Program reference | Ref | |
#IDENTIFIER.TEAM | Team reference | Ref | |
#IDENTIFIER.VALUE | An IDENTIFIER value | String |