@headspace/protos-events 1.825.0 → 1.827.0

package/lib/index.d.ts

@@ -71957,6 +71957,381 @@ export namespace CmsAccessEnrollmentInitiated {
     type $Shape = CmsAccessEnrollmentInitiated.$Properties;
 }
 
+/** CmsAccessExclusionCriteria enum. */
+export enum CmsAccessExclusionCriteria {
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_UNKNOWN value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_UNKNOWN = 0,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_SUICIDAL_IDEATION value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_SUICIDAL_IDEATION = 1,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_DEMENTIA value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_DEMENTIA = 2,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_PSYCHOTIC_DISORDER value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_PSYCHOTIC_DISORDER = 3,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_EATING_DISORDER value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_EATING_DISORDER = 4,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_PREGNANCY value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_PREGNANCY = 5,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_FRAILTY value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_FRAILTY = 6,
+
+    /** CMS_ACCESS_EXCLUSION_CRITERIA_MINOR value */
+    CMS_ACCESS_EXCLUSION_CRITERIA_MINOR = 7
+}
+
+/**
+ * Properties of a CmsAccessEnrollmentExcluded.
+ * @deprecated Use CmsAccessEnrollmentExcluded.$Properties instead.
+ */
+export interface ICmsAccessEnrollmentExcluded extends CmsAccessEnrollmentExcluded.$Properties {
+}
+
+/**
+ * Published when hs-cms-access-service excludes a beneficiary at pre-flight screening
+ * (CREATED → EXCLUDED) without calling CMS. Fired after CmsAccessEnrollmentInitiated
+ * for the same tracking_id (ADR-005 event ordering:
+ * https://github.com/HeadspaceMeditation/hs-cms-access-service/pull/59).
+ * Used by Data Engineering for per-criteria exclusion rates (PRD §3.41;
+ * https://headspace.atlassian.net/browse/HPSO-1345). SNS/DE wiring:
+ * https://headspace.atlassian.net/browse/HPSO-1348.
+ * Fired by: hs-cms-access-service
+ * Responsible team: Health Plans
+ */
+export class CmsAccessEnrollmentExcluded {
+
+    /**
+     * Constructs a new CmsAccessEnrollmentExcluded.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: CmsAccessEnrollmentExcluded.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** CmsAccessEnrollmentExcluded timestamp. */
+    timestamp: (number|Long);
+
+    /** CmsAccessEnrollmentExcluded hsUserId. */
+    hsUserId: string;
+
+    /** CmsAccessEnrollmentExcluded trackingId. */
+    trackingId: string;
+
+    /** CmsAccessEnrollmentExcluded criteria. */
+    criteria: CmsAccessExclusionCriteria[];
+
+    /**
+     * Creates a new CmsAccessEnrollmentExcluded instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns CmsAccessEnrollmentExcluded instance
+     */
+    static create(properties: CmsAccessEnrollmentExcluded.$Shape): CmsAccessEnrollmentExcluded & CmsAccessEnrollmentExcluded.$Shape;
+    static create(properties?: CmsAccessEnrollmentExcluded.$Properties): CmsAccessEnrollmentExcluded;
+
+    /**
+     * Encodes the specified CmsAccessEnrollmentExcluded message. Does not implicitly {@link CmsAccessEnrollmentExcluded.verify|verify} messages.
+     * @param message CmsAccessEnrollmentExcluded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: CmsAccessEnrollmentExcluded.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified CmsAccessEnrollmentExcluded message, length delimited. Does not implicitly {@link CmsAccessEnrollmentExcluded.verify|verify} messages.
+     * @param message CmsAccessEnrollmentExcluded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: CmsAccessEnrollmentExcluded.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a CmsAccessEnrollmentExcluded message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {CmsAccessEnrollmentExcluded & CmsAccessEnrollmentExcluded.$Shape} CmsAccessEnrollmentExcluded
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): CmsAccessEnrollmentExcluded & CmsAccessEnrollmentExcluded.$Shape;
+
+    /**
+     * Decodes a CmsAccessEnrollmentExcluded message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {CmsAccessEnrollmentExcluded & CmsAccessEnrollmentExcluded.$Shape} CmsAccessEnrollmentExcluded
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): CmsAccessEnrollmentExcluded & CmsAccessEnrollmentExcluded.$Shape;
+
+    /**
+     * Verifies a CmsAccessEnrollmentExcluded message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a CmsAccessEnrollmentExcluded message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns CmsAccessEnrollmentExcluded
+     */
+    static fromObject(object: { [k: string]: any }): CmsAccessEnrollmentExcluded;
+
+    /**
+     * Creates a plain object from a CmsAccessEnrollmentExcluded message. Also converts values to other types if specified.
+     * @param message CmsAccessEnrollmentExcluded
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: CmsAccessEnrollmentExcluded, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this CmsAccessEnrollmentExcluded to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for CmsAccessEnrollmentExcluded
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace CmsAccessEnrollmentExcluded {
+
+    /** Properties of a CmsAccessEnrollmentExcluded. */
+    interface $Properties {
+
+        /** CmsAccessEnrollmentExcluded timestamp */
+        timestamp?: (number|Long|null);
+
+        /** CmsAccessEnrollmentExcluded hsUserId */
+        hsUserId?: (string|null);
+
+        /** CmsAccessEnrollmentExcluded trackingId */
+        trackingId?: (string|null);
+
+        /** CmsAccessEnrollmentExcluded criteria */
+        criteria?: (CmsAccessExclusionCriteria[]|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a CmsAccessEnrollmentExcluded. */
+    type $Shape = CmsAccessEnrollmentExcluded.$Properties;
+}
+
+/** CmsAccessReportType enum. */
+export enum CmsAccessReportType {
+
+    /** CMS_ACCESS_REPORT_TYPE_UNKNOWN value */
+    CMS_ACCESS_REPORT_TYPE_UNKNOWN = 0,
+
+    /** CMS_ACCESS_REPORT_TYPE_BASELINE value */
+    CMS_ACCESS_REPORT_TYPE_BASELINE = 1,
+
+    /** CMS_ACCESS_REPORT_TYPE_QUARTERLY value */
+    CMS_ACCESS_REPORT_TYPE_QUARTERLY = 2,
+
+    /** CMS_ACCESS_REPORT_TYPE_END_OF_PERIOD value */
+    CMS_ACCESS_REPORT_TYPE_END_OF_PERIOD = 3
+}
+
+/** CmsAccessDataReportResult enum. */
+export enum CmsAccessDataReportResult {
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_UNKNOWN value */
+    CMS_ACCESS_DATA_REPORT_RESULT_UNKNOWN = 0,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_SUCCESS value */
+    CMS_ACCESS_DATA_REPORT_RESULT_SUCCESS = 1,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_DUPLICATE value */
+    CMS_ACCESS_DATA_REPORT_RESULT_DUPLICATE = 2,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_BENEFICIARY_NOT_ALIGNED value */
+    CMS_ACCESS_DATA_REPORT_RESULT_BENEFICIARY_NOT_ALIGNED = 3,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_REPORTING_PERIOD_CLOSED value */
+    CMS_ACCESS_DATA_REPORT_RESULT_REPORTING_PERIOD_CLOSED = 4,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_INCOMPLETE_DATA value */
+    CMS_ACCESS_DATA_REPORT_RESULT_INCOMPLETE_DATA = 5,
+
+    /** CMS_ACCESS_DATA_REPORT_RESULT_INCORRECT_TRACK value */
+    CMS_ACCESS_DATA_REPORT_RESULT_INCORRECT_TRACK = 6
+}
+
+/**
+ * Properties of a CmsAccessDataReportCompleted.
+ * @deprecated Use CmsAccessDataReportCompleted.$Properties instead.
+ */
+export interface ICmsAccessDataReportCompleted extends CmsAccessDataReportCompleted.$Properties {
+}
+
+/**
+ * Published when a CMS ACCESS $report-data (Outcome-Aligned Payment) submission
+ * reaches a terminal state. Submits a beneficiary's BH clinical-instrument scores
+ * to CMS as a FHIR Bundle across the care period (baseline, quarterly, end-of-period).
+ * Used by Data Engineering for outcomes-reporting compliance KPIs
+ * (ADR-004 §2, hs-cms-access-service docs/decisions/0004-event-coverage-for-analytics.md).
+ * Fired by: hs-cms-access-service
+ * Responsible team: Health Plans
+ */
+export class CmsAccessDataReportCompleted {
+
+    /**
+     * Constructs a new CmsAccessDataReportCompleted.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: CmsAccessDataReportCompleted.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** CmsAccessDataReportCompleted timestamp. */
+    timestamp: (number|Long);
+
+    /** CmsAccessDataReportCompleted hsUserId. */
+    hsUserId: string;
+
+    /** CmsAccessDataReportCompleted trackingId. */
+    trackingId: string;
+
+    /** CmsAccessDataReportCompleted cmsSubmissionId. */
+    cmsSubmissionId: string;
+
+    /** CmsAccessDataReportCompleted reportType. */
+    reportType: CmsAccessReportType;
+
+    /** CmsAccessDataReportCompleted result. */
+    result: CmsAccessDataReportResult;
+
+    /** CmsAccessDataReportCompleted submittedAt. */
+    submittedAt: (number|Long);
+
+    /**
+     * Creates a new CmsAccessDataReportCompleted instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns CmsAccessDataReportCompleted instance
+     */
+    static create(properties: CmsAccessDataReportCompleted.$Shape): CmsAccessDataReportCompleted & CmsAccessDataReportCompleted.$Shape;
+    static create(properties?: CmsAccessDataReportCompleted.$Properties): CmsAccessDataReportCompleted;
+
+    /**
+     * Encodes the specified CmsAccessDataReportCompleted message. Does not implicitly {@link CmsAccessDataReportCompleted.verify|verify} messages.
+     * @param message CmsAccessDataReportCompleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: CmsAccessDataReportCompleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified CmsAccessDataReportCompleted message, length delimited. Does not implicitly {@link CmsAccessDataReportCompleted.verify|verify} messages.
+     * @param message CmsAccessDataReportCompleted message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: CmsAccessDataReportCompleted.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a CmsAccessDataReportCompleted message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {CmsAccessDataReportCompleted & CmsAccessDataReportCompleted.$Shape} CmsAccessDataReportCompleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): CmsAccessDataReportCompleted & CmsAccessDataReportCompleted.$Shape;
+
+    /**
+     * Decodes a CmsAccessDataReportCompleted message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {CmsAccessDataReportCompleted & CmsAccessDataReportCompleted.$Shape} CmsAccessDataReportCompleted
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): CmsAccessDataReportCompleted & CmsAccessDataReportCompleted.$Shape;
+
+    /**
+     * Verifies a CmsAccessDataReportCompleted message.
+     * @param message Plain object to verify
+     * @returns `null` if valid, otherwise the reason why it is not
+     */
+    static verify(message: { [k: string]: any }): (string|null);
+
+    /**
+     * Creates a CmsAccessDataReportCompleted message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns CmsAccessDataReportCompleted
+     */
+    static fromObject(object: { [k: string]: any }): CmsAccessDataReportCompleted;
+
+    /**
+     * Creates a plain object from a CmsAccessDataReportCompleted message. Also converts values to other types if specified.
+     * @param message CmsAccessDataReportCompleted
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: CmsAccessDataReportCompleted, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this CmsAccessDataReportCompleted to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for CmsAccessDataReportCompleted
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace CmsAccessDataReportCompleted {
+
+    /** Properties of a CmsAccessDataReportCompleted. */
+    interface $Properties {
+
+        /** CmsAccessDataReportCompleted timestamp */
+        timestamp?: (number|Long|null);
+
+        /** CmsAccessDataReportCompleted hsUserId */
+        hsUserId?: (string|null);
+
+        /** CmsAccessDataReportCompleted trackingId */
+        trackingId?: (string|null);
+
+        /** CmsAccessDataReportCompleted cmsSubmissionId */
+        cmsSubmissionId?: (string|null);
+
+        /** CmsAccessDataReportCompleted reportType */
+        reportType?: (CmsAccessReportType|null);
+
+        /** CmsAccessDataReportCompleted result */
+        result?: (CmsAccessDataReportResult|null);
+
+        /** CmsAccessDataReportCompleted submittedAt */
+        submittedAt?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a CmsAccessDataReportCompleted. */
+    type $Shape = CmsAccessDataReportCompleted.$Properties;
+}
+
 /**
  * Properties of a TaggedCustomField.
  * @deprecated Use TaggedCustomField.$Properties instead.