---
title: "Notification to HIU on basis of a granted subscription"
method: POST
path: "/v0.5/subscriptions/hiu/notify"
tags: ["subscriptions", "cm facing"]
---

# Notification to HIU on basis of a granted subscription

`POST /v0.5/subscriptions/hiu/notify`

This API is used by CM to notify a HIU for notification relevant to subscription. Notifications are sent to subscribed HIUs whenever a new care-context is linked or new data is available on an existing linked care-context. 
1. if event.category = LINK, then only care-contexts are passed when new care-contexts are linked for patient. 
2. If event.category = DATA, then hiTypes are passed. Care-context is passed only if the subscribed HIU has any valid consent for that care-context

## Headers

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

## Request body

- HIUSubscriptionNotification
  - `event` object, required
    - `category` 'LINK', required
    - `content` HIUSubscriptionEventContent, required
      - `context` EventCategoryDetail[], required
        - `careContext` CareContextDefinition, required
          - `careContextReference` string, required
          - `patientReference` string, required
        - `hiTypes` HITypeEnum[], required
      - `hip` OrganizationRepresentation, required
        - `id` string, required
      - `patient` ConsentManagerPatientID, required
        - `id` string, <user-id>@ndhm
    - `id` string, uuid, required
    - `published` string, date-time, required — Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ
    - `subscriptionId` string, 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 `202`

Request Accepted

## Other responses

- `400` — **Causes:** * Invalid data sent * Required attributes not mentioned
- `401` — **Causes:** * Expired/Invalid token.
- `500` — **Causes:** * Downstream system(s) is down. * Unhandled exceptions.

---

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