---
title: "Request for subscription"
method: POST
path: "/v0.5/subscription-requests/cm/init"
tags: ["subscriptions"]
---

# Request for subscription

`POST /v0.5/subscription-requests/cm/init`

creates a request for subscription. The subscription categories can be for care-contexts linkages or availability of data against existing care-contexts. Note that the requester must have HIU role

## Headers

- `Authorization` string, required

## Request body

- SubscriptionRequest
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request.
  - `subscription` object, required
    - `categories` SubscriptionCategory[], required
    - `hips` OrganizationRepresentation[]
      - `id` string, required
    - `hiu` OrganizationRepresentation, required
      - `id` string, required
    - `patient` ConsentManagerPatientID, required
      - `id` string, <user-id>@<ndhm>, required
    - `period` SubscriptionPeriod, required
      - `from` string, date-time, required
      - `to` string, date-time, required
    - `purpose` UsePurpose, required
      - `code` string, required — From the fixed set, documented at refUri
      - `refUri` string, uri
      - `text` string, required
  - `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-cm.md) · [All operations](https://skmtc.net/ndhm/apis/ndhm-cm/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ndhm/ndhm-cm/versions/ae271fcd89d7/schema)