Go To AIH-HSP Data Types

1 Definition 2 Functional Requirements 3 Syntax 4 Semantics 5 Conformance Testing 6 Performance Assessment

A Third-Party User may also register as an individual who is a member of an organisation: a User Profile with a Membership. The Health Front End and the Health Back End do for it what they do for a Third-Party User Profile.

1 Definition

The Third-Party User Profile includes all data required for the Registration with a Health Back End of a Third-Party User: an entity, not an End User, that registers to process AIH Data under the terms of the Smart Contracts.

2 Functional Requirements

The Third-Party User Profile includes:

  1. The identifier of the Third-Party User.
  2. Who the Third-Party User is: always an organisation (name, registration code, address, country, email).
  3. What it asks to be able to do (Entitlements): its types, the classes and status of the AIH Data, the processing, the anomalies and the usage, so that the Health Back End can compare them with a licence.

3 Syntax

https://schemas.mpai.community/AIH1/V1.1/data/ThirdPartyUserProfile.json

4 Semantics

Label Description
Header Third-Party User Profile Header, Standard “AIH-TPU-Vx.y”
MInstanceID Identifier of M-Instance.
UEnvironmentID Identifier of U-Environment.
ThirdPartyUserID Identifier of the Third-Party User.
ThirdPartyUserProfileID Identifier of the Third-Party User Profile.
ThirdPartyUserProfileTime Time info of the Third-Party User Profile.
ThirdPartyUserProfileData Who the Third-Party User is. It is always an organisation.
– CompanyName Company name.
– RegistrationCode Registration code issued by the country of the company.
– Address Address.
– Country Country of registration.
– Email Email address.
Entitlements What the Third-Party User asks to be able to do. A licence (ThirdPartyUserLicence of the Model Licence) shall be inside it for the Health Back End to allow an operation.
– UserTypes Which kind of entity the Third-Party User is, by the AIH Taxonomies.
– DataClasses The classes of AIH Data it wants to process, by the AIH Taxonomies.
– DataStatus The status in which it is to receive the data: anonymised, pseudonymised or identified, by the AIH Taxonomies.
– ProcessTypes The processing it will ask for, by the AIH Data Processing Type.
– AnomalyTypes The kinds of anomaly it is to look for (optional), by the AIH Taxonomies.
– UsageTypes The usage it states for the results, by the AIH Taxonomies.
DataXMData Information about this Third-Party User Profile Instance.
DescrMetadata Descriptive Metadata.

5 Conformance Testing

A Data instance Conforms with Third-Party User Profile (AIH-TPU) if:

  1. Its JSON Object validates against its JSON Schema.
  2. Any included JSON Object validates against its JSON Schema.
  3. All Data in the JSON Object:
    1. Have the specified Data Types.
    2. Conform with the Qualifiers signaled in their JSON Schemas.

6 Performance Assessment

Go To AIH-HSP Data Types