Response to patient's care context link request

v1.0.0

Result of patient care-context link request from HIP end. This happens in context of previous discovery of patient found at HIP end, therefore the link requests ought to be in reference to the patient reference and care-context references previously returned by the HIP. The correlation of discovery and link request is maintained through the transactionId. HIP should have

Validated transactionId in the request to check whether there was a discovery done previously, and the link request corresponds to returned patient care care context references
Before returning the response, HIP should have sent an authentication request to the patient(eg: OTP verification)
HIP should communicate the mode of authentication of a successful request
HIP subsequently should expect the token passed via /link/confirm against the link.referenceNumber passed in this call

The error section in the body, represents the potential errors that may have occurred. Possible reasons:

Patient reference number is invalid
Care context reference numbers are invalid

Input

{
  "type": "object",
  "required": [
    "requestId",
    "resp",
    "timestamp",
    "transactionId"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "enum": [
            1000,
            10001
          ]
        },
        "message": {
          "type": "string"
        }
      }
    },
    "link": {
      "type": "object",
      "required": [
        "authenticationType",
        "referenceNumber"
      ],
      "properties": {
        "authenticationType": {
          "type": "string",
          "enum": [
            "DIRECT",
            "MEDIATED"
          ]
        },
        "meta": {
          "type": "object",
          "required": [
            "communicationMedium"
          ],
          "properties": {
            "communicationExpiry": {
              "type": "string"
            },
            "communicationHint": {
              "type": "string"
            },
            "communicationMedium": {
              "type": "string",
              "enum": [
                "MOBILE",
                "EMAIL"
              ]
            }
          }
        },
        "referenceNumber": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "a nonce, unique for each HTTP request"
    },
    "resp": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid",
          "description": "the requestId that was passed"
        }
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ"
    },
    "transactionId": {
      "type": "string",
      "format": "uuid"
    }
  }
}

Output

{
  "type": "object",
  "additionalProperties": true
}