@headspace/protos-events 1.829.0 → 1.830.0

package/lib/index.d.ts

@@ -88606,6 +88606,402 @@ export namespace HealthRecordAiNoteFeedbackSubmitted {
     type $Shape = HealthRecordAiNoteFeedbackSubmitted.$Properties;
 }
 
+/** HieDeliveryResourceType enum. */
+export enum HieDeliveryResourceType {
+
+    /** HIE_DELIVERY_RESOURCE_TYPE_UNKNOWN value */
+    HIE_DELIVERY_RESOURCE_TYPE_UNKNOWN = 0,
+
+    /** HIE_DELIVERY_RESOURCE_TYPE_OBSERVATION value */
+    HIE_DELIVERY_RESOURCE_TYPE_OBSERVATION = 1,
+
+    /** HIE_DELIVERY_RESOURCE_TYPE_CLINICAL_NOTE_BUNDLE value */
+    HIE_DELIVERY_RESOURCE_TYPE_CLINICAL_NOTE_BUNDLE = 2,
+
+    /** HIE_DELIVERY_RESOURCE_TYPE_ENCOUNTER value */
+    HIE_DELIVERY_RESOURCE_TYPE_ENCOUNTER = 3
+}
+
+/** HieDeliverySourceEvent enum. */
+export enum HieDeliverySourceEvent {
+
+    /** HIE_DELIVERY_SOURCE_EVENT_UNKNOWN value */
+    HIE_DELIVERY_SOURCE_EVENT_UNKNOWN = 0,
+
+    /** HIE_DELIVERY_SOURCE_EVENT_GINGER_CLINICAL_NOTE_EXPORTED value */
+    HIE_DELIVERY_SOURCE_EVENT_GINGER_CLINICAL_NOTE_EXPORTED = 1,
+
+    /** HIE_DELIVERY_SOURCE_EVENT_PHQ_ASSESSMENT_SCORED_COMPLETED value */
+    HIE_DELIVERY_SOURCE_EVENT_PHQ_ASSESSMENT_SCORED_COMPLETED = 2,
+
+    /** HIE_DELIVERY_SOURCE_EVENT_COACHING_ENCOUNTER_EXPORTED value */
+    HIE_DELIVERY_SOURCE_EVENT_COACHING_ENCOUNTER_EXPORTED = 3
+}
+
+/** HieDeliveryFailureReason enum. */
+export enum HieDeliveryFailureReason {
+
+    /** HIE_DELIVERY_FAILURE_REASON_UNKNOWN value */
+    HIE_DELIVERY_FAILURE_REASON_UNKNOWN = 0,
+
+    /** HIE_DELIVERY_FAILURE_REASON_BROKER_4XX value */
+    HIE_DELIVERY_FAILURE_REASON_BROKER_4XX = 1,
+
+    /** HIE_DELIVERY_FAILURE_REASON_BROKER_5XX value */
+    HIE_DELIVERY_FAILURE_REASON_BROKER_5XX = 2,
+
+    /** HIE_DELIVERY_FAILURE_REASON_CONSENT_INACTIVE value */
+    HIE_DELIVERY_FAILURE_REASON_CONSENT_INACTIVE = 3,
+
+    /** HIE_DELIVERY_FAILURE_REASON_PATIENT_NOT_REGISTERED value */
+    HIE_DELIVERY_FAILURE_REASON_PATIENT_NOT_REGISTERED = 4,
+
+    /** HIE_DELIVERY_FAILURE_REASON_S3_READ_FAILED value */
+    HIE_DELIVERY_FAILURE_REASON_S3_READ_FAILED = 5,
+
+    /** HIE_DELIVERY_FAILURE_REASON_BUNDLE_VALIDATION_FAILED value */
+    HIE_DELIVERY_FAILURE_REASON_BUNDLE_VALIDATION_FAILED = 6,
+
+    /** HIE_DELIVERY_FAILURE_REASON_RETRY_EXHAUSTED value */
+    HIE_DELIVERY_FAILURE_REASON_RETRY_EXHAUSTED = 7
+}
+
+/**
+ * Properties of a HieDeliverySucceeded.
+ * @deprecated Use HieDeliverySucceeded.$Properties instead.
+ */
+export interface IHieDeliverySucceeded extends HieDeliverySucceeded.$Properties {
+}
+
+/**
+ * Published when hs-hie-service successfully submits a FHIR Bundle to the HIE
+ * connectivity broker. One event is emitted for each upstream source delivery.
+ * Contains no clinical content or PHI beyond opaque identifiers.
+ * Used by hs-cms-access-service for delivery audit of Observation outcomes
+ * (and later Observation-to-Goal ordering when CMS ACCESS Goal/CarePlan
+ * pipelines are registered); other services may subscribe for delivery
+ * confirmation without coupling to a broker.
+ * Fired by: hs-hie-service
+ * Responsible team: Commercial Platform
+ */
+export class HieDeliverySucceeded {
+
+    /**
+     * Constructs a new HieDeliverySucceeded.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: HieDeliverySucceeded.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** HieDeliverySucceeded timestamp. */
+    timestamp: (number|Long);
+
+    /** HieDeliverySucceeded hsUserId. */
+    hsUserId: string;
+
+    /** HieDeliverySucceeded resourceType. */
+    resourceType: HieDeliveryResourceType;
+
+    /** HieDeliverySucceeded sourceEvent. */
+    sourceEvent: HieDeliverySourceEvent;
+
+    /** HieDeliverySucceeded sourceEventId. */
+    sourceEventId: string;
+
+    /** HieDeliverySucceeded externalDeliveryId. */
+    externalDeliveryId: string;
+
+    /** HieDeliverySucceeded deliveredAt. */
+    deliveredAt: (number|Long);
+
+    /**
+     * Creates a new HieDeliverySucceeded instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns HieDeliverySucceeded instance
+     */
+    static create(properties: HieDeliverySucceeded.$Shape): HieDeliverySucceeded & HieDeliverySucceeded.$Shape;
+    static create(properties?: HieDeliverySucceeded.$Properties): HieDeliverySucceeded;
+
+    /**
+     * Encodes the specified HieDeliverySucceeded message. Does not implicitly {@link HieDeliverySucceeded.verify|verify} messages.
+     * @param message HieDeliverySucceeded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: HieDeliverySucceeded.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified HieDeliverySucceeded message, length delimited. Does not implicitly {@link HieDeliverySucceeded.verify|verify} messages.
+     * @param message HieDeliverySucceeded message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: HieDeliverySucceeded.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a HieDeliverySucceeded message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {HieDeliverySucceeded & HieDeliverySucceeded.$Shape} HieDeliverySucceeded
+     * @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): HieDeliverySucceeded & HieDeliverySucceeded.$Shape;
+
+    /**
+     * Decodes a HieDeliverySucceeded message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {HieDeliverySucceeded & HieDeliverySucceeded.$Shape} HieDeliverySucceeded
+     * @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)): HieDeliverySucceeded & HieDeliverySucceeded.$Shape;
+
+    /**
+     * Verifies a HieDeliverySucceeded 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 HieDeliverySucceeded message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns HieDeliverySucceeded
+     */
+    static fromObject(object: { [k: string]: any }): HieDeliverySucceeded;
+
+    /**
+     * Creates a plain object from a HieDeliverySucceeded message. Also converts values to other types if specified.
+     * @param message HieDeliverySucceeded
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: HieDeliverySucceeded, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this HieDeliverySucceeded to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for HieDeliverySucceeded
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace HieDeliverySucceeded {
+
+    /** Properties of a HieDeliverySucceeded. */
+    interface $Properties {
+
+        /** HieDeliverySucceeded timestamp */
+        timestamp?: (number|Long|null);
+
+        /** HieDeliverySucceeded hsUserId */
+        hsUserId?: (string|null);
+
+        /** HieDeliverySucceeded resourceType */
+        resourceType?: (HieDeliveryResourceType|null);
+
+        /** HieDeliverySucceeded sourceEvent */
+        sourceEvent?: (HieDeliverySourceEvent|null);
+
+        /** HieDeliverySucceeded sourceEventId */
+        sourceEventId?: (string|null);
+
+        /** HieDeliverySucceeded externalDeliveryId */
+        externalDeliveryId?: (string|null);
+
+        /** HieDeliverySucceeded deliveredAt */
+        deliveredAt?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a HieDeliverySucceeded. */
+    type $Shape = HieDeliverySucceeded.$Properties;
+}
+
+/**
+ * Properties of a HieDeliveryFailed.
+ * @deprecated Use HieDeliveryFailed.$Properties instead.
+ */
+export interface IHieDeliveryFailed extends HieDeliveryFailed.$Properties {
+}
+
+/**
+ * Published when hs-hie-service exhausts retries or encounters a non-retryable error
+ * and will not deliver the upstream source event to the HIE connectivity broker.
+ * Contains no clinical content or PHI beyond opaque identifiers. last_error is sanitized
+ * and must not contain PII, PHI, a vendor product name, or broker response payload content.
+ * Used by producer audit and alerting subscribers and hs-cms-access-service observability.
+ * Fired by: hs-hie-service
+ * Responsible team: Commercial Platform
+ */
+export class HieDeliveryFailed {
+
+    /**
+     * Constructs a new HieDeliveryFailed.
+     * @param [properties] Properties to set
+     */
+    constructor(properties?: HieDeliveryFailed.$Properties);
+
+    /** Unknown fields preserved while decoding */
+    $unknowns?: Uint8Array[];
+
+    /** HieDeliveryFailed timestamp. */
+    timestamp: (number|Long);
+
+    /** HieDeliveryFailed hsUserId. */
+    hsUserId: string;
+
+    /** HieDeliveryFailed resourceType. */
+    resourceType: HieDeliveryResourceType;
+
+    /** HieDeliveryFailed sourceEvent. */
+    sourceEvent: HieDeliverySourceEvent;
+
+    /** HieDeliveryFailed sourceEventId. */
+    sourceEventId: string;
+
+    /** HieDeliveryFailed attemptCount. */
+    attemptCount: number;
+
+    /** HieDeliveryFailed failureReason. */
+    failureReason: HieDeliveryFailureReason;
+
+    /** HieDeliveryFailed lastError. */
+    lastError: string;
+
+    /** HieDeliveryFailed failedAt. */
+    failedAt: (number|Long);
+
+    /**
+     * Creates a new HieDeliveryFailed instance using the specified properties.
+     * @param [properties] Properties to set
+     * @returns HieDeliveryFailed instance
+     */
+    static create(properties: HieDeliveryFailed.$Shape): HieDeliveryFailed & HieDeliveryFailed.$Shape;
+    static create(properties?: HieDeliveryFailed.$Properties): HieDeliveryFailed;
+
+    /**
+     * Encodes the specified HieDeliveryFailed message. Does not implicitly {@link HieDeliveryFailed.verify|verify} messages.
+     * @param message HieDeliveryFailed message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encode(message: HieDeliveryFailed.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Encodes the specified HieDeliveryFailed message, length delimited. Does not implicitly {@link HieDeliveryFailed.verify|verify} messages.
+     * @param message HieDeliveryFailed message or plain object to encode
+     * @param [writer] Writer to encode to
+     * @returns Writer
+     */
+    static encodeDelimited(message: HieDeliveryFailed.$Properties, writer?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a HieDeliveryFailed message from the specified reader or buffer.
+     * @param reader Reader or buffer to decode from
+     * @param [length] Message length if known beforehand
+     * @returns {HieDeliveryFailed & HieDeliveryFailed.$Shape} HieDeliveryFailed
+     * @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): HieDeliveryFailed & HieDeliveryFailed.$Shape;
+
+    /**
+     * Decodes a HieDeliveryFailed message from the specified reader or buffer, length delimited.
+     * @param reader Reader or buffer to decode from
+     * @returns {HieDeliveryFailed & HieDeliveryFailed.$Shape} HieDeliveryFailed
+     * @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)): HieDeliveryFailed & HieDeliveryFailed.$Shape;
+
+    /**
+     * Verifies a HieDeliveryFailed 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 HieDeliveryFailed message from a plain object. Also converts values to their respective internal types.
+     * @param object Plain object
+     * @returns HieDeliveryFailed
+     */
+    static fromObject(object: { [k: string]: any }): HieDeliveryFailed;
+
+    /**
+     * Creates a plain object from a HieDeliveryFailed message. Also converts values to other types if specified.
+     * @param message HieDeliveryFailed
+     * @param [options] Conversion options
+     * @returns Plain object
+     */
+    static toObject(message: HieDeliveryFailed, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this HieDeliveryFailed to JSON.
+     * @returns JSON object
+     */
+    toJSON(): { [k: string]: any };
+
+    /**
+     * Gets the type url for HieDeliveryFailed
+     * @param [prefix] Custom type url prefix, defaults to `"type.googleapis.com"`
+     * @returns The type url
+     */
+    static getTypeUrl(prefix?: string): string;
+}
+
+export namespace HieDeliveryFailed {
+
+    /** Properties of a HieDeliveryFailed. */
+    interface $Properties {
+
+        /** HieDeliveryFailed timestamp */
+        timestamp?: (number|Long|null);
+
+        /** HieDeliveryFailed hsUserId */
+        hsUserId?: (string|null);
+
+        /** HieDeliveryFailed resourceType */
+        resourceType?: (HieDeliveryResourceType|null);
+
+        /** HieDeliveryFailed sourceEvent */
+        sourceEvent?: (HieDeliverySourceEvent|null);
+
+        /** HieDeliveryFailed sourceEventId */
+        sourceEventId?: (string|null);
+
+        /** HieDeliveryFailed attemptCount */
+        attemptCount?: (number|null);
+
+        /** HieDeliveryFailed failureReason */
+        failureReason?: (HieDeliveryFailureReason|null);
+
+        /** HieDeliveryFailed lastError */
+        lastError?: (string|null);
+
+        /** HieDeliveryFailed failedAt */
+        failedAt?: (number|Long|null);
+
+        /** Unknown fields preserved while decoding */
+        $unknowns?: Uint8Array[];
+    }
+
+    /** Shape of a HieDeliveryFailed. */
+    type $Shape = HieDeliveryFailed.$Properties;
+}
+
 /**
  * Properties of an InteractiveJournalingParticipant.
  * @deprecated Use InteractiveJournalingParticipant.$Properties instead.