---
title: "Notifications corresponding to events during data flow"
method: POST
path: "/v0.5/health-information/notify"
tags: ["Gateway"]
---

# Notifications corresponding to events during data flow

`POST /v0.5/health-information/notify`

API called by HIU and HIP during data-transfer. 
1. HIP on transfer of data would send **sessionStatus** - one of [TRANSFERRED, FAILED]
2. HIP would also send **hiStatus** for each *careContextReference* - on of [DELIVERED, ERRORED]
3. HIU on receipt of data would send **sessionStatus** - one of [TRANSFERRED, FAILED]. For example, FAILED when if data was not sent or if invalid data was sent
4. HIU would also send **hiStatus** for each *careContextReference* - one of [OK, ERRORED]

## Headers

- `Authorization` string, required
- `X-CM-ID` string, required

## Request body

- HealthInformationNotification
  - `notification` object, required
    - `consentId` string, uuid, required
    - `doneAt` string, date-time, required
    - `notifier` object, required
      - `id` string
      - `type` 'HIU' | 'HIP'
    - `statusNotification` object, required
      - `hipId` string, required
      - `sessionStatus` 'TRANSFERRED' | 'FAILED', required
      - `statusResponses` object[]
        - `careContextReference` string, required
        - `description` string
        - `hiStatus` 'DELIVERED' | 'OK' | 'ERRORED', required
    - `transactionId` string, uuid, required
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request.
  - `timestamp` string, date-time, required — Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

## Response `204`

Notification is Accepted

## Other responses

- `400` — **Causes:** * Invalid Request
- `401` — **Causes:** * Expired/Invalid token.
- `500` — **Causes:** * Downstream system(s) is down. * Unhandled exceptions.

---

[API](https://skmtc.net/ndhm/apis/ndhm-hip.md) · [All operations](https://skmtc.net/ndhm/apis/ndhm-hip/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ndhm/ndhm-hip/versions/26beb7157b70/schema)