fluent-cerner-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 geekmdtravis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# fluent-cerner-js
+
+A fluent `MPAGE_EVENT` string generation library.
+
+| Environment | CI                                                                                                                             | Publish                                                                                                               |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
+| Production  | ![Main Build](https://github.com/geekmdtravis/fluent-cerner-js/actions/workflows/main.yml/badge.svg?branch=main)               | ![Main Publish](https://github.com/geekmdtravis/fluent-cerner-js/actions/workflows/publish.yml/badge.svg?branch=main) |
+| Development | ![Development Build](https://github.com/geekmdtravis/fluent-cerner-js/actions/workflows/main.yml/badge.svg?branch=development) | Not Applicable                                                                                                        |
+
+## Resources
+
+- [MPage Developer Guide - MPAGE_EVENT Orders](https://wiki.cerner.com/display/public/MPDEVWIKI/MPAGES_EVENT-ORDERS)
+
+### Anatomy of an `MPAGE_EVENT` String
+
+An `MPAGE_EVENT` string takes the form:
+
+```
+personId|encounterId|orderList|customizeFlags|tabList|defaultDisplay|silentSignFlag
+```
+
+Where `orderList` is a series of braces-contained, pipe-delimited strings that takes the form:
+
+```
+{orderAction|orderId|synonymId|orderOrigination|orderSentenceId|nomenclatureId|signTimeInteractionFlag}
+```
+
+Where `tabList` is a single brace-contained, pip-delimited string that takes the form:
+
+```
+{tab|tabDisplayFlags}
+```
+
+### Definitions
+
+- `personId`: The `person_id` of the patient whose Modal Order Entry Window (MOEW) is to be displayed.
+- `encounterId`: The `encntr_id` of the patient whose MOEW is to be displayed.
+- `orderList`: The list of order actions and properties that define the data that is to be loaded into the MOEW.
+  - A set that must be enclosed by curly brackets `{` and `}`.
+  - If you want only to launch into the MOEW and not to add any new orders or perform any other order actions, an empty orderAction / orderProperties set of `{ORDER|0|0|0|0|0}` can be used.
+- `orderAction`: The type of action to be performed on an order.
+  - Must follow the `{"ORDER"|synonymId|orderOrigination|orderSentenceId|nomenclatureId|signTimeInteractionFlag}` signature.
+    - `"ORDER"` The prototype for placing a new order.
+  - Must follow the `{<ORDER_ACTION_TYPE>|orderId}` signature.
+    - `"ACTIVATE"` - The prototype for activating an existing future order.
+    - `"CANCEL DC"` The prototype for canceling / discontinuing an existing order.
+    - `"CANCEL REORD"` The prototype for canceling and reordering an existing order.
+    - `"CLEAR"` The prototype for clearing the future actions of an existing order.
+    - `"CONVERT_INPAT"` The prototype for converting a historical or prescription order into an inpatient order.
+    - `"CONVERT_RX"` The prototype for converting an existing non-prescription order to a prescription order.
+    - `"MODIFY"` The prototype for modifying an existing order.
+    - `"RENEW"` The prototype for renewing an existing non-prescription order.
+    - `"RENEW_RX"` The prototype for renewing an existing prescription order.
+    - `"REPEAT"` The prototype for copying an existing order.
+    - `"RESUME"` The prototype for resuming an existing suspended order.
+    - `"SUSPEND"` The prototype for suspending an existing order.
+  - Child Paramters:
+    - `orderId`: The `order_id` associated with an existing order.
+    - `synonymId`: The `synonym_id` to be associated with the new order.
+    - `orderOrigination`: The type of order to be associated with the new order. A value of represents a normal order.
+      - `1`: Prescription order.
+      - `5`: satellite order
+    - `orderSenteceId`: The optional `order_sentence_id` to be associated with the new order.
+    - `nomenclatureId`: The optional `nomenclature_id` to be associated with the new order.
+    - `signTimeInterationFlag`: A Boolean flag to determine if interaction checking should only be performed at sign-time or not.
+- `customizeFlags`: A set of flags that can be used to define the style of the MOEW.
+  - `0`: default, no PowerPlans.
+  - `24`: enable PowerPlans.
+- `tabList`: The customization data for the different tab(s) of the MOEW.
+  - A set that must be enclosed by the `{` and `}` braces.
+  - Parameters within the sets are pipe-delimited.
+  - Child Parameters
+    - `tab`: The tab that is to be modified.
+      - `2`: customizations to the Order List profile.
+      - `3`: customizations to the Medication List profile.
+    - `tabDisplayFlags`: A set of flags that can be used to define the style of the tab being altered by 'tab'.
+      - `127` For full PowerOrders functionality.
+- `defaultDisplay`: The view to display by default when launching into the MOEW.
+  - `8`: default to the order search.
+  - `16`: default to the order profile.
+  - `32`: default to the orders for signature.
+- `silentSignFlag` (optional): A Boolean flag used to determine if the MOEW should sign orders silently. When this flag is set, and the required details on each new order are pre-populated, it causes the orders to be signed automatically without displaying the MOEW. Orders are signed automatically when existing orders are not already on the scratchpad and no other orderActions are present.
+
+### Example
+
+One would read the following:
+
+```
+6204|3623|{REPEAT|123456}{REPEAT|654321}{REPEAT|987654}|24|{2|127}|16
+```
+
+As:
+
+- For patient `6204`,
+- In encounter `3623`,
+- We will copy the following list orders by their `orderId`:
+  - 123456
+  - 654321
+  - 987654
+- With **PowerPlans** enabled,
+- Customizing the **Order List Profile** with **PowerOrder** functionality
+- Defaulting to the **Order Profile** view.
+
+## API In Action [Under Construction]
+
+Add order's one at a time (or via a loop):
+
+```js
+const fcjs = require('fluent-cerner-js');
+const MPageOrder = fcjs.MPageOrder;
+const MPageOrderEvent = fcjs.MPageOrderEvent;
+
+// Make a new order from an existing order which serves as a template for copy.
+const order1 = new MPageOrder();
+order1.willCopyExistingOrder(12345);
+
+// Make a new order from scratch, declare that it's a prescription order.
+const order2 = new MPageOrder();
+order2.willMakeNewOrder(1343, { isRxOrder: true });
+
+// Make a new order from scratch, declare that it's a non-prescription order,
+// reference an order sentence id and a nomenclature id in addition to requesting
+// skip interaction checks until sign.
+const opts = {
+  orderSentenceId: 3,
+  nomenclatureId: 14,
+  skipInteractionCheckUntilSign: true,
+};
+const order3 = new MPageOrder();
+order3.willMakeNewOrder(3428, opts);
+
+// Prepare the MPage event for person 1231251 on encounter 812388.
+const event = new MPageOrderEvent();
+event
+  .forPerson(1231251)
+  .forEncounter(812388)
+  .addOrders([order1, order2, order3])
+  .enablePowerPlans()
+  .customizeOrderListProfile()
+  .enablePowerOrders()
+  .launchOrderProfile();
+
+// Send the MPage event to the server.
+event.send();
+```
+
+You can also invoke the "toString()" override method to confirm your order string is correct.
+
+```js
+console.log(`MPage Event String:\n${mpageEvent}\n`);
+```
+
+Result:
+
+```sh
+1231251|812388|{REPEAT|12345}{ORDER|1343|1|0|0|0}{ORDER|3428|0|3|14|1}|24|{2|127}|16|0
+```

package/dist/MPageOrder.d.ts

@@ -0,0 +1,156 @@
+/**
+ * Options for a new order
+ * @param {boolean} isRxOrder Marks the order order as a prescription. Is mutually exclusive from
+ * isSatelliteOrder. Field will be set to false if left undefined; this resolves to 0 when built.
+ * @param {boolean} isSatelliteOrder Moarks the order origination as satellite. Is mutually
+ * exclusive from isRxOrder. Field will be set to false if left undefined; this resolves to 0 when built.
+ * @param {number} orderSentenceId The optional Cerner order_sentence_id to be associated with
+ * the new order. Field will be set to 0 if undefined.
+ * @param {number} nomenclatureId The optional Cerner nomenclature_id to be associated with the
+ * new order. Field will be set to 0 if undefined.
+ * @param {boolean} skipInteractionCheckUntilSign Determines cerner sign-time interaction
+ * checking. A value of true skips checking for interactions until orders are signed, false
+ * will not. Field will be set to false if left undefined; this resolves to 0 when built.
+ */
+export declare type NewOrderOpts = {
+    isRxOrder?: boolean;
+    isSatelliteOrder?: boolean;
+    orderSentenceId?: number;
+    nomenclatureId?: number;
+    skipInteractionCheckUntilSign?: boolean;
+};
+export declare class MPageOrder {
+    private _orderAction;
+    getOrderAction: () => string;
+    private _orderId;
+    getOrderId: () => number;
+    private _synonymId;
+    getSynonymId: () => number;
+    private _orderOrigination;
+    getOrderOrigination: () => number;
+    private _orderSentenceId;
+    getOrderSentenceId: () => number;
+    private _nomenclatureId;
+    getNomenclatureId: () => number;
+    private _signTimeInteraction;
+    getSignTimeInteraction: () => number;
+    /**
+     * Creates a new MPageOrder with the order action 'ACTIVATE', which is the prototype for activating an existing future order.
+     *
+     * @since 0.1.0
+     * @category MPage Events - Orders
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willActivate(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'CANCEL DC', which is the prototype for canceling and discontinuing an existing future order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willCancelDiscontinue(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'CANCEL REORD', which is the prototype for cancelling and reordering an existing future order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willCancelReorder(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'CLEAR', which is the prototype for clearing actions of an existing future order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willClear(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'CONVERT_INPAT', which is the prototype for converting a prescription order into an inpatient order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willConvertInpatient(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'CONVERT_RX', which is the prototype for converting an inpatient order into a prescription.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willConvertToPrescriptionOrder(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'MODIFY', which is the prototype for modifying an existing future order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willModify(orderId: number): this;
+    /**
+     * Creates a new MPage Order with order action 'ORDER'.
+     *
+     * @since 0.1.0
+     * @category MPage Events - Orders
+     * @param {number} synonymId The Cerner synonym_id to be associated with the new order. Must be set.
+     * @param {NewOrderOpts} options required when making a new order
+     * @returns {this} Returns itself to continue chaining method calls.
+     * default to a normal order type.
+     * @throws Error if `isRxOrder` and `isSatelliteOrder` are both set to true. These two are mutually exclusive and setting
+     * both creates underfined behavior with respect the order origination field.
+     * @example
+     * m.willMakeNewOrder(34, true, 13, 42, true).toString() => "{'ORDER'|34|5|1342|1}"
+     */
+    willMakeNewOrder(synonymId: number, opts?: NewOrderOpts): this;
+    /**
+     * Creates a new MPageOrder with the order action 'RENEW', which is the prototype for reviewing an existing non-prescription order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willRenewNonPrescription(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'RENEW_RX', which is the prototype for renewing an existing prescription order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willRenewPrescription(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'REPEAT', which is the prototype for copying an order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willCopyExistingOrder(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'RESUME', which is the prototype for resuming a suspended order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willResumeSuspendedOrder(orderId: number): this;
+    /**
+     * Creates a new MPageOrder with the order action 'SUSPEND', which is the prototype for suspending an existing order.
+     *
+     * @since 0.1.0
+     * @param {number} orderId The order id value for the order to activate.
+     * @returns {this} Returns itself to continue chaining method calls.
+     */
+    willSuspend(orderId: number): this;
+    /**
+     * Overrides the toString() method for representing the objects internal state as a string.
+     *
+     * @since 0.1.0
+     * @returns {string} string representation of MPageOrder's internal state
+     */
+    toString(): string;
+}

package/dist/MPageOrderEvent.d.ts

@@ -0,0 +1,35 @@
+import { MPageOrder } from '.';
+declare class MPageOrderEvent {
+    private _orders;
+    getOrders: () => MPageOrder[];
+    private _tabList;
+    getTabList: () => {
+        tab: number;
+        tabDisplayFlag: number;
+    };
+    private _personId;
+    getPersonId: () => number;
+    private _encounterId;
+    getEncounterId: () => number;
+    private _powerPlanFlag;
+    getPowerPlanFlag: () => number;
+    private _defaultDisplay;
+    getDefaultDisplay: () => number;
+    private _silentSignFlag;
+    getSilentSignFlag: () => number;
+    constructor();
+    forPerson(id: number): this;
+    forEncounter(id: number): this;
+    addOrders(orders: Array<MPageOrder> | MPageOrder): this;
+    enablePowerPlans(): this;
+    customizeOrderListProfile(): this;
+    customizeMedicationListProfile(): this;
+    enablePowerOrders(): this;
+    launchOrderSearch(): this;
+    launchOrderProfile(): this;
+    launchOrdersForSignature(): this;
+    signSilently(): this;
+    send(): void;
+    toString(): string;
+}
+export { MPageOrderEvent };