Format/Setting |
Description |
None (Plain Text) |
Allows any value with very few formatting rules. |
Edit Box Width |
When field is editable, how many characters wide should the edit box be? This does not effect the maximum length of the value, only how much is visible at a time during editing. |
Max. Length |
This is the maximum number of characters long that the text can be. This may be adjusted up to 4000 characters. The default, if left blank, is 512. |
Params |
This is an obsolete feature that is only available to BlueStep client care staff. It was a early attempt at relationship fields. It is documented here to support older configurations where it is still in use. A params field stores the key/id of form entry. It may reference either a multi-entry form in the same record (intra-record) or a single-entry form in another record (cross-record). The params setting consists of a series of key/value pairs formatted just like the query string of a URL. There are four possible parameters:
- display -- The value of this parameter is the key or fixed id of the field which will be displayed for each entry in the list. If the field is from a single-entry form then this is a cross-record params field and either a query or report must be specified. If the field is from a multi-entry form then this is a intra-record params field and a multi-entry report may optionally be specified. The display parameter must be specified for a successful params field.
- query -- The value of this parameter is key or fixed id of a query.
- report -- The value of this parameter is key or fixed id of a report or multi-entry report.
- copy -- This parameter is optional and more than one copy parameter is allowed. The value of each copy parameter is two ids separated by a -> symbol (dash + greater-than). Each id may be a field id/key or the fixed id of a field. The id before the -> is where data will be copied from. The id after the -> is where data will be copied to. The "from" field must be on the same form as the display field. The "to" field must be on this form. The copy occurs when a option is selected by the end user. For the copy to be successful the destination field must be editable and present on the current layout. However, it may be hidden via CSS. The copy is not very smart and will not be able to copy all field types.
|
Multi-line Memo |
Turns a text field into a memo field. The main difference between a text field formatted as a memo and a full memo field is the way it is stored in the database. A text-memo may store up to 4000 characters and may be used for searching and sorting. A regular memo field my store up to 4 billion characters and cannot be used for searching or sorting. Also, there is more computing overhead with a regular memo than a text memo. For this reason, most "note" type fields should use a text-memo, not a regular memo field.
The second difference is that text-memos attempt to auto-detect between plain text and HTML text. Namely, if the value stored in a text-memo field contains a line break (a newline character) and does not contain a closing HTML tag (a '</' character sequence) then it will be formatted using a plain-text to HTML formatter. Otherwise, the content of the text field will be dumped directly into the HTML document without any formatting or conversion.
|
Edit Box Width |
When field is editable, how many characters wide should the edit box be? This does not effect the maximum length of the value, only how much is visible at a time during editing. |
Edit Box Height |
When field is editable, how many characters high should the edit box be? This does not effect the maximum length of the value, only how much is visible at a time during editing.
|
Max. Length |
This is the maximum number of characters long that the text can be. This may be adjusted up to 4000 characters. The default, if left blank, is 512.
|
Phone Number |
Allows a phone number in standard North American form with an optional extension. The result looks like this: (888) 888-8888x888. The intelligent format validation will automatically re-format phone numbers typed in other formats. |
Email Address |
Allows an email address. |
Measurement |
Allows a measurement in feet and inches. The result looks like: 5ft 10in. The intelligent format validation accepts and converts feet and inches specified with single and double quote unit labels as well. It does not do unit conversion from other units of measure such as centimeters. |
Web URL |
Stores a URL. The URL may include a domain and protocol or be a local URL. |
Media Picker |
This is an obsolete feature which is only available to BlueStep engineering staff. This was an early attempt at a document field. It is documented here to support older configurations where it is still in used. The media picker option allows a URL to be selected instead of typed. The selections presented are the documents from media library of the HQ in the same unit as the current record. There are three options: "No Media Picker" turns off the feature; "Show Media Picker, use ActiveX" attempts to open Microsoft Office documents using an ActiveX control and WebDAV for automatic locking and document storage directly back to the media library (very cool when it worked); and finally "Show Media Picker, no ActiveX" which downloads documents using normal browser features. |
State |
Allows a U.S. state or Canadian province abbreviation. |
Tax Id Number |
Allows either a social security number (SSN) or a federal employer identification number (EIN). |
Type |
Selects whether the field accepts SSN or EIN or both. |
Zip Code |
Allows a US zip code or zip+4 code. |
List Selection |
Changes a text field into a single select field that stores the label of an option from an option list. If there are more than 70 options in the list, the field becomes a lookup field with an auto-completion style interface. |
List |
The option list to select from. |
Allow manual |
If checked, then a lookup style interface is always used. Plus, instead of selecting an option from the list, the user may choose to type anything they want. |
Medication Lookup |
The text field does a lookup or auto-complete style interface for medications on the U.S. market. |
Edit Box Width |
Exactly like in plain text format, this determines the width of the edit window. |
Allow Manual |
If checked the user may choose to type anything they want instead of selecting a medication from the list. |
Advanced Options |
Advanced options allow the behavior of the lookup field to be altered. The options are given in a syntax that is a limited version of JavaScript. Each option has a name, the equal sign then value. The value must not contain a semi-colon. Options are separated by semicolons. Options work against extended data that is provided with each value looked up. In addition to the data the user sees there is additional, extended data that is available using the advanced options. The extended data values available for this and other lookup formats are described in the RelateScript documentation under the doLookup(...) function. The following advanced options are supported:
- lookupFormat -- This parameter is a String or function. It allows one or more the extended data value to be combined and assigned into the field when an item is selected. If using a String value, markers for each data value are included in the String. A marker consists of an opening brace, the name of the data value, and a closing brace. A common lookup format for medications is: "{drug}{genericParen} {strength} {route} {doseForm}". If a function value is used, the function receives an object containing all of the data values and returns the formated value to assign into the field. The function must not contain any semi-colons or else errors will occur due to simplistic parsing of the advanced options. Prior to having the genericParen data value a common function for drug and generic (if any) was: function(d){ return d.drug + (d.generic ? " (" + d.generic + ")" : "") }. It is also possible to create much more complex functions in other parts of the HTML page, such as a merge-report field, then assign the function to the format parameter by name.
- lookupCap -- This parameter is a boolean value. If set to true, the field value will be converted to all capital letters when an item is selected.
- lookupOptionFormat -- This parameter works identically to the lookupFormat parameter, except it determines how the options appear in the drop-down list prior to being selected.
- lookupHoverFormat -- This parameter also works indentically to the lookupFormat parameter, but it determines what information will be included in the hover-text message during selection of options. The lookupDesc parameter is a simplified setting which effects the same behavior.
- lookupDesc -- A string parameter containing the name of data value to display when an option is hovered over with the mouse. The lookupDesc parameter will not be used if the lookupHoverFormat parameter is used.
- lookupAutoFill -- The auto fill parameter is a JavaScript object. It allows secondary fields to be populated when an item is selected. The name of each element of the object is a jQuery query-string to identify which field is to be auto-filled. Generally this will be a class query such as ".medStrength" or similar. The value of each element of the object is a comma delimited list of data value names to use, in order, to attempt to populate the field. This is particularly important when attempting to populate selection fields where getting an exact match may be difficult. The list of data values may also be important if one or more data values could be empty. The system will continue trying to match data values to fields until a workable value is discovered or all possiblities are exhausted.
- lookupAtttrs -- This parameter is an object containing additional parameters to be passed to the lookup function. Most public lookup functions do not use additional parameters, but the CPT code lookup can take a category parameter. The value of lookupAttrs is a JavaScript object with each property name/value pair being one attribute. For instance, for a CPT code category parameter to request only labs would be: lookupAttrs={category:"labs"}
- lookupSuggest -- This parameter is a boolean value. If set to true it does exactly the same thing as the 'allow manual' setting. This setting is useful for non-medication lookups which do not have the 'allow manual' setting.
- lookupFilter -- This parameter needs a function. It is called when a list of lookup values is retrieved and before they are displayed. It receives the BlueStep form element wrapper of the lookup field and the data of an item. It returns true if the item should be shown to the user. Further description of this feature is beyond the scope of this document.
- lookupSelect -- This parameter needs a function. It is called when an item is selected and receives the BlueStep form element wrapper of the lookup field and the data of the item selected. Setting this parameter is particularly dangerous as it circumvents the normal selection logic almost entirely. Further description of this feature is beyond the scope of this document.
|
ICD-9 Diagnosis Lookup |
The text field does a lookup or auto-complete style interface for ICD-9 DX codes approved by Centers for Medicare & Medicaid Services (CMS). |
Edit Box Width |
Exactly like in plain text format, this determines the width of the edit window. |
Advanced Options |
See the description of advanced options under the medication lookup format. |
Medical Billing Revenue Code |
The text field does a lookup or auto-complete style interface for rev. codes used for medical billing.
|
Edit Box Width |
Exactly like in plain text format, this determines the width of the edit window. |
Advanced Options |
See the description of advanced options under the medication lookup format. |
CPT Code |
This may only be selected by BlueStep client care staff. The text field does a lookup or auto-complete style interface for CPT codes. This is a very abbreviated listing which is not appropriate for all situations.
|
Edit Box Width |
Exactly like in plain text format, this determines the width of the edit window. |
Advanced Options |
See the description of advanced options under the medication lookup format. |
Lab Codes |
This may only be selected by BlueStep client care staff. The text field does a lookup or auto-complete style interface for lab tests/panels. This is designed for each lab company to have their own list of labs and lab codes. This type of field generally needs extreme interface configuration and possibly database configuration to function correctly. You've been warned. |
Edit Box Width |
Exactly like in plain text format, this determines the width of the edit window. |
Advanced Options |
See the description of advanced options under the medication lookup format. |
Credit Card |
Allows a credit card number to be entered. This may only be selected by BlueStep client care staff. BlueStep does not do e-commerce solutions. This format type CANNOT be used to facilitate e-commerce software. Data may be entered in the usual fashion, but it cannot be retrieved via formula, nor can it be retrieved by normal users. Only specially configured global users can access the data in this type of field. This extremely limited usage is intentional. Also, this field type cannot be configured, once created, except by a global user with an endorsement matching the lock. |
Lock |
The id of the lock which prevents access to this field. To access the data in the field a global user must have this lock id in thier endorsement options. |