ndhm-hrp 2.2.38 → 3.0.0

package/lib/classes/discovery.d.ts

@@ -1,24 +1,57 @@
 import Header from "./header";
+declare type HI_TYPES = "OPConsultation" | "DiagnosticReport" | "Prescription" | "ImmunizationRecord" | "DischargeSummary" | "HealthDocumentRecord" | "WellnessRecord" | "InitialAssessment" | "DietaryRecord";
 export default class Discovery extends Header {
     constructor(_baseUrl: string, _accessToken: string);
     /**
-     * Result of patient care-context discovery request at HIP end. If a matching patient found with zero or more care contexts associated, it is specified as result attribute. If the prior discovery request, resulted in errors then it is specified in the error attribute. Reasons of errors can be
-     * @param config  body
-     * @returns
+     * HMIS/LMIS response to the HIE-CM discovery callback (User Initiated Linking v3).
+     *
+     * Called by the HIP after receiving the discovery callback at
+     * `{callback_url}/api/v3/hip/patient/care-context/discover` (section 5.3.2).
+     * The HIP searches its records and returns matching patients with their
+     * associated care contexts, HI type, and count. If no match is found, an
+     * error is returned instead.
+     *
+     * Uses the v3 endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.3):
+     * `POST /api/hiecm/user-initiated-linking/v3/patient/care-context/on-discover`
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+     * @param config.transactionId - Transaction ID from the HIE-CM discovery callback, used for correlation
+     * @param config.patients - Array of matched patient entries, each with:
+     *   - referenceNumber - Patient reference in HIP system
+     *   - display - Display name for the patient
+     *   - careContexts - Array of { referenceNumber, display }
+     *   - hiType - Type of health information (HI_TYPES)
+     *   - count - Number of care contexts
+     * @param config.matchedBy - Array of matching criteria used (e.g. ["MR", "NAME", "DOB"])
+     * @param config.callbackRequestId - The `requestId` from the HIE-CM discovery callback, sent in `response.requestId`
+     * @param config.error - Optional error object if no matching patient was found (code, message)
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @returns The request body that was sent (for logging/reference)
      */
     onDiscovery: (config: {
+        healthId: string;
         transactionId: string;
-        patientReferenceNumber: string;
-        patientDisplay: string;
-        careContexts: {
+        patients?: Array<{
             referenceNumber: string;
             display: string;
-        }[];
-        matchedBy: string[];
-        errCode?: string;
-        errMessage?: string;
-        requestId: string;
-        healthId: string;
+            careContexts: Array<{
+                referenceNumber: string;
+                display: string;
+            }>;
+            hiType: HI_TYPES;
+            count: number;
+        }>;
+        matchedBy?: string[];
+        callbackRequestId: string;
+        error?: {
+            code: string;
+            message: string;
+        };
+        requestId?: string;
+        timestamp?: string;
     }) => Promise<any>;
 }
+export {};
 //# sourceMappingURL=discovery.d.ts.map

package/lib/classes/discovery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../../src/classes/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAI9B,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,MAAM;gBAC/B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAGlD;;;;OAIG;IACH,WAAW,WAAkB;QAC3B,aAAa,EAAE,MAAM,CAAC;QACtB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE;YAAE,eAAe,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAC7D,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;KAClB,kBAiCC;CACH"}
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../../src/classes/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAI9B,aAAK,QAAQ,GACT,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,gBAAgB,GAChB,mBAAmB,GACnB,eAAe,CAAC;AAEpB,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,MAAM;gBAC/B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAIlD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,WAAW,WAAkB;QAC3B,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM;YACf,eAAe,EAAE,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC;YAChB,YAAY,EAAE,MAAM;gBAClB,eAAe,EAAE,MAAM,CAAC;gBACxB,OAAO,EAAE,MAAM,CAAC;aACjB,CAAC,CAAC;YACH,MAAM,EAAE,QAAQ,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;QACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,kBAiCC;CACH"}

package/lib/classes/discovery.js

@@ -19,38 +19,62 @@ class Discovery extends header_1.default {
     constructor(_baseUrl, _accessToken) {
         super(_baseUrl, _accessToken);
         /**
-         * Result of patient care-context discovery request at HIP end. If a matching patient found with zero or more care contexts associated, it is specified as result attribute. If the prior discovery request, resulted in errors then it is specified in the error attribute. Reasons of errors can be
-         * @param config  body
-         * @returns
+         * HMIS/LMIS response to the HIE-CM discovery callback (User Initiated Linking v3).
+         *
+         * Called by the HIP after receiving the discovery callback at
+         * `{callback_url}/api/v3/hip/patient/care-context/discover` (section 5.3.2).
+         * The HIP searches its records and returns matching patients with their
+         * associated care contexts, HI type, and count. If no match is found, an
+         * error is returned instead.
+         *
+         * Uses the v3 endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.3):
+         * `POST /api/hiecm/user-initiated-linking/v3/patient/care-context/on-discover`
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+         * @param config.transactionId - Transaction ID from the HIE-CM discovery callback, used for correlation
+         * @param config.patients - Array of matched patient entries, each with:
+         *   - referenceNumber - Patient reference in HIP system
+         *   - display - Display name for the patient
+         *   - careContexts - Array of { referenceNumber, display }
+         *   - hiType - Type of health information (HI_TYPES)
+         *   - count - Number of care contexts
+         * @param config.matchedBy - Array of matching criteria used (e.g. ["MR", "NAME", "DOB"])
+         * @param config.callbackRequestId - The `requestId` from the HIE-CM discovery callback, sent in `response.requestId`
+         * @param config.error - Optional error object if no matching patient was found (code, message)
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @returns The request body that was sent (for logging/reference)
          */
         this.onDiscovery = (config) => __awaiter(this, void 0, void 0, function* () {
-            const headers = this.headers(config.healthId);
-            const url = `${this.baseUrl}v0.5/care-contexts/on-discover`;
+            var _a, _b;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_a = config.requestId) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
+                TIMESTAMP: (_b = config.timestamp) !== null && _b !== void 0 ? _b : new Date().toISOString(),
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/user-initiated-linking/v3/patient/care-context/on-discover`;
             const body = {
-                requestId: (0, uuid_1.v4)(),
-                timestamp: new Date().toISOString(),
                 transactionId: config.transactionId,
-                patient: {
-                    referenceNumber: config.patientReferenceNumber,
-                    display: config.patientDisplay,
-                    careContexts: config.careContexts,
-                    matchedBy: config.matchedBy,
-                },
-                resp: {
-                    requestId: config.requestId,
+                response: {
+                    requestId: config.callbackRequestId,
                 },
             };
-            if (config.errCode) {
-                body.error = {
-                    code: config.errCode,
-                    message: config.errMessage || "Error occured",
-                };
+            if (config.error) {
+                body.error = config.error;
+            }
+            else {
+                body.patient = config.patients;
+                body.matchedBy = config.matchedBy;
             }
             yield new request_1.default().request({
-                headers: headers,
+                headers,
                 method: "POST",
                 requestBody: body,
-                url: url,
+                url,
             });
             return body;
         });

package/lib/classes/discovery.js.map

@@ -1 +1 @@
-{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../src/classes/discovery.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAA8B;AAC9B,+BAAoC;AACpC,wDAAgC;AAEhC,MAAqB,SAAU,SAAQ,gBAAM;IAC3C,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEhC;;;;WAIG;QACH,gBAAW,GAAG,CAAO,MAUpB,EAAE,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,gCAAgC,CAAC;YACxD,MAAM,IAAI,GAAQ;gBACpB,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,OAAO,EAAE;oBACP,eAAe,EAAE,MAAM,CAAC,sBAAsB;oBAC9C,OAAO,EAAE,MAAM,CAAC,cAAc;oBAC9B,YAAY,EAAE,MAAM,CAAC,YAAY;oBACjC,SAAS,EAAE,MAAM,CAAC,SAAS;iBAC5B;gBAED,IAAI,EAAE;oBACJ,SAAS,EAAE,MAAM,CAAC,SAAS;iBAC5B;aACF,CAAC;YACF,IAAI,MAAM,CAAC,OAAO,EAAE;gBAClB,IAAI,CAAC,KAAK,GAAG;oBACX,IAAI,EAAE,MAAM,CAAC,OAAO;oBACpB,OAAO,EAAE,MAAM,CAAC,UAAU,IAAI,eAAe;iBAC9C,CAAC;aACH;YAED,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;IAjDF,CAAC;CAkDF;AArDD,4BAqDC"}
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../src/classes/discovery.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAA8B;AAC9B,+BAAoC;AACpC,wDAAgC;AAahC,MAAqB,SAAU,SAAQ,gBAAM;IAC3C,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAGhC;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,gBAAW,GAAG,CAAO,MAqBpB,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,sEAAsE,CAAC;YAElG,MAAM,IAAI,GAAQ;gBAChB,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,QAAQ,EAAE;oBACR,SAAS,EAAE,MAAM,CAAC,iBAAiB;iBACpC;aACF,CAAC;YAEF,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;iBAAM;gBACL,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC;gBAC/B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;aACnC;YAED,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;IApFF,CAAC;CAqFF;AAxFD,4BAwFC"}

package/lib/classes/link.d.ts

@@ -3,105 +3,195 @@ declare type HI_TYPES = "OPConsultation" | "DiagnosticReport" | "Prescription" |
 export default class Link extends Header {
     constructor(_baseUrl: string, _accessToken: string);
     /**
+     * Adds care contexts to a patient's ABHA account using the v3 HIE-CM endpoint.
      *
-     * @param config healthis with Xcmid
-     * @returns
+     * This replaces the deprecated v0.5 `AddContext` method. It requires a
+     * `linkToken` (obtained via `generateToken`) and sends patient care-context
+     * data with `hiType` and `count` fields.
+     *
+     * Headers are built inline following the existing `generateToken` v3 pattern.
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's health ID used to derive X-CM-ID header
+     * @param config.hipId - HIP ID sent as X-HIP-ID header
+     * @param config.linkToken - Link token obtained from HIE-CM token generation
+     * @param config.abhaNumber - Patient's ABHA number
+     * @param config.abhaAddress - Patient's ABHA address
+     * @param config.patients - Array of patient care-context entries, each with:
+     *   - referenceNumber - Patient reference (encounter ID) in HIP system
+     *   - display - Display name for the patient
+     *   - careContexts - Array of { referenceNumber, display }
+     *   - hiType - Type of health information (HI_TYPES)
+     *   - count - Number of care contexts
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @returns The parsed API response
      */
-    AddContext: (config: {
+    addCareContext: (config: {
         healthId: string;
-        careContextAccessToken: string;
-        patientId: string;
-        patinetDisplay: string;
-        careContextId: string;
-        careContextDisplay: string;
-    }) => Promise<{
-        requestId: string;
-        timestamp: string;
-        link: {
-            accessToken: string;
-            patient: {
+        hipId: string;
+        linkToken: string;
+        abhaNumber: string;
+        abhaAddress: string;
+        patients: Array<{
+            referenceNumber: string;
+            display: string;
+            careContexts: Array<{
                 referenceNumber: string;
                 display: string;
-                careContexts: {
-                    referenceNumber: string;
-                    display: string;
-                }[];
-            };
-        };
-    }>;
+            }>;
+            hiType: HI_TYPES;
+            count: number;
+        }>;
+        requestId?: string;
+        timestamp?: string;
+    }) => Promise<any>;
     /**
-     * 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
-     * @param config
-     *
-     * 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
+     * HMIS/LMIS response to the HIE-CM callback for user-initiated linking (v3).
+     *
+     * This is called by the HIP in response to the discovery callback (section 5.3.2).
+     * The HIP validates the transactionId against a previous discovery, sends an
+     * authentication request to the patient (e.g. OTP), and returns the link
+     * reference number with authentication metadata. The patient subsequently passes
+     * the token via `/link/care-context/confirm` against the `link.referenceNumber`.
+     *
+     * Uses the v3 HIE-CM endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.7):
+     * `POST /api/hiecm/user-initiated-linking/v3/link/care-context/on-init`
+     *
+     * Possible errors returned:
+     * - Patient reference number is invalid
+     * - Care context reference numbers are invalid
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+     * @param config.transactionId - Transaction ID from the discovery callback, used for correlation
+     * @param config.referenceNumber - Link reference number generated by the HIP for this linking attempt
+     * @param config.authenticationType - Authentication type: "DIRECT" or "MEDIATE"
+     * @param config.communicationMedium - Medium for patient communication (e.g. "MOBILE")
+     * @param config.communicationHint - Hint for the communication (e.g. "OTP")
+     * @param config.communicationExpiry - ISO timestamp for communication expiry (defaults to 10 min from now)
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @param config.callbackRequestId - The `requestId` from the HIE-CM discovery callback, sent in `response.requestId`
+     * @param config.error - Optional error object if the HIP cannot process the link request
+     * @returns The request body that was sent (for logging/reference)
      */
     onInit: (config: {
         healthId: string;
         transactionId: string;
         referenceNumber: string;
+        authenticationType: "DIRECT" | "MEDIATE";
+        communicationMedium: string;
         communicationHint: string;
         communicationExpiry?: string;
-        requestId: string;
+        requestId?: string;
+        timestamp?: string;
+        callbackRequestId: string;
         error?: {
             code: number;
             message: string;
         };
     }) => Promise<any>;
-    /***
-     * Returns a list of linked care contexts with patient reference number.
-    Validated and linked account reference number
-    Validated that the token sent from Consent Manager is same as the one generated by HIP
-    Verified that same Consent Manager which made the link request is sending the token
-    Results of unmasked linked care contexts with patient reference number
+    /**
+     * HMIS/LMIS response on confirm — called by HIP after the patient confirms
+     * the link via OTP/token (User Initiated Linking v3).
+     *
+     * This is the HIP's response to the HIE-CM callback at
+     * `{callback_url}/api/v3/hip/link/care-context/confirm` (section 5.3.10).
+     * The HIP returns the confirmed care contexts that have been linked to the
+     * patient's ABHA account.
+     *
+     * Uses the v3 endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.11):
+     * `POST /api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm`
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+     * @param config.patients - Array of patient care-context entries that were confirmed, each with:
+     *   - referenceNumber - Patient reference in HIP system
+     *   - display - Display name for the patient
+     *   - careContexts - Array of { referenceNumber, display }
+     *   - hiType - Type of health information (HI_TYPES)
+     *   - count - Number of care contexts
+     * @param config.callbackRequestId - The `requestId` from the HIE-CM confirm callback, sent in `response.requestId`
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @returns The request body that was sent (for logging/reference)
      */
     onConfirm: (config: {
         healthId: string;
-        careContextAccessToken: string;
-        requestId: string;
-        patientReferenceNumber: string;
-        patinetDisplay: string;
-        careContexts: {
+        patients: Array<{
+            referenceNumber: string;
+            display: string;
+            careContexts: Array<{
+                referenceNumber: string;
+                display: string;
+            }>;
+            hiType: HI_TYPES;
+            count: number;
+        }>;
+        callbackRequestId: string;
+        requestId?: string;
+        timestamp?: string;
+    }) => Promise<{
+        patient: {
             referenceNumber: string;
             display: string;
+            careContexts: Array<{
+                referenceNumber: string;
+                display: string;
+            }>;
+            hiType: HI_TYPES;
+            count: number;
         }[];
-        error?: {
-            code: number;
-            message: string;
+        response: {
+            requestId: string;
         };
-    }) => Promise<any>;
+    }>;
     /**
-     *This API is called by HIP only when there is new health data is added/created for a patient and under a care context that is already linked with patient's Health Account. HIP can send following things in this API to notify the Consent Manager about the new health data added:
-     * @param config
-     * @healthId Patient's Identifier for which the new health data is added (It can be ABDM address or phr address)
-     * @careContextReference   Care Context reference under which the new health data is added
-     * @patientReference  Patient's reference (An identifier with which the patient is registered on HIP)
-     * @hiTypes  Types of health information documents that have been added ("DiagnosticReportRecord" | "DischargeSummaryRecord" | "HealthDocumentRecord" | "ImmunizationRecord" | "OPConsultRecord" | "PrescriptionRecord" | "WellnessRecord")
-     * @date in iso format at UTC A date when the health information was created/added on the HIP Note: This API shouldn't be called if the new heath data of is added/created under new care context.
+     * Notifies the ABDM Consent Manager about new health data added/created for a patient
+     * under an already-linked care context (HIP Initiated Linking v3).
+     *
+     * Called by HIP when new health information is added under a care context that
+     * is already linked with the patient's ABHA account. This API should NOT be called
+     * if the new health data is added under a new (unlinked) care context.
+     *
+     * Uses the v3 HIE-CM endpoint `/api/hiecm/hip/v3/link/context/notify` per the
+     * ABDM M2 Sandbox Documentation v2.8 (section 4.3.6).
+     *
+     * Headers are built inline following the v3 pattern used by `generateToken` and
+     * `addCareContext`, including `X-HIP-ID`, `X-LINK-TOKEN`, `REQUEST-ID`, and
+     * `TIMESTAMP` as required by the v3 API.
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's identifier (ABHA address, e.g. "user@sbx") used to derive X-CM-ID
+     * @param config.hipId - HIP facility ID sent as X-HIP-ID header (e.g. "IN2910000004")
+     * @param config.linkToken - Link token (JWT) obtained from token generation, sent as X-LINK-TOKEN header
+     * @param config.patientReference - Patient's reference number in the HIP system (e.g. ABHA number)
+     * @param config.careContextReference - Care context reference under which new health data was added
+     * @param config.hiTypes - Array of HI types for the new health data (e.g. ["Prescription", "DischargeSummary"])
+     * @param config.date - ISO 8601 UTC date when the health information was created/added on the HIP
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @returns The request body that was sent (for logging/reference)
      */
     notify: (config: {
         healthId: string;
-        patientReference: any;
-        careContextReference: any;
+        hipId: string;
+        linkToken: string;
+        patientReference: string;
+        careContextReference: string;
         hiTypes: HI_TYPES[];
         date: string;
-        hipId: string;
+        requestId?: string;
+        timestamp?: string;
     }) => Promise<{
-        requestId: string;
-        timestamp: string;
         notification: {
             patient: {
                 id: string;
             };
             careContext: {
-                patientReference: any;
-                careContextReference: any;
+                patientReference: string;
+                careContextReference: string;
             };
             hiTypes: HI_TYPES[];
             date: string;
@@ -110,6 +200,36 @@ export default class Link extends Header {
             };
         };
     }>;
+    /**
+     * Generates a patient token (ABDM HIE-CM v3 endpoint) required for HIE (Health Information Exchange) operations.
+     *
+     * This token is needed to authorize subsequent HIE transactions such as data push and data pull requests.
+     * The API uses the v3 endpoint `/api/hiecm/v3/token/generate-token` which requires custom headers
+     * (REQUEST-ID, TIMESTAMP, X-HIP-ID) not present in the standard v0.5 header set.
+     *
+     * @param config - Configuration object for token generation
+     * @param config.healthId - Patient's health ID used to derive the X-CM-ID header (e.g., "user@abdm")
+     * @param config.hipId - Health Information Provider ID sent as X-HIP-ID header
+     * @param config.abhaNumber - Patient's ABHA number (can be numeric or string)
+     * @param config.abhaAddress - Patient's ABHA address (e.g., "user@sbx")
+     * @param config.name - Patient's full name
+     * @param config.gender - Patient's gender
+     * @param config.yearOfBirth - Patient's year of birth
+     * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+     * @returns The parsed API response containing the generated patient token
+     */
+    generateToken: (config: {
+        healthId: string;
+        hipId: string;
+        abhaNumber: number | string;
+        abhaAddress: string;
+        name: string;
+        gender: string;
+        yearOfBirth: number;
+        requestId?: string;
+        timestamp?: string;
+    }) => Promise<any>;
 }
 export {};
 //# sourceMappingURL=link.d.ts.map

package/lib/classes/link.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../src/classes/link.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,aAAK,QAAQ,GACT,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,gBAAgB,GAChB,mBAAmB,GACnB,eAAe,CAAA;AAGnB,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,MAAM;gBAC1B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAIlD;;;;OAIG;IACH,UAAU,WAAkB;QAC1B,QAAQ,EAAE,MAAM,CAAC;QACjB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;KAC5B;;;;;;;;;;;;;;OA6BC;IAEF;;;;;;;;;;;;OAYG;IACH,MAAM,WAAkB;QACtB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,eAAe,EAAE,MAAM,CAAC;QACxB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,kBAmCC;IAEF;;;;;;OAMG;IACH,SAAS,WAAkB;QACzB,QAAQ,EAAE,MAAM,CAAC;QACjB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;QAClB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE;YACZ,eAAe,EAAE,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC;SACjB,EAAE,CAAC;QACJ,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,kBA+BC;IAEF;;;;;;;;OAQG;IAEH,MAAM,WAAkB;QACtB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,GAAG,CAAC;QACtB,oBAAoB,EAAE,GAAG,CAAC;QAC1B,OAAO,EAAE,QAAQ,EAAE,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf;;;;;;;;;;;;;;;;;OA+BC;CACH"}
+{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../src/classes/link.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,UAAU,CAAC;AAE9B,aAAK,QAAQ,GACT,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,gBAAgB,GAChB,mBAAmB,GACnB,eAAe,CAAA;AAGnB,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,MAAM;gBAC1B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAIlD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,WAAkB;QAC9B,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM;YACd,eAAe,EAAE,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC;YAChB,YAAY,EAAE,MAAM;gBAClB,eAAe,EAAE,MAAM,CAAC;gBACxB,OAAO,EAAE,MAAM,CAAC;aACjB,CAAC,CAAC;YACH,MAAM,EAAE,QAAQ,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,kBA0BC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,MAAM,WAAkB;QACtB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,eAAe,EAAE,MAAM,CAAC;QACxB,kBAAkB,EAAE,QAAQ,GAAG,SAAS,CAAC;QACzC,mBAAmB,EAAE,MAAM,CAAC;QAC5B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,kBAyCC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,WAAkB;QACzB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM;YACd,eAAe,EAAE,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC;YAChB,YAAY,EAAE,MAAM;gBAClB,eAAe,EAAE,MAAM,CAAC;gBACxB,OAAO,EAAE,MAAM,CAAC;aACjB,CAAC,CAAC;YACH,MAAM,EAAE,QAAQ,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC,CAAC;QACH,iBAAiB,EAAE,MAAM,CAAC;QAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;;6BAZoB,MAAM;qBACd,MAAM;0BACD,MAAM;gBAClB,eAAe,EAAE,MAAM,CAAC;gBACxB,OAAO,EAAE,MAAM,CAAC;aACjB,CAAC;oBACM,QAAQ;mBACT,MAAM;;;;;OA8Bf;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,WAAkB;QACtB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,OAAO,EAAE,QAAQ,EAAE,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;;;;;;;;;;;;;;;OAsCC;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,WAAkB;QAC7B,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;QAC5B,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,kBA2BC;CACH"}

package/lib/classes/link.js

@@ -19,131 +19,214 @@ class Link extends header_1.default {
     constructor(_baseUrl, _accessToken) {
         super(_baseUrl, _accessToken);
         /**
+         * Adds care contexts to a patient's ABHA account using the v3 HIE-CM endpoint.
          *
-         * @param config healthis with Xcmid
-         * @returns
+         * This replaces the deprecated v0.5 `AddContext` method. It requires a
+         * `linkToken` (obtained via `generateToken`) and sends patient care-context
+         * data with `hiType` and `count` fields.
+         *
+         * Headers are built inline following the existing `generateToken` v3 pattern.
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's health ID used to derive X-CM-ID header
+         * @param config.hipId - HIP ID sent as X-HIP-ID header
+         * @param config.linkToken - Link token obtained from HIE-CM token generation
+         * @param config.abhaNumber - Patient's ABHA number
+         * @param config.abhaAddress - Patient's ABHA address
+         * @param config.patients - Array of patient care-context entries, each with:
+         *   - referenceNumber - Patient reference (encounter ID) in HIP system
+         *   - display - Display name for the patient
+         *   - careContexts - Array of { referenceNumber, display }
+         *   - hiType - Type of health information (HI_TYPES)
+         *   - count - Number of care contexts
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @returns The parsed API response
          */
-        this.AddContext = (config) => __awaiter(this, void 0, void 0, function* () {
-            const headers = this.headers(config.healthId);
-            const url = `${this.baseUrl}v0.5/links/link/add-contexts`;
+        this.addCareContext = (config) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_a = config.requestId) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
+                TIMESTAMP: (_b = config.timestamp) !== null && _b !== void 0 ? _b : new Date().toISOString(),
+                "X-HIP-ID": config.hipId,
+                "X-LINK-TOKEN": config.linkToken,
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/hip/v3/link/carecontext`;
             const body = {
-                requestId: (0, uuid_1.v4)(),
-                timestamp: new Date().toISOString(),
-                link: {
-                    accessToken: config.careContextAccessToken,
-                    patient: {
-                        referenceNumber: config.patientId,
-                        display: config.patinetDisplay,
-                        careContexts: [
-                            {
-                                referenceNumber: config.careContextId,
-                                display: config.careContextDisplay,
-                            },
-                        ],
-                    },
-                },
+                abhaNumber: config.abhaNumber,
+                abhaAddress: config.abhaAddress,
+                patient: config.patients,
             };
-            yield new request_1.default().request({
-                headers: headers,
+            const response = yield new request_1.default().request({
+                headers,
                 method: "POST",
                 requestBody: body,
-                url: url,
+                url,
             });
-            return body;
+            return JSON.parse(response.body);
         });
         /**
-         * 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
-         * @param config
-         *
-         * 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
+         * HMIS/LMIS response to the HIE-CM callback for user-initiated linking (v3).
+         *
+         * This is called by the HIP in response to the discovery callback (section 5.3.2).
+         * The HIP validates the transactionId against a previous discovery, sends an
+         * authentication request to the patient (e.g. OTP), and returns the link
+         * reference number with authentication metadata. The patient subsequently passes
+         * the token via `/link/care-context/confirm` against the `link.referenceNumber`.
+         *
+         * Uses the v3 HIE-CM endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.7):
+         * `POST /api/hiecm/user-initiated-linking/v3/link/care-context/on-init`
+         *
+         * Possible errors returned:
+         * - Patient reference number is invalid
+         * - Care context reference numbers are invalid
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+         * @param config.transactionId - Transaction ID from the discovery callback, used for correlation
+         * @param config.referenceNumber - Link reference number generated by the HIP for this linking attempt
+         * @param config.authenticationType - Authentication type: "DIRECT" or "MEDIATE"
+         * @param config.communicationMedium - Medium for patient communication (e.g. "MOBILE")
+         * @param config.communicationHint - Hint for the communication (e.g. "OTP")
+         * @param config.communicationExpiry - ISO timestamp for communication expiry (defaults to 10 min from now)
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @param config.callbackRequestId - The `requestId` from the HIE-CM discovery callback, sent in `response.requestId`
+         * @param config.error - Optional error object if the HIP cannot process the link request
+         * @returns The request body that was sent (for logging/reference)
          */
         this.onInit = (config) => __awaiter(this, void 0, void 0, function* () {
-            const headers = this.headers(config.healthId);
-            const url = `${this.baseUrl}v0.5/links/link/on-init`;
+            var _c, _d, _e;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_c = config.requestId) !== null && _c !== void 0 ? _c : (0, uuid_1.v4)(),
+                TIMESTAMP: (_d = config.timestamp) !== null && _d !== void 0 ? _d : new Date().toISOString(),
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/user-initiated-linking/v3/link/care-context/on-init`;
             const body = {
-                requestId: (0, uuid_1.v4)(),
-                timestamp: new Date().toISOString(),
                 transactionId: config.transactionId,
                 link: {
                     referenceNumber: config.referenceNumber,
-                    authenticationType: "DIRECT",
+                    authenticationType: config.authenticationType,
                     meta: {
-                        communicationMedium: "MOBILE",
+                        communicationMedium: config.communicationMedium,
                         communicationHint: config.communicationHint,
-                        communicationExpiry: config.communicationExpiry ||
-                            new Date(new Date().getTime() + 10 * 60000).toISOString(),
+                        communicationExpiry: (_e = config.communicationExpiry) !== null && _e !== void 0 ? _e : new Date(new Date().getTime() + 10 * 60000).toISOString(),
                     },
                 },
-                resp: {
-                    requestId: config.requestId,
+                response: {
+                    requestId: config.callbackRequestId,
                 },
             };
             if (config.error) {
                 body.error = config.error;
             }
             yield new request_1.default().request({
-                headers: headers,
+                headers,
                 method: "POST",
                 requestBody: body,
-                url: url,
+                url,
             });
             return body;
         });
-        /***
-         * Returns a list of linked care contexts with patient reference number.
-        Validated and linked account reference number
-        Validated that the token sent from Consent Manager is same as the one generated by HIP
-        Verified that same Consent Manager which made the link request is sending the token
-        Results of unmasked linked care contexts with patient reference number
+        /**
+         * HMIS/LMIS response on confirm — called by HIP after the patient confirms
+         * the link via OTP/token (User Initiated Linking v3).
+         *
+         * This is the HIP's response to the HIE-CM callback at
+         * `{callback_url}/api/v3/hip/link/care-context/confirm` (section 5.3.10).
+         * The HIP returns the confirmed care contexts that have been linked to the
+         * patient's ABHA account.
+         *
+         * Uses the v3 endpoint per ABDM M2 Sandbox Documentation v2.8 (section 5.3.11):
+         * `POST /api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm`
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's ABHA address (e.g. "user@sbx") used to derive X-CM-ID
+         * @param config.patients - Array of patient care-context entries that were confirmed, each with:
+         *   - referenceNumber - Patient reference in HIP system
+         *   - display - Display name for the patient
+         *   - careContexts - Array of { referenceNumber, display }
+         *   - hiType - Type of health information (HI_TYPES)
+         *   - count - Number of care contexts
+         * @param config.callbackRequestId - The `requestId` from the HIE-CM confirm callback, sent in `response.requestId`
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @returns The request body that was sent (for logging/reference)
          */
         this.onConfirm = (config) => __awaiter(this, void 0, void 0, function* () {
-            const headers = this.headers(config.healthId);
-            const url = `${this.baseUrl}v0.5/links/link/on-confirm`;
+            var _f, _g;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_f = config.requestId) !== null && _f !== void 0 ? _f : (0, uuid_1.v4)(),
+                TIMESTAMP: (_g = config.timestamp) !== null && _g !== void 0 ? _g : new Date().toISOString(),
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm`;
             const body = {
-                requestId: (0, uuid_1.v4)(),
-                timestamp: new Date().toISOString(),
-                patient: {
-                    referenceNumber: config.patientReferenceNumber,
-                    display: config.patinetDisplay,
-                    careContexts: config.careContexts,
-                },
-                resp: {
-                    requestId: config.requestId,
+                patient: config.patients,
+                response: {
+                    requestId: config.callbackRequestId,
                 },
             };
-            if (config.error) {
-                body.error = config.error;
-            }
             yield new request_1.default().request({
-                headers: headers,
+                headers,
                 method: "POST",
                 requestBody: body,
-                url: url,
+                url,
             });
             return body;
         });
         /**
-         *This API is called by HIP only when there is new health data is added/created for a patient and under a care context that is already linked with patient's Health Account. HIP can send following things in this API to notify the Consent Manager about the new health data added:
-         * @param config
-         * @healthId Patient's Identifier for which the new health data is added (It can be ABDM address or phr address)
-         * @careContextReference   Care Context reference under which the new health data is added
-         * @patientReference  Patient's reference (An identifier with which the patient is registered on HIP)
-         * @hiTypes  Types of health information documents that have been added ("DiagnosticReportRecord" | "DischargeSummaryRecord" | "HealthDocumentRecord" | "ImmunizationRecord" | "OPConsultRecord" | "PrescriptionRecord" | "WellnessRecord")
-         * @date in iso format at UTC A date when the health information was created/added on the HIP Note: This API shouldn't be called if the new heath data of is added/created under new care context.
+         * Notifies the ABDM Consent Manager about new health data added/created for a patient
+         * under an already-linked care context (HIP Initiated Linking v3).
+         *
+         * Called by HIP when new health information is added under a care context that
+         * is already linked with the patient's ABHA account. This API should NOT be called
+         * if the new health data is added under a new (unlinked) care context.
+         *
+         * Uses the v3 HIE-CM endpoint `/api/hiecm/hip/v3/link/context/notify` per the
+         * ABDM M2 Sandbox Documentation v2.8 (section 4.3.6).
+         *
+         * Headers are built inline following the v3 pattern used by `generateToken` and
+         * `addCareContext`, including `X-HIP-ID`, `X-LINK-TOKEN`, `REQUEST-ID`, and
+         * `TIMESTAMP` as required by the v3 API.
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's identifier (ABHA address, e.g. "user@sbx") used to derive X-CM-ID
+         * @param config.hipId - HIP facility ID sent as X-HIP-ID header (e.g. "IN2910000004")
+         * @param config.linkToken - Link token (JWT) obtained from token generation, sent as X-LINK-TOKEN header
+         * @param config.patientReference - Patient's reference number in the HIP system (e.g. ABHA number)
+         * @param config.careContextReference - Care context reference under which new health data was added
+         * @param config.hiTypes - Array of HI types for the new health data (e.g. ["Prescription", "DischargeSummary"])
+         * @param config.date - ISO 8601 UTC date when the health information was created/added on the HIP
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @returns The request body that was sent (for logging/reference)
          */
         this.notify = (config) => __awaiter(this, void 0, void 0, function* () {
-            const headers = this.headers(config.healthId);
-            const url = `${this.baseUrl}v0.5/links/context/notify`;
+            var _h, _j;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_h = config.requestId) !== null && _h !== void 0 ? _h : (0, uuid_1.v4)(),
+                TIMESTAMP: (_j = config.timestamp) !== null && _j !== void 0 ? _j : new Date().toISOString(),
+                "X-HIP-ID": config.hipId,
+                "X-LINK-TOKEN": config.linkToken,
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/hip/v3/link/context/notify`;
             const body = {
-                requestId: (0, uuid_1.v4)(),
-                timestamp: new Date().toISOString(),
                 notification: {
                     patient: {
                         id: config.healthId,
@@ -160,13 +243,59 @@ class Link extends header_1.default {
                 },
             };
             yield new request_1.default().request({
-                headers: headers,
+                headers,
                 method: "POST",
                 requestBody: body,
-                url: url,
+                url,
             });
             return body;
         });
+        /**
+         * Generates a patient token (ABDM HIE-CM v3 endpoint) required for HIE (Health Information Exchange) operations.
+         *
+         * This token is needed to authorize subsequent HIE transactions such as data push and data pull requests.
+         * The API uses the v3 endpoint `/api/hiecm/v3/token/generate-token` which requires custom headers
+         * (REQUEST-ID, TIMESTAMP, X-HIP-ID) not present in the standard v0.5 header set.
+         *
+         * @param config - Configuration object for token generation
+         * @param config.healthId - Patient's health ID used to derive the X-CM-ID header (e.g., "user@abdm")
+         * @param config.hipId - Health Information Provider ID sent as X-HIP-ID header
+         * @param config.abhaNumber - Patient's ABHA number (can be numeric or string)
+         * @param config.abhaAddress - Patient's ABHA address (e.g., "user@sbx")
+         * @param config.name - Patient's full name
+         * @param config.gender - Patient's gender
+         * @param config.yearOfBirth - Patient's year of birth
+         * @param config.requestId - Optional UUID for REQUEST-ID header (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header (auto-generated if omitted)
+         * @returns The parsed API response containing the generated patient token
+         */
+        this.generateToken = (config) => __awaiter(this, void 0, void 0, function* () {
+            var _k, _l;
+            this.setXCmId(config.healthId);
+            const headers = {
+                "REQUEST-ID": (_k = config.requestId) !== null && _k !== void 0 ? _k : (0, uuid_1.v4)(),
+                TIMESTAMP: (_l = config.timestamp) !== null && _l !== void 0 ? _l : new Date().toISOString(),
+                "X-HIP-ID": config.hipId,
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/v3/token/generate-token`;
+            const body = {
+                abhaNumber: config.abhaNumber,
+                abhaAddress: config.abhaAddress,
+                name: config.name,
+                gender: config.gender,
+                yearOfBirth: config.yearOfBirth,
+            };
+            const response = yield new request_1.default().request({
+                headers,
+                method: "POST",
+                requestBody: body,
+                url,
+            });
+            return JSON.parse(response.body);
+        });
     }
 }
 exports.default = Link;

package/lib/classes/link.js.map

@@ -1 +1 @@
-{"version":3,"file":"link.js","sourceRoot":"","sources":["../../src/classes/link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,+BAAoC;AACpC,wDAAgC;AAChC,sDAA8B;AAc9B,MAAqB,IAAK,SAAQ,gBAAM;IACtC,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAGhC;;;;WAIG;QACH,eAAU,GAAG,CAAO,MAOnB,EAAE,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,8BAA8B,CAAC;YAC1D,MAAM,IAAI,GAAG;gBACX,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,IAAI,EAAE;oBACJ,WAAW,EAAE,MAAM,CAAC,sBAAsB;oBAC1C,OAAO,EAAE;wBACP,eAAe,EAAE,MAAM,CAAC,SAAS;wBACjC,OAAO,EAAE,MAAM,CAAC,cAAc;wBAC9B,YAAY,EAAE;4BACZ;gCACE,eAAe,EAAE,MAAM,CAAC,aAAa;gCACrC,OAAO,EAAE,MAAM,CAAC,kBAAkB;6BACnC;yBACF;qBACF;iBACF;aACF,CAAC;YAEF,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;;WAYG;QACH,WAAM,GAAG,CAAO,MAWf,EAAE,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,yBAAyB,CAAC;YACrD,MAAM,IAAI,GAAQ;gBAChB,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,IAAI,EAAE;oBACJ,eAAe,EAAE,MAAM,CAAC,eAAe;oBACvC,kBAAkB,EAAE,QAAQ;oBAC5B,IAAI,EAAE;wBACJ,mBAAmB,EAAE,QAAQ;wBAC7B,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;wBAC3C,mBAAmB,EACjB,MAAM,CAAC,mBAAmB;4BAC1B,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,WAAW,EAAE;qBAC5D;iBACF;gBACD,IAAI,EAAE;oBACJ,SAAS,EAAE,MAAM,CAAC,SAAS;iBAC5B;aACF,CAAC;YAEF,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;YAED,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,cAAS,GAAG,CAAO,MAclB,EAAE,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,4BAA4B,CAAC;YAExD,MAAM,IAAI,GAAQ;gBAChB,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,OAAO,EAAE;oBACP,eAAe,EAAE,MAAM,CAAC,sBAAsB;oBAC9C,OAAO,EAAE,MAAM,CAAC,cAAc;oBAC9B,YAAY,EAAE,MAAM,CAAC,YAAY;iBAClC;gBAED,IAAI,EAAE;oBACJ,SAAS,EAAE,MAAM,CAAC,SAAS;iBAC5B;aACF,CAAC;YAEF,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;YAED,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;YAGH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;;;WAQG;QAEH,WAAM,GAAG,CAAO,MAOf,EAAE,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,2BAA2B,CAAC;YAEvD,MAAM,IAAI,GAAG;gBACX,SAAS,EAAE,IAAA,SAAM,GAAE;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,YAAY,EAAE;oBACZ,OAAO,EAAE;wBACP,EAAE,EAAE,MAAM,CAAC,QAAQ;qBACpB;oBACD,WAAW,EAAE;wBACX,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;wBACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;qBAClD;oBACD,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,GAAG,EAAE;wBACH,EAAE,EAAE,MAAM,CAAC,KAAK;qBACjB;iBACF;aACF,CAAC;YAEF,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;IAhNF,CAAC;CAiNF;AApND,uBAoNC"}
+{"version":3,"file":"link.js","sourceRoot":"","sources":["../../src/classes/link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,+BAAoC;AACpC,wDAAgC;AAChC,sDAA8B;AAc9B,MAAqB,IAAK,SAAQ,gBAAM;IACtC,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAGhC;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,mBAAc,GAAG,CAAO,MAkBvB,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,cAAc,EAAE,MAAM,CAAC,SAAS;gBAChC,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,mCAAmC,CAAC;YAC/D,MAAM,IAAI,GAAG;gBACX,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,OAAO,EAAE,MAAM,CAAC,QAAQ;aACzB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC3C,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,WAAM,GAAG,CAAO,MAef,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,+DAA+D,CAAC;YAE3F,MAAM,IAAI,GAAQ;gBAChB,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,IAAI,EAAE;oBACJ,eAAe,EAAE,MAAM,CAAC,eAAe;oBACvC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;oBAC7C,IAAI,EAAE;wBACJ,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;wBAC/C,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;wBAC3C,mBAAmB,EACjB,MAAA,MAAM,CAAC,mBAAmB,mCAC1B,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,WAAW,EAAE;qBAC5D;iBACF;gBACD,QAAQ,EAAE;oBACR,SAAS,EAAE,MAAM,CAAC,iBAAiB;iBACpC;aACF,CAAC;YAEF,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;aAC3B;YAED,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,cAAS,GAAG,CAAO,MAelB,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,kEAAkE,CAAC;YAC9F,MAAM,IAAI,GAAG;gBACX,OAAO,EAAE,MAAM,CAAC,QAAQ;gBACxB,QAAQ,EAAE;oBACR,SAAS,EAAE,MAAM,CAAC,iBAAiB;iBACpC;aACF,CAAC;YAEF,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,WAAM,GAAG,CAAO,MAUf,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,cAAc,EAAE,MAAM,CAAC,SAAS;gBAChC,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,sCAAsC,CAAC;YAElE,MAAM,IAAI,GAAG;gBACX,YAAY,EAAE;oBACZ,OAAO,EAAE;wBACP,EAAE,EAAE,MAAM,CAAC,QAAQ;qBACpB;oBACD,WAAW,EAAE;wBACX,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;wBACzC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;qBAClD;oBACD,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,GAAG,EAAE;wBACH,EAAE,EAAE,MAAM,CAAC,KAAK;qBACjB;iBACF;aACF,CAAC;YAEF,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC1B,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;;;;;;;;WAkBG;QACH,kBAAa,GAAG,CAAO,MAUtB,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE;gBAC1C,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACvD,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,mCAAmC,CAAC;YAC/D,MAAM,IAAI,GAAG;gBACX,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,WAAW,EAAE,MAAM,CAAC,WAAW;aAChC,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC3C,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAA,CAAC;IAzWF,CAAC;CA0WF;AA7WD,uBA6WC"}

package/lib/classes/patients.d.ts

@@ -16,22 +16,30 @@ export interface PATIENT_FIND {
 export default class Patients extends Header {
     constructor(_baseUrl: string, _accessToken: string);
     /**
-     * This API is called by HIP as acknowledgement to notification of consents, in cases of consent revocation and expiration.
-     * @param  config.healthId: string; phradddress or ABHA addrress of patient
-     * @param config.consentId: string; consent id recive by notify callback
-     * @param  config.requestId: string; request id as recived by notify callback
-     * @returns
+     * Sends an SMS notification to a patient about linked care contexts using the v3 HIE-CM endpoint.
+     *
+     * This replaces the deprecated v0.5 `smsNotify2` endpoint. It requires the v3 inline header
+     * pattern (REQUEST-ID, TIMESTAMP, X-CM-ID) and sends a simplified notification payload
+     * containing the patient's phone number and HIP details.
+     *
+     * Headers are built inline following the existing v3 pattern used by `generateToken` and `addCareContext`.
+     *
+     * @param config - Configuration object
+     * @param config.healthId - Patient's health ID used to derive X-CM-ID header (e.g., "unknown@sbx" or "unknown@abdm")
+     * @param config.phoneNo - Patient's phone number for SMS notification
+     * @param config.hipName - Display name of the Health Information Provider (HIP)
+     * @param config.hipId - HIP identifier (e.g., "IN2910000004")
+     * @param config.requestId - Optional UUID for REQUEST-ID header and body (auto-generated if omitted)
+     * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header and body (auto-generated if omitted)
+     * @returns The parsed API response
      */
     smsNotify2: (config: {
         healthId: "unknown@sbx" | "unknown@abdm";
         phoneNo: string;
-        patientName?: string;
-        careContextInfo: string;
-        deeplinkUrl?: string;
-        facilityName?: string;
-        hipid: string;
-        errCode?: string;
-        errMessage?: string;
+        hipName: string;
+        hipId: string;
+        requestId?: string;
+        timestamp?: string;
     }) => Promise<any>;
     /**
      * This API is meant for identify to patient given her consent-manager-user-id

package/lib/classes/patients.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"patients.d.ts","sourceRoot":"","sources":["../../src/classes/patients.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAI9B,aAAK,aAAa,GAAG,KAAK,GAAE,KAAK,CAAA;AACjC,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE;QACL,OAAO,EAAG;YACR,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;QAED,SAAS,EAAE;YACT,IAAI,EAAG,aAAa,CAAA;YACpB,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;KACF,CAAA;CACF;AAID,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,MAAM;gBAC9B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAGlD;;;;;;OAMG;IACH,UAAU,WAAkB;QAC1B,QAAQ,EAAG,aAAa,GAAG,cAAc,CAAA;QACzC,OAAO,EAAC,MAAM,CAAA;QACd,WAAW,CAAC,EAAC,MAAM,CAAA;QACnB,eAAe,EAAC,MAAM,CAAA;QACtB,WAAW,CAAC,EAAC,MAAM,CAAA;QACnB,YAAY,CAAC,EAAC,MAAM,CAAA;QACpB,KAAK,EAAC,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,kBAyCC;IAEF;;;;;OAKG;IACH,IAAI,WACM,YAAY,YACV,MAAM,uCAsBhB;CAMH"}
+{"version":3,"file":"patients.d.ts","sourceRoot":"","sources":["../../src/classes/patients.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,UAAU,CAAC;AAI9B,aAAK,aAAa,GAAG,KAAK,GAAE,KAAK,CAAA;AACjC,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE;QACL,OAAO,EAAG;YACR,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;QAED,SAAS,EAAE;YACT,IAAI,EAAG,aAAa,CAAA;YACpB,EAAE,EAAE,MAAM,CAAA;SACX,CAAA;KACF,CAAA;CACF;AAID,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,MAAM;gBAC9B,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAGlD;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,WAAkB;QAC1B,QAAQ,EAAE,aAAa,GAAG,cAAc,CAAC;QACzC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,kBAgCC;IAEF;;;;;OAKG;IACH,IAAI,WACM,YAAY,YACV,MAAM,uCAsBhB;CAMH"}

package/lib/classes/patients.js

@@ -19,47 +19,54 @@ class Patients extends header_1.default {
     constructor(_baseUrl, _accessToken) {
         super(_baseUrl, _accessToken);
         /**
-         * This API is called by HIP as acknowledgement to notification of consents, in cases of consent revocation and expiration.
-         * @param  config.healthId: string; phradddress or ABHA addrress of patient
-         * @param config.consentId: string; consent id recive by notify callback
-         * @param  config.requestId: string; request id as recived by notify callback
-         * @returns
+         * Sends an SMS notification to a patient about linked care contexts using the v3 HIE-CM endpoint.
+         *
+         * This replaces the deprecated v0.5 `smsNotify2` endpoint. It requires the v3 inline header
+         * pattern (REQUEST-ID, TIMESTAMP, X-CM-ID) and sends a simplified notification payload
+         * containing the patient's phone number and HIP details.
+         *
+         * Headers are built inline following the existing v3 pattern used by `generateToken` and `addCareContext`.
+         *
+         * @param config - Configuration object
+         * @param config.healthId - Patient's health ID used to derive X-CM-ID header (e.g., "unknown@sbx" or "unknown@abdm")
+         * @param config.phoneNo - Patient's phone number for SMS notification
+         * @param config.hipName - Display name of the Health Information Provider (HIP)
+         * @param config.hipId - HIP identifier (e.g., "IN2910000004")
+         * @param config.requestId - Optional UUID for REQUEST-ID header and body (auto-generated if omitted)
+         * @param config.timestamp - Optional ISO timestamp for TIMESTAMP header and body (auto-generated if omitted)
+         * @returns The parsed API response
          */
         this.smsNotify2 = (config) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const headers = this.headers(config.healthId);
-                const url = `${this.baseUrl}v0.5/patients/sms/notify2`;
-                const body = {
-                    requestId: (0, uuid_1.v4)(),
-                    timestamp: new Date().toISOString(),
-                    "notification": {
-                        "phoneNo": config.phoneNo,
-                        "receiverName": config.patientName,
-                        "careContextInfo": config.careContextInfo,
-                        "deeplinkUrl": config.deeplinkUrl,
-                        "hip": {
-                            "name": config.facilityName,
-                            "id": config.hipid
-                        }
-                    }
-                };
-                if (config.errCode) {
-                    body.error = {
-                        code: config.errCode,
-                        message: config.errMessage || "Error occured",
-                    };
-                }
-                const res = yield new request_1.default().request({
-                    headers: headers,
-                    method: "POST",
-                    requestBody: body,
-                    url: url,
-                });
-                return body;
-            }
-            catch (error) {
-                console.log(error);
-            }
+            var _a, _b;
+            this.setXCmId(config.healthId);
+            const requestId = (_a = config.requestId) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)();
+            const timestamp = (_b = config.timestamp) !== null && _b !== void 0 ? _b : new Date().toISOString();
+            const headers = {
+                "REQUEST-ID": requestId,
+                TIMESTAMP: timestamp,
+                "X-CM-ID": this.xCmId,
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${this.accessToken}`,
+            };
+            const url = `${this.baseUrl}api/hiecm/hip/v3/link/patient/links/sms/notify2`;
+            const body = {
+                requestId,
+                timestamp,
+                notification: {
+                    phoneNo: config.phoneNo,
+                    hip: {
+                        name: config.hipName,
+                        id: config.hipId,
+                    },
+                },
+            };
+            const response = yield new request_1.default().request({
+                headers,
+                method: "POST",
+                requestBody: body,
+                url,
+            });
+            return JSON.parse(response.body);
         });
         /**
          * This API is meant for identify to patient given her consent-manager-user-id

package/lib/classes/patients.js.map

@@ -1 +1 @@
-{"version":3,"file":"patients.js","sourceRoot":"","sources":["../../src/classes/patients.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAA8B;AAC9B,+BAAoC;AACpC,wDAAgC;AAoBhC,MAAqB,QAAS,SAAQ,gBAAM;IAC1C,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEhC;;;;;;WAMG;QACH,eAAU,GAAG,CAAO,MAUnB,EAAE,EAAE;YACH,IAAI;gBACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBAChD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,2BAA2B,CAAC;gBAEvD,MAAM,IAAI,GAAQ;oBAChB,SAAS,EAAE,IAAA,SAAM,GAAE;oBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;oBACnC,cAAc,EAAE;wBACd,SAAS,EAAC,MAAM,CAAC,OAAO;wBACxB,cAAc,EAAE,MAAM,CAAC,WAAW;wBAClC,iBAAiB,EAAE,MAAM,CAAC,eAAe;wBACzC,aAAa,EAAE,MAAM,CAAC,WAAW;wBACjC,KAAK,EAAE;4BACL,MAAM,EAAE,MAAM,CAAC,YAAY;4BAC3B,IAAI,EAAE,MAAM,CAAC,KAAK;yBACnB;qBACF;iBACF,CAAC;gBAEF,IAAI,MAAM,CAAC,OAAO,EAAE;oBAClB,IAAI,CAAC,KAAK,GAAG;wBACX,IAAI,EAAE,MAAM,CAAC,OAAO;wBACpB,OAAO,EAAE,MAAM,CAAC,UAAU,IAAI,eAAe;qBAC9C,CAAC;iBACH;gBAED,MAAM,GAAG,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;oBACtC,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE,MAAM;oBACd,WAAW,EAAE,IAAI;oBACjB,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC;gBAIH,OAAO,IAAI,CAAC;aACX;YAAC,OAAO,KAAK,EAAE;gBAClB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;aACf;QAEH,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,SAAI,GAAG,CACL,MAAoB,EACpB,QAAgB,EAChB,EAAE;YACF,IAAI;gBACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACvC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,oBAAoB,CAAC;gBAChD,MAAM,IAAI,mCACL,MAAM,KACT,SAAS,EAAE,IAAA,SAAM,GAAE,EACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GACpC,CAAC;gBAEF,MAAM,GAAG,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;oBACtC,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE,MAAM;oBACd,WAAW,EAAE,IAAI;oBACjB,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACpB;QACH,CAAC,CAAA,CAAC;IA3FF,CAAC;CAiGF;AApGD,2BAoGC"}
+{"version":3,"file":"patients.js","sourceRoot":"","sources":["../../src/classes/patients.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAA8B;AAC9B,+BAAoC;AACpC,wDAAgC;AAoBhC,MAAqB,QAAS,SAAQ,gBAAM;IAC1C,YAAY,QAAgB,EAAE,YAAoB;QAChD,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEhC;;;;;;;;;;;;;;;;;WAiBG;QACH,eAAU,GAAG,CAAO,MAOnB,EAAE,EAAE;;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC/B,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAA,SAAM,GAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC/D,MAAM,OAAO,GAAG;gBACd,YAAY,EAAE,SAAS;gBACvB,SAAS,EAAE,SAAS;gBACpB,SAAS,EAAE,IAAI,CAAC,KAAK;gBACrB,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;aAC5C,CAAC;YACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,iDAAiD,CAAC;YAC7E,MAAM,IAAI,GAAG;gBACX,SAAS;gBACT,SAAS;gBACT,YAAY,EAAE;oBACZ,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,GAAG,EAAE;wBACH,IAAI,EAAE,MAAM,CAAC,OAAO;wBACpB,EAAE,EAAE,MAAM,CAAC,KAAK;qBACjB;iBACF;aACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;gBAC3C,OAAO;gBACP,MAAM,EAAE,MAAM;gBACd,WAAW,EAAE,IAAI;gBACjB,GAAG;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,SAAI,GAAG,CACL,MAAoB,EACpB,QAAgB,EAChB,EAAE;YACF,IAAI;gBACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACvC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,oBAAoB,CAAC;gBAChD,MAAM,IAAI,mCACL,MAAM,KACT,SAAS,EAAE,IAAA,SAAM,GAAE,EACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GACpC,CAAC;gBAEF,MAAM,GAAG,GAAG,MAAM,IAAI,iBAAO,EAAE,CAAC,OAAO,CAAC;oBACtC,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE,MAAM;oBACd,WAAW,EAAE,IAAI;oBACjB,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACpB;QACH,CAAC,CAAA,CAAC;IA1FF,CAAC;CAgGF;AAnGD,2BAmGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ndhm-hrp",
-  "version": "2.2.38",
+  "version": "3.0.0",
   "description": "This is ndhm-hpr",
   "main": "lib/index.js",
   "directories": {