Item

Namespace: Informedica.GenOrder.Lib
Parent Module: Orderable

Type and functions that models an Order Item that is contained in a Component

Nested types and modules

Type	Description
Item	Models an `Item` in a `Component`

Functions and values

Function or value	Description
`apply f itm` Signature: f:(Item -> '?7086) -> itm:Item -> '?7086 Type parameters: '?7086	Aply f to an `item`
`create (...)` Signature: id:Id -> nm:Name -> cmp_qty:Quantity -> orb_qty:Quantity -> cmp_cnc:Concentration -> orb_cnc:Concentration -> dos:Dose -> dos_adj:DoseAdjust -> Item	Create an item with id: the order id nm: the name of the item cmp_qty: the quantity of the item in a component orb_qty: the quantity of the item in an orderable cmp_cnc: the item concentration in a component orb_cnc: the item concentration in an orderable dos: the item dose dos_adj: the adjusted item dose
`createNew id (nm, u1) u2 adj` Signature: id:Id -> (nm:Name * u1:String) -> u2:string -> adj:string -> Item	Create a new item with id: the order id s: the string name of the item u1: the unit of the item u2: the unit of the component that contains the item adj: the unit to adjust the item dose
`fromEqs eqs itm` Signature: eqs:Variable list list -> itm:Item -> Item	create an item from `eqs`, a list of variable lists
`get` Signature: Item -> Item	Utility method to facilitaite type inference
`getDose itm` Signature: itm:Item -> Dose	Get the `Item` dose
`getDoseAdjust itm` Signature: itm:Item -> DoseAdjust
`getId itm` Signature: itm:Item -> string	Get the unique id of an `Item`
`getName itm` Signature: itm:Item -> Name	Get the `Name` of an `Item`
`getOrderId itm` Signature: itm:Item -> Id	Get the order id of an `Item`
`toEqs (...)` Signature: adj:VariableUnit -> frq:VariableUnit option -> qty:VariableUnit -> tot:VariableUnit -> tme:VariableUnit option -> rte:VariableUnit option -> cmp_cmp_qty:VariableUnit -> cmp_orb_qty:VariableUnit -> orb_orb_qty:VariableUnit -> itm:Item -> VariableUnit list list	The following variables are used itm_cmp_qty: the quantity of item in a component itm_orb_qty: the quantity of item in an orderable itm_cmp_cnc: the concentration of an item in a component itm_orb_cnc: the concentration of an item in an orderable cmp_cmp_qty: the component quantity orb_orb_qty: the orderable quantity cmp_orb_qty: the quantity of component in an orderable itm_dos_qty: the item dose quantity itm_dos_tot: the item dose total itm_dos_rte: the item dose rate itm_dos_qty_adj: the adjusted item dose quantity itm_dos_tot_adj: the adjusted item dose total itm_dos_rte_adj: the adjusted item dose rate frq: the prescription frequency tme: the prescription time qty: the orderable dose quantity tot: the orderable dose total rte: the orderable dose rate With these variables the following equations are generated depending on prescription type Process itm_cmp_qty = itm_cmp_cnc * cmp_cmp_qty itm_orb_qty = itm_orb_cnc * orb_orb_qty itm_orb_qty = itm_cmp_cnc * cmp_orb_qty Discontinuous Timed itm_dos_tot = itm_dos_qty * frq itm_dos_qty = itm_dos_rte * tme itm_dos_qty = itm_orb_cnc * qty itm_dos_tot = itm_orb_cnc * tot itm_dos_rte = itm_orb_cnc * rte itm_dos_qty = itm_dos_qty_adj * adj itm_dos_tot = itm_dos_tot_adj * adj itm_dos_rte = itm_dos_rte_adj * adj Discontinuous itm_dos_tot = itm_dos_qty * frq itm_dos_qty = itm_orb_cnc * qty itm_dos_tot = itm_orb_cnc * tot itm_dos_qty = itm_dos_qty_adj * adj itm_dos_tot = itm_dos_tot_adj * adj Continuous itm_dos_rte = itm_orb_cnc * rte itm_dos_rte = itm_dos_rte_adj * adj
`toString itm` Signature: itm:Item -> string list	Turn an `Item` to a list of `string`s, each string containing the variable `Name`, `ValueRange` and `UnitGroup`
`toVarUnt itm` Signature: itm:Item -> VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit * VariableUnit	Turn an `Item` to `VariableUnit`s

Fork me on GitHub