Go To AIH-HSP Data Types

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

The Health Front End and the Health Back End treat the User Profile in a Register Request as follows: a User Profile of an individual is an End User; a User Profile of an individual who states a Membership, or a Third-Party User Profile, is a Third-Party User. The Health Back End’s Register Response carries the Tokens of the services that Profile allows. A Register Request and its Response travel between the Controllers of the Health Front End and the Health Back End.

1 Definition

Register Request is a Data Type that a User employs to Register with the Health Back End directly – if a Third Party User – or via a Health Front End – if an End User.

Register Response is the Health Back End response to the Register Request.

2 Functional Requirements

Request includes:

  1. User Profile, if the User is an End User, or Third-Party User Profile, if the User is a Third-Party User (one of the two)
  2. Requested Services

Response includes:

  1. Yes/No response
  2. Registration Token.

3 Syntax

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

4 Semantics

Label Description
Header Register Header, Standard “AIH-REG-Vx.y”
MInstanceID Identifier of M-Instance.
UEnvironmentID Identifier of U-Environment.
RegisterID Identifier of  Register.
RegisterTime Time of Registration
RegisterData Set of Register Data.
– Request Data included in the Request.
– – UserProfile User Profile of the End User registering. Present instead of ThirdPartyUserProfile when an End User registers.
– – ThirdPartyUserProfile Third-Party User Profile (AIH-TPU): the Third-Party User registering and what it asks to be able to do (entitlements). Present instead of UserProfile when a Third-Party User registers.
– – RequestedServices List of Services for which access is requested.
– – – Service See ProcessTypes.
– Response Data include in the Response.
– – Success Registration outcome (boolean, 0=failure)
– – Tokens Tokens enabling Registering User to access the corresponding Services.
DataXMData Information about this Register Instance.
DescrMetadata Descriptive Metadata

5     Conformance Testing

A Data instance Conforms with Register (AIH-REG) 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