Linkage platform

[marta-]

The linkage platform is a secure system that allows to re-identify the original subjects.

UI: Allows the researcher to upload a list of eGUIDs (initial version: paste eGUIDs one per line in a text box).

Backend: the eGUIDs are sent to an internal service that:

• Decrypts the eGUID using the private key;
• Takes alternating bytes to retrieve original GUID;
• Looks up GUID in a table with LE IDs to retrieve the corresponding ID;
• Looks up matching administrative data with LE ID and returns it to the researcher.

[IntegralProgrammer]

Required HTTP Endpoints for Linkage Platform

• /add_leid_guid - Stores, in a database, a mapping(s) between a Linkage Entity ID (LEID) and a Global Unique Identifier (GUID).
  • This API endpoint is to be used by the (external) Data Custodian GUID App
  • Example request:

    HTTP POST
    /add_leid_guid
    Content-Type: application/json
    [
    {"leid": "abc", "guid": "123"},
    {"leid": "def", "guid": "456"}
    {"leid": "ghi", "guid": "789"}
    ]

• /add_leid_admin_data - Stores, in a database, administrative data associated with a Linkage Entity ID (LEID)
  • This API endpoint is to be used by the (internal) Web UI which the Data Custodian uses to add administrative data associated with a Linkage Entity ID (LEID)
  • Please note that this endpoint may be removed and replaced with a CARDS instance where the CARDS Subject Identifiers are set to the LEIDs and the associated CARDS Forms contain the LEID-associated administrative data.
  • Example request:

    HTTP POST
    /add_leid_admin_data
    Content-Type: application/json
    [
    {
    "leid": "abc",
    "admin_data": { ...admin_data_goes_here }
    }.
    {
    "leid": "def",
    "admin_data": { ...admin_data_goes_here }
    }.
    ...
    ]

• /import_eguid_research_data - Stores, in a database, the imported research data tagged with the eGUIDs for the research subjects
  • Returns a unique identifier for the imported research data.
  • This API endpoint is to be used by the (internal) Web UI which the Data Analyst uses to upload their eGUID tagged data.
  • Example request:

    HTTP POST
    /import_eguid_research_data
    Content-Type: application/json
    {
    "eguid": "8098fd8re8908fe324",
    "data": { ...data_goes_here }
    }

• /get_linked_admin_data - Returns all the administrative data that is associated with previously imported data
  • Note: It is unclear who is allowed to use this endpoint
  • Example request:

    HTTP GET
    /get_linked_admin_data?research_data=a1b2c3d4e5f6g7

[IntegralProgrammer]

Revised Required HTTP Endpoints for Linkage Platform

• /leid (POST) - add mapping(s) between LEID(s) and GUID(s)

  Content-Type: application/json
  [
  {"leid": "abc", "guid": "123"},
  {"leid": "def", "guid": "456"}
  {"leid": "ghi", "guid": "789"}
  ]

• /leid (GET) - show the mappings between LEIDs and GUIDs that this user has permission to view

• /admin_data/<LEID> (POST) - adds administrative data for the given LEID

  Content-Type: application/json
  {
  "admin_data_001": "value_001",
  "admin_data_002": "value_002"
  }

• /admin_data/<RESEARCH_DATA_ID> (GET) - return the administrative data for the given _RESEARCH_DATAID provided that this request is properly authorized

• /research_data (POST) - add research data tagged with eGUIDs

  Content-Type: application/json
  {
  "eguid": "8098fd8re8908fe324",
  "data": { ...data_goes_here }
  }

• /research_data (GET) - list the research datasets that the user has permission to access

• /research_data/<RESEARCH_DATA_ID> (GET) - download the research dataset identified by _RESEARCH_DATAID provided that the request is properly authorized