API for HIP initiated care-context linking for patient

v1.0.0

API to submit care-context to CM for HIP initiated linking. The API must accompany the "accessToken" fetched in the users/auth process.

subsequent usage for accessToken may be invalid if it was meant for one-time usage or if it expired

Input

{
  "type": "object",
  "required": [
    "link",
    "requestId",
    "timestamp"
  ],
  "properties": {
    "link": {
      "type": "object",
      "required": [
        "accessToken",
        "patient"
      ],
      "properties": {
        "accessToken": {
          "type": "string",
          "description": "AccessToken fetched in the user auth process for the purpose specified"
        },
        "patient": {
          "type": "object",
          "required": [
            "careContexts",
            "display",
            "referenceNumber"
          ],
          "properties": {
            "careContexts": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "referenceNumber",
                  "display"
                ],
                "properties": {
                  "display": {
                    "type": "string"
                  },
                  "referenceNumber": {
                    "type": "string"
                  }
                }
              }
            },
            "display": {
              "type": "string"
            },
            "referenceNumber": {
              "type": "string",
              "description": "patient reference id at HIP"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "a nonce, unique for each HTTP request"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ"
    }
  }
}

Output

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