Difference between revisions of "SSMT: Additional Information"

From Galen Healthcare Solutions - Allscripts TouchWorks EHR Wiki
Jump to navigation Jump to search
(Created page with "==Description== This page will explain how to load Reference Ranges for manually entered results in v11. This category can be used to load reference ranges for resultable items ...")
 
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
[[Category:SSMT|Additional Info]]
 
==Description==
 
==Description==
−
This page will explain how to load Reference Ranges for manually entered results in v11.  This category can be used to load reference ranges for resultable items that are either test or numeric answer types.  Different levels of reference range context can be specified depending on the answer type of the resultable item.
+
This page will explain how to manage the [[Additional Information|Additional Information dictionary]] in Enterprise EHR using SSMT.  Keep in mind the Additional Information dictionary SSMT category is a shared repository for questions as it relates to both Order AND Charge.  This content category deals only with the records stored in the additional information dictionary and does not manage the relationship between AOE questions and orderable items.
−
 
 
  
 
Stored Procedures used:
 
Stored Procedures used:
−
*Extracting data:  
+
*Extracting data: ImpGetAdditionalInformationDEEntries
−
*Loading data:  
+
*Loading data: ImpSetAdditionalInformationDE
  
 
==Column Listing and Descriptions==
 
==Column Listing and Descriptions==
  
−
*'''Resultable Entry Code''' - this is the unique Entry Code value of the resultable item for which the reference range is being created or updated.  This should directly reference the Entry Code value from the RID.
+
*'''EntryCode''' - this is the unique entry code value for the additional information question.  It must be unique and is self defined when adding a new entry to the dictionary.  Unique consideration may be given here if these questions will be interfaced to other ancillary systems.  Cannot be modified using SSMT.
 +
 
 +
*'''EntryName''' - this is the entry name value for the additional information question.  It is self defined when adding a new entry to the dictionary.  This is not necessarily what the user will see on the order detail screen and it does not have to be the same value as the Prompt field.
 +
 
 +
*'''EntryMnemonic''' - this is the unique entry mnemonic value for the additional information question.  It must be unique and is self defined when adding a new entry to the dictionary.
  
−
*'''Resultable Entry Name''' - this is the Entry Name value of the resultable item for which the reference range is being created or updated.  This should directly reference the Entry Name value from the RID.
+
*'''IsInactiveFLAG''' - accepted values for this field:
 +
** Y - entry is currently inactive; set to this value if inactivating an active entry.
 +
** N - entry is not currently inactive; set to this value if updating or creating a new entry.
  
−
*'''Where Performed''' - this is the Entry Name value of the Where Performed location for which the reference range is being created or updated.  This should directly reference the Entry Name value from the Where Performed dictionary.  It is possible for the same resultable item to have multiple reference range entries depending on the Where Performed value set when resulting the item.
+
*'''IsEnforcedFLAG''' - accepted values for this field:
 +
** Y - entry is enforced and delivered with the system.
 +
** N - entry is not enforced and can be edited or updated as needed.
  
−
*'''ReferenceRangeType''' - this value will determine what type of reference range will be set and will effect what fields can be utilized in this content category.
+
*'''MinApplicableAge''' - this should be a numeric value.  It sets the minimum age for which for the additional information question may be prompted.  Read from demographics.
  
−
    * Default - set to this value to set reference range defaults for resultable items that have an answer type of Text.
+
*'''MaxApplicableAge''' - this should be a numeric value greater than the MinApplicableAge.  It sets the maximum age for which the additional information question may be prompted. Read from demographics.
−
    * Numeric - set to this value to set reference range defaults for resultable items that have an answer type of Numeric.
 
  
−
*'''SEX''' - this is the Entry Name value of the patient sex for which the reference range is being created or updated.  This should directly reference the Entry Name value from the Sex dictionary.  It is possible for the same resultable item to have multiple reference range entries depending on the patient sex when resulting the item.
+
*'''NumberofLines''' - this will apply to a Text data type AOE question.  It should be a numeric value and will determine the physical space (in lines/carriage returns) of the text box that will show on the order detail screen for text answer entry.
  
−
*'''Lowestvalue''' - for numeric reference ranges - this is the lowest possible measurable  value for the resultable item.  A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''Prompt''' - this is the actual <nowiki>"label"</nowiki> or display name field that is seen in the order detail screen as a description or prompt to the AOE question being answered.  It is typically a meaningful value intended for provider/staff viewing in the application.
  
−
*'''PanicLowValue''' - for numeric reference ranges - this is the value for which a Panic Low abnormal Flag will be generated if met or exceeded. A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''ItemType''' - acceptable values for this field are:
 +
** Order - indicates the question exists in the Additional Information dictionary (Order module) and be available for use in combination with orderable items.
 +
** Charge - indicates the question exists in the Additional Information workspace (Charge module) and be available for use in combination with encounters and/or other charge codes/conditions.
  
−
*'''LowNormal''' - for numeric reference ranges - this is the value for which an Abnormal Low Flag will be generated if met or exceeded. A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''AlwaysDisplayFLAG''' - acceptable values for this field are:
 +
** Y - if set will force the order detail screen to display upon order entry for any orderable item with given additional information question assigned.
 +
** N - if set will not force the order detail screen to display upon order entry.
  
−
*'''HighNormal''' - - for numeric reference ranges - this is the value for which an Abnormal High Flag will be generated if met or exceeded. A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''Conditions''' - specific to the Charge AOE question type.  This field will show any conditions or logic defined in the AOE question which will be part of the trigger to make the question available for use in the application at a given time.
  
−
*'''PanicHighValue''' - for numeric reference ranges - this is the value for which a Panic High abnormal Flag will be generated if met or exceeded.  A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''DefaultFromQo''' -  
  
−
*'''HighestMeasureable''' - for numeric reference ranges - this is the highest possible measurable value for the resultable item. A value other than 0 must be specified here in order for numeric reference ranges to generate a Flag value.
+
*'''MandatoryLevel''' - acceptable values for this field include:
 +
** Missing answer results in 'Needs Info' status - if set and and the AOE is not answered during the order entry process the order will move to a status of 'Needs Info' to potentially be caught and/or worked.
 +
** Missing answer results in 'On Hold' status - if set and the AOE is not answered during the order entry process the order will move to a status of 'On Hold' to potentially be caught and/or worked.
 +
** Not required - if set will allow the user to save the order without addressing the AOE at all.
 +
** Required before saving - if set will not allow the user to 'Save and close' or 'Save and return' to the ACI; must be answered to continue.
  
−
*'''ReferenceText''' - this is the reference range that will actually display to the right of the resultable item when it is being resulted.  This is more of a display field only and calculations for numeric reference ranges are not performed based on this field.  It is more for display and compliance purposes.
+
*'''AnswerDataType''' - sets the data type for the question.  Acceptable values for this field are:
 +
** DateTime - if set will enable datetime specific properties in the AOE dictionary and calendar object for use in application.
 +
** Numeric - if set will enable numeric specific properties in the AOE dictionary.
 +
** Picklist - if set will enable answer picklist properties in the AOE dictionary.  Prerequisite build in the Answer dictionary may need to take place before a picklist can be assigned for use with an AOE question.
 +
** Text - if set will enable text specific properties in the AOE dictionary.
  
−
*'''Answer''' -  
+
*'''AnswerPersistence''' - the actual answer for a given AOE question can be defaulted based on a number of available conditions and/or criteria.  Acceptable values for this field are:
 +
** Default Value from Additional Information Dictionary - sets the DefaultValue field (if defined) to be initially set as the default value for the AOE answer.
 +
** From previous answer for encounter - defaults the answer to last answer supplied for the current encounter in context.
 +
** From previous answer for patient - defaults the answer to whatever was answered last for the question for the given patient.
 +
** From previous answer for performing location - defaults the answer to whatever was answered last for the Performing Location specific answer.  A patient may generate multiple default answers if they frequent multiple diagnostic performing locations.
 +
** From previous answer for provider - defaults the answer to whatever was answered last for the question for the Provider currently ordering the test.  A patient may generate multiple default answers if they see multiple providers in a given network.
 +
** From previous answer for the provider for the current orderable item - defaults the answer to whatever was answered last for the provider AND the orderable item.  A patient may generate multiple default answers if a given provider is ordering multiple tests that use this type of persistence setting.
 +
** Never - a default answer will not be pulled in.
  
−
*'''AbnormalFlag''' -  
+
*'''GenderToExcludeSEX''' - acceptable values for this field are:
 +
** Male - if set will suppress the AOE question for patients who are males; read from demographics.
 +
** Female - if set will suppress the AOE question for patients who are female; read from demographics.
 +
** Unknown - if set will suppress the AOE question for patients with a demographic sex of Unknown.
  
−
    * Y -  
+
*'''AnswerPicklist''' - if a picklist data type will be used for the AOE question then the opportunity will be given to assign the picklist that will be used for AOE answer.  These are answer picklists defined in the Answer Dictionary.
−
    * N -  
+
 +
*'''DefaultValue''' - can be defined and will be pulled when Default Value from Additional Information Dictionary is set as the persistence type for the AOE question.
  
−
*'''IsInActive''' - this flag helps determine whether or not the reference range will be updated/added or removed. Possible values:
+
*'''Create''' - acceptable values for this field are:
 +
** Y - if set will attempt to create the entry as a new AOE question.
 +
** N - if set will will attempt to update an already existing AOE question is a match is found.
  
−
    * Y - set to this value in order to remove the reference range value(s).
+
== Migration Considerations ==
−
    * N - set to this value if already existing reference entries are being updated or added.
 
  
−
*'''Create''' - this flag helps determine whether or not the reference range will be updated or added.  Possible values:
+
* '''Delivered/Enforced Entries''' - always review or take the time to briefly reconciling these prior to migrating AOE questions from environment to environment.  It is quite possible that atomic changes to the entry code field (for example) could easily lead to duplicate or unintended records.
 +
* '''FLAG Cross Check''' - always cross check any flags that will effect how the record is interpreted by the new environment!!
 +
**'''IsInactiveFLAG''' - double check that inactive records are not attempting to be created.  For example, it would not make sense to load records where the IsInactiveFLAG and Create flags are both 'Y'.
 +
**'''Create''' - take the time to make sure that records intended to be net new records are 'Y' and any other potential record updates set to 'N'.
  
−
    * Y - set to this value in order to add a new reference range value(s).
 
−
    * N - set to this value in order to update an already reference range.
 
  
 
'''back to [[SSMT]] main page'''
 
'''back to [[SSMT]] main page'''

Latest revision as of 15:31, 8 April 2013

Description

This page will explain how to manage the Additional Information dictionary in Enterprise EHR using SSMT. Keep in mind the Additional Information dictionary SSMT category is a shared repository for questions as it relates to both Order AND Charge. This content category deals only with the records stored in the additional information dictionary and does not manage the relationship between AOE questions and orderable items.

Stored Procedures used:

  • Extracting data: ImpGetAdditionalInformationDEEntries
  • Loading data: ImpSetAdditionalInformationDE

Column Listing and Descriptions

  • EntryCode - this is the unique entry code value for the additional information question. It must be unique and is self defined when adding a new entry to the dictionary. Unique consideration may be given here if these questions will be interfaced to other ancillary systems. Cannot be modified using SSMT.
  • EntryName - this is the entry name value for the additional information question. It is self defined when adding a new entry to the dictionary. This is not necessarily what the user will see on the order detail screen and it does not have to be the same value as the Prompt field.
  • EntryMnemonic - this is the unique entry mnemonic value for the additional information question. It must be unique and is self defined when adding a new entry to the dictionary.
  • IsInactiveFLAG - accepted values for this field:
    • Y - entry is currently inactive; set to this value if inactivating an active entry.
    • N - entry is not currently inactive; set to this value if updating or creating a new entry.
  • IsEnforcedFLAG - accepted values for this field:
    • Y - entry is enforced and delivered with the system.
    • N - entry is not enforced and can be edited or updated as needed.
  • MinApplicableAge - this should be a numeric value. It sets the minimum age for which for the additional information question may be prompted. Read from demographics.
  • MaxApplicableAge - this should be a numeric value greater than the MinApplicableAge. It sets the maximum age for which the additional information question may be prompted. Read from demographics.
  • NumberofLines - this will apply to a Text data type AOE question. It should be a numeric value and will determine the physical space (in lines/carriage returns) of the text box that will show on the order detail screen for text answer entry.
  • Prompt - this is the actual "label" or display name field that is seen in the order detail screen as a description or prompt to the AOE question being answered. It is typically a meaningful value intended for provider/staff viewing in the application.
  • ItemType - acceptable values for this field are:
    • Order - indicates the question exists in the Additional Information dictionary (Order module) and be available for use in combination with orderable items.
    • Charge - indicates the question exists in the Additional Information workspace (Charge module) and be available for use in combination with encounters and/or other charge codes/conditions.
  • AlwaysDisplayFLAG - acceptable values for this field are:
    • Y - if set will force the order detail screen to display upon order entry for any orderable item with given additional information question assigned.
    • N - if set will not force the order detail screen to display upon order entry.
  • Conditions - specific to the Charge AOE question type. This field will show any conditions or logic defined in the AOE question which will be part of the trigger to make the question available for use in the application at a given time.
  • DefaultFromQo -
  • MandatoryLevel - acceptable values for this field include:
    • Missing answer results in 'Needs Info' status - if set and and the AOE is not answered during the order entry process the order will move to a status of 'Needs Info' to potentially be caught and/or worked.
    • Missing answer results in 'On Hold' status - if set and the AOE is not answered during the order entry process the order will move to a status of 'On Hold' to potentially be caught and/or worked.
    • Not required - if set will allow the user to save the order without addressing the AOE at all.
    • Required before saving - if set will not allow the user to 'Save and close' or 'Save and return' to the ACI; must be answered to continue.
  • AnswerDataType - sets the data type for the question. Acceptable values for this field are:
    • DateTime - if set will enable datetime specific properties in the AOE dictionary and calendar object for use in application.
    • Numeric - if set will enable numeric specific properties in the AOE dictionary.
    • Picklist - if set will enable answer picklist properties in the AOE dictionary. Prerequisite build in the Answer dictionary may need to take place before a picklist can be assigned for use with an AOE question.
    • Text - if set will enable text specific properties in the AOE dictionary.
  • AnswerPersistence - the actual answer for a given AOE question can be defaulted based on a number of available conditions and/or criteria. Acceptable values for this field are:
    • Default Value from Additional Information Dictionary - sets the DefaultValue field (if defined) to be initially set as the default value for the AOE answer.
    • From previous answer for encounter - defaults the answer to last answer supplied for the current encounter in context.
    • From previous answer for patient - defaults the answer to whatever was answered last for the question for the given patient.
    • From previous answer for performing location - defaults the answer to whatever was answered last for the Performing Location specific answer. A patient may generate multiple default answers if they frequent multiple diagnostic performing locations.
    • From previous answer for provider - defaults the answer to whatever was answered last for the question for the Provider currently ordering the test. A patient may generate multiple default answers if they see multiple providers in a given network.
    • From previous answer for the provider for the current orderable item - defaults the answer to whatever was answered last for the provider AND the orderable item. A patient may generate multiple default answers if a given provider is ordering multiple tests that use this type of persistence setting.
    • Never - a default answer will not be pulled in.
  • GenderToExcludeSEX - acceptable values for this field are:
    • Male - if set will suppress the AOE question for patients who are males; read from demographics.
    • Female - if set will suppress the AOE question for patients who are female; read from demographics.
    • Unknown - if set will suppress the AOE question for patients with a demographic sex of Unknown.
  • AnswerPicklist - if a picklist data type will be used for the AOE question then the opportunity will be given to assign the picklist that will be used for AOE answer. These are answer picklists defined in the Answer Dictionary.
  • DefaultValue - can be defined and will be pulled when Default Value from Additional Information Dictionary is set as the persistence type for the AOE question.
  • Create - acceptable values for this field are:
    • Y - if set will attempt to create the entry as a new AOE question.
    • N - if set will will attempt to update an already existing AOE question is a match is found.

Migration Considerations

  • Delivered/Enforced Entries - always review or take the time to briefly reconciling these prior to migrating AOE questions from environment to environment. It is quite possible that atomic changes to the entry code field (for example) could easily lead to duplicate or unintended records.
  • FLAG Cross Check - always cross check any flags that will effect how the record is interpreted by the new environment!!
    • IsInactiveFLAG - double check that inactive records are not attempting to be created. For example, it would not make sense to load records where the IsInactiveFLAG and Create flags are both 'Y'.
    • Create - take the time to make sure that records intended to be net new records are 'Y' and any other potential record updates set to 'N'.


back to SSMT main page

Retrieved from "https://wiki.galenhealthcare.com/index.php?title=SSMT:_Additional_Information&oldid=16139"