@awell-health/awell-extensions 2.1.141 → 2.1.142

package/dist/extensions/markdown.json

@@ -160,7 +160,7 @@
     "changelog": "# MessageBird changelog"
   },
   "metriport": {
-    "readme": "---\ntitle: Metriport\ndescription: Metriport is Plaid for healthcare data.\n---\n# Metriport\n\nMetriport is Plaid for healthcare data. We help digital health companies access and manage patient health and medical data, through an open-source and universal API.\n\nThrough a single integration, our API enables modern health companies to get the comprehensive patient data they need from both HIEs and EHRs, as well as popular wearable devices.\n\nAs a developer-first interoperability solution, Metriport is powering the next wave of innovative companies, accelerating a revolution in digital health.\n\nTo learn more visit [https://www.metriport.com/](https://www.metriport.com/)\n# Extension settings\n\nIn order to set up this extension, **you will need to provide a Metriport API key**. You can obtain an API key via the Metriport dashboard by selecting the `Developers tab`. To learn more on how to get started with Metriport visit our [quick start docs](https://docs.metriport.com/medical-api/getting-started/quickstart) for our Medical API. Also, to better understand how our API keys work check out the [API Keys section](https://docs.metriport.com/home/api-info/api-keys) of our docs as well.\n\n# Custom Actions\n\n**GENERAL NOTE: Make sure to create Organizations and Facilities in Metriport before using this extension. A Patient must be associated with a Facility by providing the facilityId when stated in the actions.**\n\n## Create Patient\n\nCreates a Patient in Metriport for the specified Facility where the Patient is receiving care.\n\nOptionally, providing a **Cohort** ID enrolls the Patient in real-time monitoring by adding them to that cohort. Note that enrolling a Patient in real-time monitoring has downstream consequences: once you start receiving updates about the Patient, you are expected to contribute data back to Metriport.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/create-patient) for more info.\n\n## Update Patient\n\nUpdates the specified Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/update-patient) for more info.\n\n## Get Patient\n\nRetrieves the specified Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/get-patient) for more info.\n\n## Remove Patient\n\nRemoves a Patient at Metriport and at HIEs the Patient is linked to.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/delete-patient) for more info.\n\n## List Documents\n\nLists all Documents that can be retrieved for a Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/list-documents) for more info.\n\n**NOTE: It also returns the status of querying Document references across HIEs, indicating whether there is an asynchronous query in progress (status processing) or not (status completed). If the query is in progress, you will also receive the total number of Documents to be queried as well as the ones that have already been completed.**\n\n## Query Documents\n\nTriggers a Document query for the specified Patient across HIEs.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/start-document-query) for more info.\n\n**NOTE: When executed, this endpoint triggers an asynchronous Document query with HIEs and immediately returns the status of Document query, processing .**\n\n## Get Document Url\n\nGets a presigned URL for downloading the specified Document.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/get-document) for more info.\n\n**NOTE: This endpoint returns a URL which you can use to download the specified Document using the file name provided from the List Documents endpoint.**\n\n## More Info\n\nFor more information on how to integrate with Metriport please visit our [Medical API docs](https://docs.metriport.com/medical-api/getting-started/quickstart)\n",
+    "readme": "---\ntitle: Metriport\ndescription: Metriport is Plaid for healthcare data.\n---\n# Metriport\n\nMetriport is Plaid for healthcare data. We help digital health companies access and manage patient health and medical data, through an open-source and universal API.\n\nThrough a single integration, our API enables modern health companies to get the comprehensive patient data they need from both HIEs and EHRs, as well as popular wearable devices.\n\nAs a developer-first interoperability solution, Metriport is powering the next wave of innovative companies, accelerating a revolution in digital health.\n\nTo learn more visit [https://www.metriport.com/](https://www.metriport.com/)\n# Extension settings\n\nIn order to set up this extension, **you will need to provide a Metriport API key**. You can obtain an API key via the Metriport dashboard by selecting the `Developers tab`. To learn more on how to get started with Metriport visit our [quick start docs](https://docs.metriport.com/medical-api/getting-started/quickstart) for our Medical API. Also, to better understand how our API keys work check out the [API Keys section](https://docs.metriport.com/home/api-info/api-keys) of our docs as well.\n\n# Custom Actions\n\n**GENERAL NOTE: Make sure to create Organizations and Facilities in Metriport before using this extension. A Patient must be associated with a Facility by providing the facilityId when stated in the actions.**\n\n## Create Patient\n\nCreates a Patient in Metriport for the specified Facility where the Patient is receiving care.\n\nOptionally, providing a **Cohort** ID enrolls the Patient in real-time monitoring by adding them to that cohort. Note that enrolling a Patient in real-time monitoring has downstream consequences: once you start receiving updates about the Patient, you are expected to contribute data back to Metriport.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/create-patient) for more info.\n\n## Update Patient\n\nUpdates the specified Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/update-patient) for more info.\n\n## Get Patient\n\nRetrieves the specified Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/get-patient) for more info.\n\n## Remove Patient\n\nRemoves a Patient at Metriport and at HIEs the Patient is linked to.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/patient/delete-patient) for more info.\n\n## List Documents\n\nLists all Documents that can be retrieved for a Patient.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/list-documents) for more info.\n\n**NOTE: It also returns the status of querying Document references across HIEs, indicating whether there is an asynchronous query in progress (status processing) or not (status completed). If the query is in progress, you will also receive the total number of Documents to be queried as well as the ones that have already been completed.**\n\n## Query Documents\n\nTriggers a Document query for the specified Patient across HIEs.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/start-document-query) for more info.\n\n**NOTE: When executed, this endpoint triggers an asynchronous Document query with HIEs and immediately returns the status of Document query, processing .**\n\n## Get Document Url\n\nGets a presigned URL for downloading the specified Document.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/document/get-document) for more info.\n\n**NOTE: This endpoint returns a URL which you can use to download the specified Document using the file name provided from the List Documents endpoint.**\n\n## Remove Patient from Cohort\n\nRemoves the specified Patient from a cohort.\n\nVisit [endpoint docs](https://docs.metriport.com/medical-api/api-reference/cohort/remove-patients-from-cohort) for more info.\n\n## More Info\n\nFor more information on how to integrate with Metriport please visit our [Medical API docs](https://docs.metriport.com/medical-api/getting-started/quickstart)\n",
     "changelog": "# Metriport changelog"
   },
   "nexuzhealth": {

package/dist/extensions/metriport/actions/cohort/dataPoints.d.ts

@@ -0,0 +1,10 @@
+export declare const removePatientFromCohortDataPoints: {
+    message: {
+        key: string;
+        valueType: "string";
+    };
+    cohort: {
+        key: string;
+        valueType: "json";
+    };
+};

package/dist/extensions/metriport/actions/cohort/dataPoints.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePatientFromCohortDataPoints = void 0;
+exports.removePatientFromCohortDataPoints = {
+    message: {
+        key: 'message',
+        valueType: 'string',
+    },
+    cohort: {
+        key: 'cohort',
+        valueType: 'json',
+    },
+};
+//# sourceMappingURL=dataPoints.js.map

package/dist/extensions/metriport/actions/cohort/dataPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataPoints.js","sourceRoot":"","sources":["../../../../../extensions/metriport/actions/cohort/dataPoints.ts"],"names":[],"mappings":";;;AAEa,QAAA,iCAAiC,GAAG;IAC/C,OAAO,EAAE;QACP,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,QAAQ;KACpB;IACD,MAAM,EAAE;QACN,GAAG,EAAE,QAAQ;QACb,SAAS,EAAE,MAAM;KAClB;CAC4C,CAAA"}

package/dist/extensions/metriport/actions/cohort/fields.d.ts

@@ -0,0 +1,17 @@
+import { FieldType } from '@awell-health/extensions-core';
+export declare const removePatientFromCohortFields: {
+    cohortId: {
+        id: string;
+        label: string;
+        description: string;
+        type: FieldType.STRING;
+        required: true;
+    };
+    patientId: {
+        id: string;
+        label: string;
+        description: string;
+        type: FieldType.STRING;
+        required: true;
+    };
+};

package/dist/extensions/metriport/actions/cohort/fields.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePatientFromCohortFields = void 0;
+const extensions_core_1 = require("@awell-health/extensions-core");
+exports.removePatientFromCohortFields = {
+    cohortId: {
+        id: 'cohortId',
+        label: 'Cohort ID',
+        description: 'The ID of the cohort to remove the Patient from',
+        type: extensions_core_1.FieldType.STRING,
+        required: true,
+    },
+    patientId: {
+        id: 'patientId',
+        label: 'Patient ID',
+        description: 'The Metriport ID of the Patient to remove from the cohort',
+        type: extensions_core_1.FieldType.STRING,
+        required: true,
+    },
+};
+//# sourceMappingURL=fields.js.map

package/dist/extensions/metriport/actions/cohort/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../../extensions/metriport/actions/cohort/fields.ts"],"names":[],"mappings":";;;AAAA,mEAAqE;AAExD,QAAA,6BAA6B,GAAG;IAC3C,QAAQ,EAAE;QACR,EAAE,EAAE,UAAU;QACd,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,iDAAiD;QAC9D,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,2DAA2D;QACxE,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;CAC8B,CAAA"}

package/dist/extensions/metriport/actions/cohort/removePatientFromCohort.d.ts

@@ -0,0 +1,5 @@
+import { type Action } from '@awell-health/extensions-core';
+import { type settings } from '../../settings';
+import { removePatientFromCohortFields } from './fields';
+import { removePatientFromCohortDataPoints as dataPoints } from './dataPoints';
+export declare const removePatientFromCohort: Action<typeof removePatientFromCohortFields, typeof settings, keyof typeof dataPoints>;

package/dist/extensions/metriport/actions/cohort/removePatientFromCohort.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePatientFromCohort = void 0;
+const extensions_core_1 = require("@awell-health/extensions-core");
+const client_1 = require("../../client");
+const errorHandler_1 = require("../../shared/errorHandler");
+const generic_zod_1 = require("../../validation/generic.zod");
+const fields_1 = require("./fields");
+const dataPoints_1 = require("./dataPoints");
+exports.removePatientFromCohort = {
+    key: 'removePatientFromCohort',
+    category: extensions_core_1.Category.EHR_INTEGRATIONS,
+    title: 'Remove Patient from Cohort',
+    description: 'Removes the specified Patient from a cohort.',
+    fields: fields_1.removePatientFromCohortFields,
+    previewable: true,
+    supports_automated_retries: true,
+    dataPoints: dataPoints_1.removePatientFromCohortDataPoints,
+    onActivityCreated: async (payload, onComplete, onError) => {
+        try {
+            const cohortId = generic_zod_1.stringId.parse(payload.fields.cohortId);
+            const patientId = generic_zod_1.stringId.parse(payload.fields.patientId);
+            const api = (0, client_1.createMetriportApi)(payload.settings);
+            const { message, cohort } = await api.removePatientsFromCohort({
+                cohortId,
+                patientIds: [patientId],
+            });
+            await onComplete({
+                data_points: {
+                    message,
+                    cohort: JSON.stringify(cohort),
+                },
+            });
+        }
+        catch (err) {
+            await (0, errorHandler_1.handleErrorMessage)(err, onError);
+        }
+    },
+};
+//# sourceMappingURL=removePatientFromCohort.js.map

package/dist/extensions/metriport/actions/cohort/removePatientFromCohort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"removePatientFromCohort.js","sourceRoot":"","sources":["../../../../../extensions/metriport/actions/cohort/removePatientFromCohort.ts"],"names":[],"mappings":";;;AACA,mEAAwD;AAExD,yCAAiD;AACjD,4DAA8D;AAC9D,8DAAuD;AACvD,qCAAwD;AACxD,6CAA8E;AAEjE,QAAA,uBAAuB,GAIhC;IACF,GAAG,EAAE,yBAAyB;IAC9B,QAAQ,EAAE,0BAAQ,CAAC,gBAAgB;IACnC,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,8CAA8C;IAC3D,MAAM,EAAE,sCAA6B;IACrC,WAAW,EAAE,IAAI;IACjB,0BAA0B,EAAE,IAAI;IAChC,UAAU,EAAV,8CAAU;IACV,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAiB,EAAE;QACvE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,sBAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YACxD,MAAM,SAAS,GAAG,sBAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;YAE1D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAChD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,wBAAwB,CAAC;gBAC7D,QAAQ;gBACR,UAAU,EAAE,CAAC,SAAS,CAAC;aACxB,CAAC,CAAA;YAEF,MAAM,UAAU,CAAC;gBACf,WAAW,EAAE;oBACX,OAAO;oBACP,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;iBAC/B;aACF,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAA,iCAAkB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;CACF,CAAA"}

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

@@ -481,4 +481,35 @@ export declare const actions: {
             required: false;
         };
     }, "status" | "queries">;
+    removePatientFromCohort: import("@awell-health/extensions-core").Action<{
+        cohortId: {
+            id: string;
+            label: string;
+            description: string;
+            type: import("@awell-health/extensions-core").FieldType.STRING;
+            required: true;
+        };
+        patientId: {
+            id: string;
+            label: string;
+            description: string;
+            type: import("@awell-health/extensions-core").FieldType.STRING;
+            required: true;
+        };
+    }, {
+        apiKey: {
+            key: string;
+            label: string;
+            obfuscated: true;
+            description: string;
+            required: true;
+        };
+        baseUrl: {
+            key: string;
+            label: string;
+            obfuscated: false;
+            description: string;
+            required: false;
+        };
+    }, "message" | "cohort">;
 };

package/dist/extensions/metriport/actions/index.js

@@ -11,6 +11,7 @@ const getUrl_1 = require("./document/getUrl");
 const startNetworkQuery_1 = require("./network/startNetworkQuery");
 const startConsolidatedQuery_1 = require("./consolidated/startConsolidatedQuery");
 const getConsolidatedQueryStatus_1 = require("./consolidated/getConsolidatedQueryStatus");
+const removePatientFromCohort_1 = require("./cohort/removePatientFromCohort");
 exports.actions = {
     getPatient: get_1.getPatient,
     createPatient: create_1.createPatient,
@@ -22,5 +23,6 @@ exports.actions = {
     startNetworkQuery: startNetworkQuery_1.startNetworkQuery,
     startConsolidatedQuery: startConsolidatedQuery_1.startConsolidatedQuery,
     getConsolidatedQueryStatus: getConsolidatedQueryStatus_1.getConsolidatedQueryStatus,
+    removePatientFromCohort: removePatientFromCohort_1.removePatientFromCohort,
 };
 //# sourceMappingURL=index.js.map

package/dist/extensions/metriport/actions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../extensions/metriport/actions/index.ts"],"names":[],"mappings":";;;AAAA,uCAA0C;AAC1C,6CAAgD;AAChD,6CAAgD;AAChD,6CAAgD;AAChD,0CAA+C;AAC/C,4CAA4C;AAC5C,8CAA0C;AAC1C,mEAA+D;AAC/D,kFAA8E;AAC9E,0FAAsF;AAEzE,QAAA,OAAO,GAAG;IACrB,UAAU,EAAV,gBAAU;IACV,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,oBAAa;IACb,SAAS,EAAT,iBAAS;IACT,MAAM,EAAN,eAAM;IACN,iBAAiB,EAAjB,qCAAiB;IACjB,sBAAsB,EAAtB,+CAAsB;IACtB,0BAA0B,EAA1B,uDAA0B;CAC3B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../extensions/metriport/actions/index.ts"],"names":[],"mappings":";;;AAAA,uCAA0C;AAC1C,6CAAgD;AAChD,6CAAgD;AAChD,6CAAgD;AAChD,0CAA+C;AAC/C,4CAA4C;AAC5C,8CAA0C;AAC1C,mEAA+D;AAC/D,kFAA8E;AAC9E,0FAAsF;AACtF,8EAA0E;AAE7D,QAAA,OAAO,GAAG;IACrB,UAAU,EAAV,gBAAU;IACV,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,sBAAa;IACb,aAAa,EAAb,oBAAa;IACb,SAAS,EAAT,iBAAS;IACT,MAAM,EAAN,eAAM;IACN,iBAAiB,EAAjB,qCAAiB;IACjB,sBAAsB,EAAtB,+CAAsB;IACtB,0BAA0B,EAA1B,uDAA0B;IAC1B,uBAAuB,EAAvB,iDAAuB;CACxB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awell-health/awell-extensions",
-  "version": "2.1.141",
+  "version": "2.1.142",
   "packageManager": "yarn@4.5.3",
   "main": "dist/src/index.js",
   "repository": {