@opengovsg/refx-ts-sdk 0.0.0-develop-1746623964

package/api/types/FormResponseAnswer.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/FullReferralDto.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface FullReferralDto {
+    id: string;
+    sender: ReferralExchange.InstitutionCoreDto;
+    offering: ReferralExchange.OfferingDto;
+    patient: ReferralExchange.GetReferralPatientDto;
+    referringDoctor: ReferralExchange.ReferringDoctorDto;
+    isSubsidised: boolean;
+    isUrgent: boolean;
+    /** Created at (ISO datetime) */
+    createdAt: string;
+    formResponses: ReferralExchange.FormResponse[];
+    /** List of forms required to complete the referral */
+    forms?: ReferralExchange.Form[];
+    attachments: ReferralExchange.AttachmentDto[];
+    /** URL to view the referral */
+    url?: string;
+    status: ReferralExchange.FullReferralDtoStatus;
+    /** Timeslot start time (ISO datetime) */
+    timeslotStartAt?: string;
+    notes: ReferralExchange.NoteDto[];
+    timelineEvents: ReferralExchange.TimelineEventDto[];
+}

package/api/types/FullReferralDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/FullReferralDtoStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type FullReferralDtoStatus = "draft" | "created" | "processing-has" | "processing-pb" | "processing-ea" | "processing-bright" | "processing-fyi" | "pending-singhealth-formsg" | "pending-singhealth-call-centre" | "referral-confirmed-pending-appt" | "pending-email-ack" | "submitted-to-bright" | "pending-amend-timeslot" | "confirmed" | "sent" | "rejected" | "failed" | "pending-cancelled" | "cancelled";
+export declare const FullReferralDtoStatus: {
+    readonly Draft: "draft";
+    readonly Created: "created";
+    readonly ProcessingHas: "processing-has";
+    readonly ProcessingPb: "processing-pb";
+    readonly ProcessingEa: "processing-ea";
+    readonly ProcessingBright: "processing-bright";
+    readonly ProcessingFyi: "processing-fyi";
+    readonly PendingSinghealthFormsg: "pending-singhealth-formsg";
+    readonly PendingSinghealthCallCentre: "pending-singhealth-call-centre";
+    readonly ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt";
+    readonly PendingEmailAck: "pending-email-ack";
+    readonly SubmittedToBright: "submitted-to-bright";
+    readonly PendingAmendTimeslot: "pending-amend-timeslot";
+    readonly Confirmed: "confirmed";
+    readonly Sent: "sent";
+    readonly Rejected: "rejected";
+    readonly Failed: "failed";
+    readonly PendingCancelled: "pending-cancelled";
+    readonly Cancelled: "cancelled";
+};

package/api/types/FullReferralDtoStatus.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FullReferralDtoStatus = void 0;
+exports.FullReferralDtoStatus = {
+    Draft: "draft",
+    Created: "created",
+    ProcessingHas: "processing-has",
+    ProcessingPb: "processing-pb",
+    ProcessingEa: "processing-ea",
+    ProcessingBright: "processing-bright",
+    ProcessingFyi: "processing-fyi",
+    PendingSinghealthFormsg: "pending-singhealth-formsg",
+    PendingSinghealthCallCentre: "pending-singhealth-call-centre",
+    ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt",
+    PendingEmailAck: "pending-email-ack",
+    SubmittedToBright: "submitted-to-bright",
+    PendingAmendTimeslot: "pending-amend-timeslot",
+    Confirmed: "confirmed",
+    Sent: "sent",
+    Rejected: "rejected",
+    Failed: "failed",
+    PendingCancelled: "pending-cancelled",
+    Cancelled: "cancelled",
+};

package/api/types/GetReferralPatientDto.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface GetReferralPatientDto {
+    /** Patient UIN, e.g. NRIC or FIN */
+    uin: string;
+    /** Patient name */
+    name: string;
+    /** Patient phone number - only Singaporean accepted for now */
+    phoneNumber: string;
+    /** Patient date of birth */
+    dob: string;
+    /** Patient gender */
+    gender: ReferralExchange.GetReferralPatientDtoGender;
+    /** Current CHAS status */
+    chasStatus: string;
+}

package/api/types/GetReferralPatientDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/GetReferralPatientDtoGender.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Patient gender
+ */
+export type GetReferralPatientDtoGender = "Male" | "Female";
+export declare const GetReferralPatientDtoGender: {
+    readonly Male: "Male";
+    readonly Female: "Female";
+};

package/api/types/GetReferralPatientDtoGender.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetReferralPatientDtoGender = void 0;
+exports.GetReferralPatientDtoGender = {
+    Male: "Male",
+    Female: "Female",
+};

package/api/types/InstitutionCoreDto.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InstitutionCoreDto {
+    hciCode: string;
+    name: string;
+    block: string;
+    streetName: string;
+    buildingName?: string;
+    floorNumber?: string;
+    unitNumber?: string;
+    postalCode: string;
+}

package/api/types/InstitutionCoreDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/NotFoundErrorBody.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NotFoundErrorBody {
+    statusCode?: number;
+    message?: string;
+    error?: string;
+}

package/api/types/NotFoundErrorBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/NoteDto.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NoteDto {
+    id: string;
+    content: string;
+    authorHciCode: string;
+    authorName: string;
+    createdAt: number;
+    updatedAt: number;
+}

package/api/types/NoteDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/OfferingDto.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface OfferingDto {
+    id: string;
+    /** Name of the offering - use these as labels */
+    name: string;
+    institutionHciCode: string;
+    institution: ReferralExchange.InstitutionCoreDto;
+    system: ReferralExchange.System;
+    /** Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. May contain URLs - should be rendered in a Linkify component */
+    description: string;
+    /** Whether the offering is able to receive new referrals currently */
+    isActive: boolean;
+    /** Whether this offering supports subsidized referrals. */
+    isSubsidisable: boolean;
+    timeslotPolicy: ReferralExchange.TimeslotPolicy;
+}

package/api/types/OfferingDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/OfferingWithAllowedDto.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface OfferingWithAllowedDto {
+    id: string;
+    /** Name of the offering - use these as labels */
+    name: string;
+    institutionHciCode: string;
+    institution: ReferralExchange.InstitutionCoreDto;
+    system: ReferralExchange.System;
+    /** Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. May contain URLs - should be rendered in a Linkify component */
+    description: string;
+    /** Whether the offering is able to receive new referrals currently */
+    isActive: boolean;
+    /** Whether this offering supports subsidized referrals. */
+    isSubsidisable: boolean;
+    timeslotPolicy: ReferralExchange.TimeslotPolicy;
+    /** Whether the offering is allowed based on the provided query parameters */
+    isAllowed: boolean;
+}

package/api/types/OfferingWithAllowedDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/OkResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OkResponse {
+    status: "ok";
+}

package/api/types/OkResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaginatedQuery.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PaginatedQuery {
+    /** Offset for pagination */
+    offset?: number;
+    /** Number of items per page */
+    pageSize?: number;
+}

package/api/types/PaginatedQuery.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaginatedReferralsDto.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface PaginatedReferralsDto {
+    data: ReferralExchange.ReferralDto[];
+    metadata: ReferralExchange.PaginationMetadata;
+}

package/api/types/PaginatedReferralsDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaginationMetadata.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface PaginationMetadata {
+    hasNext: boolean;
+    totalCount: number;
+    nextParams?: ReferralExchange.PaginatedQuery;
+}

package/api/types/PaginationMetadata.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PublicReferralDto.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface PublicReferralDto {
+    id: string;
+    sender: ReferralExchange.InstitutionCoreDto;
+    offering: ReferralExchange.OfferingDto;
+    patient: ReferralExchange.GetReferralPatientDto;
+    referringDoctor: ReferralExchange.ReferringDoctorDto;
+    isSubsidised: boolean;
+    isUrgent: boolean;
+    /** Created at (ISO datetime) */
+    createdAt: string;
+    formResponses: ReferralExchange.FormResponse[];
+    /** List of forms required to complete the referral */
+    forms?: ReferralExchange.Form[];
+    attachments: ReferralExchange.AttachmentDto[];
+    /** URL to view the referral */
+    url?: string;
+}

package/api/types/PublicReferralDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ReferralDto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface ReferralDto {
+    id: string;
+    sender: ReferralExchange.InstitutionCoreDto;
+    offering: ReferralExchange.OfferingDto;
+    patient: ReferralExchange.GetReferralPatientDto;
+    referringDoctor: ReferralExchange.ReferringDoctorDto;
+    isSubsidised: boolean;
+    isUrgent: boolean;
+    /** Created at (ISO datetime) */
+    createdAt: string;
+    formResponses: ReferralExchange.FormResponse[];
+    /** List of forms required to complete the referral */
+    forms?: ReferralExchange.Form[];
+    attachments: ReferralExchange.AttachmentDto[];
+    /** URL to view the referral */
+    url?: string;
+    status: ReferralExchange.ReferralDtoStatus;
+    /** Timeslot start time (ISO datetime) */
+    timeslotStartAt?: string;
+    notes: ReferralExchange.NoteDto[];
+}

package/api/types/ReferralDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ReferralDtoStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ReferralDtoStatus = "draft" | "created" | "processing-has" | "processing-pb" | "processing-ea" | "processing-bright" | "processing-fyi" | "pending-singhealth-formsg" | "pending-singhealth-call-centre" | "referral-confirmed-pending-appt" | "pending-email-ack" | "submitted-to-bright" | "pending-amend-timeslot" | "confirmed" | "sent" | "rejected" | "failed" | "pending-cancelled" | "cancelled";
+export declare const ReferralDtoStatus: {
+    readonly Draft: "draft";
+    readonly Created: "created";
+    readonly ProcessingHas: "processing-has";
+    readonly ProcessingPb: "processing-pb";
+    readonly ProcessingEa: "processing-ea";
+    readonly ProcessingBright: "processing-bright";
+    readonly ProcessingFyi: "processing-fyi";
+    readonly PendingSinghealthFormsg: "pending-singhealth-formsg";
+    readonly PendingSinghealthCallCentre: "pending-singhealth-call-centre";
+    readonly ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt";
+    readonly PendingEmailAck: "pending-email-ack";
+    readonly SubmittedToBright: "submitted-to-bright";
+    readonly PendingAmendTimeslot: "pending-amend-timeslot";
+    readonly Confirmed: "confirmed";
+    readonly Sent: "sent";
+    readonly Rejected: "rejected";
+    readonly Failed: "failed";
+    readonly PendingCancelled: "pending-cancelled";
+    readonly Cancelled: "cancelled";
+};

package/api/types/ReferralDtoStatus.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralDtoStatus = void 0;
+exports.ReferralDtoStatus = {
+    Draft: "draft",
+    Created: "created",
+    ProcessingHas: "processing-has",
+    ProcessingPb: "processing-pb",
+    ProcessingEa: "processing-ea",
+    ProcessingBright: "processing-bright",
+    ProcessingFyi: "processing-fyi",
+    PendingSinghealthFormsg: "pending-singhealth-formsg",
+    PendingSinghealthCallCentre: "pending-singhealth-call-centre",
+    ReferralConfirmedPendingAppt: "referral-confirmed-pending-appt",
+    PendingEmailAck: "pending-email-ack",
+    SubmittedToBright: "submitted-to-bright",
+    PendingAmendTimeslot: "pending-amend-timeslot",
+    Confirmed: "confirmed",
+    Sent: "sent",
+    Rejected: "rejected",
+    Failed: "failed",
+    PendingCancelled: "pending-cancelled",
+    Cancelled: "cancelled",
+};

package/api/types/ReferralEligibility.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ReferralEligibility {
+    isAllowed: boolean;
+    /** Will be present if isAllowed is false */
+    reason?: string;
+}

package/api/types/ReferralEligibility.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ReferralRole.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ReferralRole = "sender" | "receiver";
+export declare const ReferralRole: {
+    readonly Sender: "sender";
+    readonly Receiver: "receiver";
+};

package/api/types/ReferralRole.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralRole = void 0;
+exports.ReferralRole = {
+    Sender: "sender",
+    Receiver: "receiver",
+};

package/api/types/ReferralStatusFilter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ReferralStatusFilter = "draft" | "pending" | "confirmed" | "rejected" | "cancelled";
+export declare const ReferralStatusFilter: {
+    readonly Draft: "draft";
+    readonly Pending: "pending";
+    readonly Confirmed: "confirmed";
+    readonly Rejected: "rejected";
+    readonly Cancelled: "cancelled";
+};

package/api/types/ReferralStatusFilter.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralStatusFilter = void 0;
+exports.ReferralStatusFilter = {
+    Draft: "draft",
+    Pending: "pending",
+    Confirmed: "confirmed",
+    Rejected: "rejected",
+    Cancelled: "cancelled",
+};

package/api/types/ReferrerIdType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Type of ID specified in referrerId. Use together with `referrerId` and `referrerInstitutionId` to filter based on referrer.
+ */
+export type ReferrerIdType = "mcr";

package/api/types/ReferrerIdType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ReferringDoctorDto.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ReferringDoctorDto {
+    mcr: string;
+    name: string;
+    email: string;
+    contactNumber: string;
+}

package/api/types/ReferringDoctorDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SubsidyEligibility.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface SubsidyEligibility {
+    isAllowed: boolean;
+    /** Will be present if isAllowed is false */
+    reason?: string;
+    scheme: ReferralExchange.SubsidyEligibilityScheme;
+}

package/api/types/SubsidyEligibility.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SubsidyEligibilityScheme.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type SubsidyEligibilityScheme = "chas" | "saf" | "none";
+export declare const SubsidyEligibilityScheme: {
+    readonly Chas: "chas";
+    readonly Saf: "saf";
+    readonly None: "none";
+};

package/api/types/SubsidyEligibilityScheme.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubsidyEligibilityScheme = void 0;
+exports.SubsidyEligibilityScheme = {
+    Chas: "chas",
+    Saf: "saf",
+    None: "none",
+};

package/api/types/System.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type System = "HAS" | "PartnersBuddy" | "Refer" | "EmailAck" | "Bright" | "FYI";
+export declare const System: {
+    readonly Has: "HAS";
+    readonly PartnersBuddy: "PartnersBuddy";
+    readonly Refer: "Refer";
+    readonly EmailAck: "EmailAck";
+    readonly Bright: "Bright";
+    readonly Fyi: "FYI";
+};

package/api/types/System.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.System = void 0;
+exports.System = {
+    Has: "HAS",
+    PartnersBuddy: "PartnersBuddy",
+    Refer: "Refer",
+    EmailAck: "EmailAck",
+    Bright: "Bright",
+    Fyi: "FYI",
+};

package/api/types/TimelineEventDto.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as ReferralExchange from "../index";
+export interface TimelineEventDto {
+    type: ReferralExchange.TimelineEventType;
+    description: string;
+    /** milliseconds since epoch */
+    producedAt: number;
+    /** System that produced the event */
+    system: ReferralExchange.TimelineEventDtoSystem;
+}

package/api/types/TimelineEventDto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });