@awell-health/awell-extensions 1.0.78 → 1.0.80

package/dist/extensions/healthie/actions/index.d.ts

@@ -49,7 +49,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "appointmentId">;
+    }, "appointmentId", never>;
     createTask: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -123,7 +123,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "taskId">;
+    }, "taskId", never>;
     getAppointment: import("@awell-health/extensions-core").Action<{
         appointmentId: {
             id: string;
@@ -146,7 +146,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "date" | "patientId" | "appointmentTypeId" | "appointmentTypeName" | "contactType">;
+    }, "date" | "patientId" | "appointmentTypeId" | "appointmentTypeName" | "contactType", never>;
     getPatient: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -169,7 +169,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "email" | "firstName" | "lastName" | "dob" | "gender" | "phoneNumber" | "primaryProviderId" | "groupName">;
+    }, "email" | "firstName" | "lastName" | "gender" | "dob" | "phoneNumber" | "primaryProviderId" | "groupName", never>;
     sendChatMessage: import("@awell-health/extensions-core").Action<{
         healthie_patient_id: {
             id: string;
@@ -207,7 +207,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "conversationId">;
+    }, "conversationId", never>;
     createPatient: import("@awell-health/extensions-core").Action<{
         first_name: {
             id: string;
@@ -276,7 +276,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "healthiePatientId">;
+    }, "healthiePatientId", never>;
     updatePatient: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -385,7 +385,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     applyTagToPatient: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -416,7 +416,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     removeTagFromPatient: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -447,7 +447,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     createChartingNote: import("@awell-health/extensions-core").Action<{
         healthie_patient_id: {
             id: string;
@@ -485,7 +485,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     sendFormCompletionRequest: import("@awell-health/extensions-core").Action<{
         healthie_patient_id: {
             id: string;
@@ -572,7 +572,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     archivePatient: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -596,7 +596,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     /**
      * There is bug in Healthie that prevents linking an address with a patient
      * Waiting for fix
@@ -631,7 +631,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     deleteAppointment: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -655,7 +655,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     cancelAppointment: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -679,7 +679,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     /**
      *  Specs of this API endpoint are unclear so we are not sure what
      *  functional value it delivers in the current state. Needs to be revisited.
@@ -707,7 +707,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     completeTask: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -731,7 +731,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
     assignPatientToGroup: import("@awell-health/extensions-core").Action<{
         id: {
             id: string;
@@ -762,5 +762,5 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, string>;
+    }, string, never>;
 };

package/dist/extensions/index.d.ts

@@ -3,4 +3,4 @@ export type Markdown = Record<string, {
     changelog: string;
 }>;
 export declare const markdown: Markdown;
-export declare const extensions: import("@awell-health/extensions-core").Extension[];
+export declare const extensions: import("@awell-health/extensions-core").Extension<any>[];

package/dist/extensions/index.js

@@ -27,6 +27,7 @@ exports.extensions = exports.markdown = void 0;
 // import { AvaAi } from './avaAi'
 const awell_1 = require("./awell");
 const calDotCom_1 = require("./calDotCom");
+const canvasMedical_1 = require("./canvasMedical");
 const cloudinary_1 = require("./cloudinary");
 const dropboxSign_1 = require("./dropboxSign");
 const elation_1 = require("./elation");
@@ -50,6 +51,7 @@ exports.extensions = [
     // AvaAi, Best to disable this until we cleared out data privacy & HIPAA with OpenAI
     awell_1.Awell,
     calDotCom_1.CalDotCom,
+    canvasMedical_1.CanvasMedical,
     cloudinary_1.Cloudinary,
     dropboxSign_1.DropboxSign,
     elation_1.Elation,

package/dist/extensions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../extensions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAkC;AAClC,mCAA+B;AAC/B,2CAAuC;AACvC,6CAAyC;AACzC,+CAA2C;AAC3C,uCAAmC;AACnC,yCAAqC;AACrC,yCAAqC;AACrC,+CAA0C;AAC1C,2CAAuC;AACvC,uCAAmC;AACnC,iCAAsC;AACtC,+CAA2C;AAC3C,2CAAuC;AACvC,qCAAiC;AACjC,yCAAqC;AACrC,6DAA+C;AAC/C,yCAAqC;AACrC,yCAAqC;AACrC,yCAAqC;AACrC,sDAAuC;AAG1B,QAAA,QAAQ,GAAa,IAAI,CAAA;AAEzB,QAAA,UAAU,GAAG;IACxB,oFAAoF;IACpF,aAAK;IACL,qBAAS;IACT,uBAAU;IACV,yBAAW;IACX,iBAAO;IACP,mBAAQ;IACR,mBAAQ;IACR,wBAAU;IACV,qBAAS;IACT,iBAAO;IACP,oBAAa;IACb,yBAAW;IACX,qBAAS;IACT,eAAM;IACN,mBAAQ;IACR,6BAAQ;IACR,mBAAQ;IACR,mBAAQ;IACR,mBAAQ;CACT,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../extensions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAkC;AAClC,mCAA+B;AAC/B,2CAAuC;AACvC,mDAA+C;AAC/C,6CAAyC;AACzC,+CAA2C;AAC3C,uCAAmC;AACnC,yCAAqC;AACrC,yCAAqC;AACrC,+CAA0C;AAC1C,2CAAuC;AACvC,uCAAmC;AACnC,iCAAsC;AACtC,+CAA2C;AAC3C,2CAAuC;AACvC,qCAAiC;AACjC,yCAAqC;AACrC,6DAA+C;AAC/C,yCAAqC;AACrC,yCAAqC;AACrC,yCAAqC;AACrC,sDAAuC;AAG1B,QAAA,QAAQ,GAAa,IAAI,CAAA;AAEzB,QAAA,UAAU,GAAG;IACxB,oFAAoF;IACpF,aAAK;IACL,qBAAS;IACT,6BAAa;IACb,uBAAU;IACV,yBAAW;IACX,iBAAO;IACP,mBAAQ;IACR,mBAAQ;IACR,wBAAU;IACV,qBAAS;IACT,iBAAO;IACP,oBAAa;IACb,yBAAW;IACX,qBAAS;IACT,eAAM;IACN,mBAAQ;IACR,6BAAQ;IACR,mBAAQ;IACR,mBAAQ;IACR,mBAAQ;CACT,CAAA"}

package/dist/extensions/markdown.json

@@ -11,6 +11,10 @@
     "readme": "---\ntitle: Cal.com\ndescription: Cal.com is a modern and open source scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.\n---\n# Cal.com\n\n[Cal.com](https://cal.com/) is a modern and **open source** scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.\n\n## Cal.com x Awell\n\nThis extension allows you to let a stakeholder (eg: a patient) book an appointment as part of a care flow and to retrieve the booking details of an appointment.\n\n## Extension settings\n\nIn order to set up this extension, **you will need to provide a Cal.com API key**. You can obtain an API key via the Cal.com portal (`Settings > Developer > API keys`).\n\n## Custom Actions\n\n### Book appointment action\n\nYou can add this action to your care flow to enable a stakeholder (eg: a patient) to book an appointment in a predefined calendar. This is a **stakeholder-actionable action** which means it requires an actual user to book an appointment. Also note that this is a blocking action and that the care flow will not progress - unless there are parallel tracks or transitions - until the action/activity is completed (i.e. an appointment was booked).\n\n**The actual booking of the appointment can happen in two ways:**\n\n1. With Awell Hosted Pages: when the \"Book appointment\" action is activated, we serve the booking widget to the stakeholder so they can book an appointment directly from within Awell Hosted Pages.\n2. If you are not leveraging Awell Hosted Pages but have built a custom integration then we expose you all the details via our API so you can either create a Cal.com booking widget yourself or redirect the user to the Cal.com platform. Additionally, we expose a mutation that allows you to complete the activity and pass in the required data.\n\nBelow you can find an overview of all Awell Apps and whether they support rendering of the booking widget.\n\n| App                           | Supported |\n| ----------------------------- | --------- |\n| Awell Hosted Pages            | Yes       |\n| Your app (custom integration) | Yes       |\n| Awell Care                    | No        |\n| Awell MyCare                  | No        |\n\n#### Data points\n\nAdding this action to your care flow will expose a new data point you can use in your care flow, the `bookingId`. When the care flow is orchestrated and the book appointment activity is completed, the id of the actual booking will be ingested as the value of that `bookingId` data point.\n\n### Get booking action\n\nThis action allows you to fetch the details of a booking based on the provided `bookingId`. This action will make the following data points available for you to use in your care flow:\n\n1. Event type ID\n2. Title\n3. Description\n4. Start time\n5. End time\n6. Status\n7. Cancel URL\n8. Reschedule URL\n\n## Pricing\n\n**This extension is free** but keep in mind that you might need a paid plan for Cal.com depending on your needs.\n\n## Limitations\n\n### Rescheduling\n\nWhen a previously made booking is rescheduled, there is no way yet to get the new/updated booking details into the care flow or have the care flow react on the updated booking.\n\nAlso note that when a booking is rescheduled, Cal.com doesn't update the original booking resource but creates a new one instead. As far as we know, there is no reference from the old booking to the new (rescheduled) booking.\n\n#### Example\n\nAn appointment has been booked with Cal.com and we have the below booking resource:\n\n```json\n{\n    ...,\n    \"bookingId\": \"1\",\n    \"date\": \"Jan 1, 2023\"\n}\n```\n\nHowever, the patient reschedules the booking to Jan 10, 2023. When querying Cal.com's API (`GET v1/bookings/{bookingId}`), it will still return the old booking date instead of the new/rescheduled date.\n\n```json\n{\n    ...,\n    \"bookingId\": \"1\",\n    \"date\": \"Jan 1, 2023\"\n}\n```\n\n## Webhooks\n\nWebhooks offer a great way to automate the flow with Awell when invitees schedule, cancel, or reschedule events, or when the meeting ends.\n\n**Important notes:**\n\n1. An Awell webhook endpoint can only listen to one event type. So make sure that when you create a webhook in Cal.com, the subscriber URL and the event trigger match the Awell webhook endpoint. This also means there can only be one event type per subscriber URL.\n2. Using a secret to verify the authenticity of the received payload is not yet supported.\n3. Custom payload templates are not supported, please use the default ones.\n",
     "changelog": "# Cal.com changelog\n\n## July 4, 2023\n\n- Get booking action: add validation that bookingId and apiKey are not empty\n- Get booking action: add validation of response data to make sure we have data points\n\n## April 27, 2023\n\n- Get booking action: `startTime` and `endTime` data points are now of value type `date` instead of `string`.\n"
   },
+  "canvasMedical": {
+    "readme": "---\ntitle: Canvas Medical\ndescription: Canvas Medical is a healthcare platform that empowers care delivery companies to revolutionize digital health experiences for their patients and users.\n---\n\n# Canvas Medical\n\nCanvas Medical is a healthcare platform that empowers care delivery companies to revolutionize digital health experiences for their patients and users. Leveraging certified EHR as a foundation, Canvas Medical offers a comprehensive suite of APIs, enabling customers to swiftly launch innovative patient experiences and cost-effective business models.\n\nCanvas Medical provides appointment management, patient data creation and updates, task management, questionnaire creation, and much more.\n\n## Extension settings\n\nFor the extension to function correctly, you must include the following elements in your settings:\n\n`client_id` and `client_secret`: These values are generated on the Canvas Medical platform.\n`base_url`: This determines the base URL for your FHIR endpoint.\n`auth_url`: This determines the base URL for your authorization endpoint.\n\n### Create appointment\n\nEasily schedule appointments with providers using the Canvas API. This action allows you to reserve a meeting with a healthcare provider by submitting `appointmentData` in JSON format. Upon successful execution, the data points returns the unique `appointmentId`, serving as the key within the Canvas API object.\n\n### Create patient\n\nEffortlessly create patients using the Canvas API. This action allows you to generate a new patient record by submitting `patientData` in JSON format. Upon successful execution, the data points returns the unique `patientId`, serving as the key within the Canvas API object.\n\n### Create task\n\nEfficiently create tasks associated with a specific patient using the Canvas API. This action allows you to generate a new task linked to a designated patient by submitting `taskData` in JSON format. Upon successful execution, the data points returns the unique `taskId`, serving as the key within the Canvas API object.\n\n### Create questionnaire responses\n\nCreate questionnaire responses using the Canvas API to effortlessly record answers within an existing questionnaire. This action requires several parameters:\n\n- `questionnaireId`: Reference to the Canvas Questionnaire using the questionnaire id.\n- `subjectId`: Reference to the Canvas Patient using the patient id.\n- `authored`: Timestamp when the Questionnaire response was filled out (If omitted, the current timestamp at data ingestion will be used).\n- `authorId`: Reference to the patient or practitioner filling out the questionnaire. If omitted, it defaults to Canvas Bot.\n- `item`: List of answers to questions in the questionnaire.\n\nUpon successful execution, the data points returns `questionnaireResponseId`, which serves as the key within the Canvas API object.\n\n### Update appointment\n\nEffortlessly cancel or modify a reserved appointment using the Canvas API. This action allows you to update appointment details by submitting `appointmentData` in JSON format. Upon successful execution, the data points returns the `appointmentId`, serving as the key within the Canvas API object.\n\n### Update patient\n\nEfficiently update existing patient information within the system using the Canvas API. This action allows you to modify data by submitting `patientData` in JSON format. Upon successful execution, the data points returns the `patientId`, which serves as the key within the Canvas API object\n\n### Update task\n\nEfficiently update existing task information within the system using the Canvas API. This action allows you to modify data by submitting `taskData` in JSON format. Upon successful execution, the action returns the `taskId`, which serves as the key within the Canvas API object.\n",
+    "changelog": "# Canvas Medical changelog\n\n## 2023-09-01\n\n- Add new actions: `createAppointment`, `createPatient`, `createQuestionnaireResponses`, `createTask`, `updateAppointment`, `updatePatient`, and `updateTask` for enhanced functionality.\n"
+  },
   "cloudinary": {
     "readme": "---\ntitle: Cloudinary\ndescription: Cloudinary is a cloud-based image and video management platform that provides a comprehensive set of tools for storing, managing, and delivering digital media assets. \n---\n# Cloudinary\n\nCloudinary is a cloud-based image and video management platform that provides a comprehensive set of tools for storing, managing, and delivering digital media assets. It enables users to upload, manipulate, optimize, and deliver media files to any device or website quickly and easily.\n\nThe platform offers features such as image and video transformation, automatic image optimization, and responsive image delivery. Cloudinary also provides tools for organizing media assets, including tags, folders, and metadata.\n\n## Custom Actions\n\n### Upload files\n\nThis action allows a given stakeholder to upload one or many files (all file types allowed). Additionally, you can specify in what folder you would like to upload the assets.\n\n**Prerequisites:**\n\n1. You have a Cloudinary account\n2. You have created an upload preset that allows for unsigned uploads\n\n**Limitations:**\n\n- You cannot manage or browse uploaded file(s) in Awell. You can only do that in Cloudinary. To make searching files as easy as possible, you can assign tags to uploaded files and each uploaded file automatically has metadata attached (pathway id and activity id)\n- Only support for unsigned uploads\n- As a user, you cannot delete files you already uploaded\n",
     "changelog": "# Cloudinary changelog"

package/dist/extensions/metriport/actions/index.d.ts

@@ -22,7 +22,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, "state" | "email" | "phone" | "firstName" | "lastName" | "city" | "country" | "zip" | "dob" | "addressLine1" | "addressLine2" | "genderAtBirth" | "driversLicenseValue" | "driversLicenseState">;
+    }, "state" | "email" | "phone" | "firstName" | "lastName" | "city" | "country" | "zip" | "dob" | "addressLine1" | "addressLine2" | "genderAtBirth" | "driversLicenseValue" | "driversLicenseState", never>;
     createPatient: import("@awell-health/extensions-core").Action<{
         phone: {
             id: string;
@@ -139,7 +139,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, "patientId">;
+    }, "patientId", never>;
     updatePatient: import("@awell-health/extensions-core").Action<{
         phone: {
             id: string;
@@ -263,7 +263,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, string>;
+    }, string, never>;
     deletePatient: import("@awell-health/extensions-core").Action<{
         facilityId: {
             id: string;
@@ -294,7 +294,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, string>;
+    }, string, never>;
     listDocuments: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -325,7 +325,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, "queryStatus" | "queryProgressTotal" | "queryProgressComplete">;
+    }, "queryStatus" | "queryProgressTotal" | "queryProgressComplete", never>;
     queryDocs: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -356,7 +356,7 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, "queryStatus" | "queryProgressTotal" | "queryProgressComplete">;
+    }, "queryStatus" | "queryProgressTotal" | "queryProgressComplete", never>;
     getUrl: import("@awell-health/extensions-core").Action<{
         fileName: {
             id: string;
@@ -380,5 +380,5 @@ export declare const actions: {
             description: string;
             required: false;
         };
-    }, "url">;
+    }, "url", never>;
 };

package/dist/extensions/wellinks/actions/index.d.ts

@@ -71,7 +71,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "activeOverride" | "overrideDate">;
+    }, "activeOverride" | "overrideDate", never>;
     checkForScheduledAppointment: import("@awell-health/extensions-core").Action<{
         appointmentTypeId: {
             id: string;
@@ -151,7 +151,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "appointmentScheduled">;
+    }, "appointmentScheduled", never>;
     checkForChat: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -238,7 +238,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "messageSent">;
+    }, "messageSent", never>;
     checkForCheckInOverride: import("@awell-health/extensions-core").Action<{
         patientId: {
             id: string;
@@ -318,7 +318,7 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "activeOverride">;
+    }, "activeOverride", never>;
     insertMemberListEvent: import("@awell-health/extensions-core").Action<{
         eventName: {
             id: string;
@@ -433,5 +433,5 @@ export declare const actions: {
             required: true;
             description: string;
         };
-    }, "insertSuccessful">;
+    }, "insertSuccessful", never>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awell-health/awell-extensions",
-  "version": "1.0.78",
+  "version": "1.0.80",
   "packageManager": "yarn@3.4.1",
   "main": "dist/src/index.js",
   "repository": {
@@ -60,7 +60,7 @@
     "typescript": "4.9.5"
   },
   "dependencies": {
-    "@awell-health/extensions-core": "0.1.9",
+    "@awell-health/extensions-core": "0.1.21",
     "@dropbox/sign": "^1.1.3",
     "@mailchimp/mailchimp_transactional": "^1.0.50",
     "@metriport/api": "^3.1.5",