Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: RAMAG

RAMAG.m

Go to the documentation of this file. 
  1. RAMAG ;HCIOFO/SG - ORDERS/EXAMS API (README) ; 2/27/08 1:31pm
  1.  ;;5.0;Radiology/Nuclear Medicine;**90**;Mar 16, 1998;Build 20
  1.  ;
  1.  ; RAMISC -------------- MISCELLANEOUS PARAMETERS
  1.  ;
  1.  ; RAMISC(
  1.  ;   Name1)              Value(s)
  1.  ;   Name2,Seq#)         Value(s)
  1.  ;   Name3,Seq#,Name4)   Value(s)
  1.  ;
  1.  ; See the MSCPRMS^RAMAGU01 for the complete list of parameter
  1.  ; definitions.
  1.  ;
  1.  ; If a parameter is required and there is no default value, a non-
  1.  ; empty value must be assigned to the corresponding array node
  1.  ; before the call.
  1.  ;
  1.  ; If a parameter is required but there is a default value, then the
  1.  ; latter will be assigned internally to the corresponding array node 
  1.  ; if it is not defined or empty. If the default value is empty, then 
  1.  ; an error will be returned.
  1.  ;
  1.  ; If a parameter is not required, then its default value (if
  1.  ; indicated), will be internally assigned to the corresponding array 
  1.  ; node only if it has no value ($DATA(...)#10=0). If an empty string 
  1.  ; is assigned to such node, the corresponding field will not have the
  1.  ; default value; it will be empty!
  1.  ;
  1.  ; If you want to clear a multiple that already has a value, assign
  1.  ; "@" or empty string to the parameter itself and do not set any
  1.  ; subscripts. For example, the following construction will clear
  1.  ; the CONTRAST MEDIA multiple: S RAMISC("CONTMEDIA")="@".
  1.  ;
  1.  ; NOTE: The RAMISC parameter can be modified by the functions:
  1.  ;       default values are assigned to some parameters.
  1.  ;
  1.  ; Control Flags - RAMISC("FLAGS")
  1.  ; -------------------------------
  1.  ;
  1.  ; A  If this flag is provided, then the registration entry point
  1.  ;    adds the new case to the existing ones with the same date/time
  1.  ;    instead of returning the error code -28.
  1.  ;
  1.  ;    If the existing date/time record stores an exam set and the
  1.  ;    "D" flag is not provided, then the error code -54 is returned.
  1.  ;
  1.  ; D  If there is an existing case with the same date/time, then the
  1.  ;    time of the new case is incremented by 1 minute until an unused 
  1.  ;    date/time is found.
  1.  ;
  1.  ;    If the "A" flag is also provided, then time increments also
  1.  ;    stop when a non-examset date/time record is found.
  1.  ;
  1.  ;    If the date is also changed during the time modification, then
  1.  ;    the case is not registered and the error code -29 is returned.
  1.  ;
  1.  ; F  Try to enforce the new status even if some required fields are
  1.  ;    not populated.
  1.  ;
  1.  ;    NOTE: If such case is later edited by a regular Radiology
  1.  ;          option, the status may be reverted.
  1.  ;
  1.  ; S  Do not send HL7 message to speech recognition (dictation)
  1.  ;    systems.
  1.  ;
  1.  ; RAMSPSDEFS ---------- DATA FOR MISCELLANEOUS PARAMETERS VALIDATION
  1.  ;
  1.  ; RAMSPSDEFS(
  1.  ;
  1.  ;   "F",
  1.  ;     File#,Name)       ""
  1.  ;
  1.  ;   "N",
  1.  ;     Name)             Parameter descriptor
  1.  ;                         ^01: (Sub)file number
  1.  ;                         ^02: Field number
  1.  ;                         ^03: Field type that requires special
  1.  ;                              processing:
  1.  ;                                D - Date/time, M - Multiple,
  1.  ;                                P - Pointer,   W - Word processing,
  1.  ;                                * - Add this parameter to the "F"
  1.  ;                                    index (see the VEXAMND^RAMAGU14 
  1.  ;                                    for details).
  1.  ;                         ^04: Number of the "^"-piece of the value
  1.  ;                              returned by the $$EXMSTREQ^RAMAGU06.
  1.  ;                              It determines if a non-empty field
  1.  ;                              value is required.
  1.  ;
  1.  ;   "R")                Exam status requirements (value returned by
  1.  ;                       the $$EXMSTREQ^RAMAGU06 function).
  1.  ;
  1.  ; NAMESPACE ----------- DESCRIPTION
  1.  ;
  1.  ; RAMAGHL*              HL7 utilities
  1.  ; RAMAGRP*              Remote procedures
  1.  ; RAMAGU*               Utilities
  1.  ;
  1.  ; API ENTRY POINT ----- DESCRIPTION
  1.  ;
  1.  ;    $$ORDER^RAMAG02    Orders/requests an exam
  1.  ; $$REGISTER^RAMAG03    Registers the exam
  1.  ;  $$ORDCANC^RAMAG04    Cancels the order
  1.  ; $$EXAMCANC^RAMAG05    Cancels the exam
  1.  ; $$COMPLETE^RAMAG06    Completes the exam
  1.  ; $$EXAMINED^RAMAG07    Indicates that procedure has been performed
  1.  ;
  1.  ; UTILITY ------------- DESCRIPTION
  1.  ;
  1.  ; $$LDMSPRMS^RAMAGU01   Loads definitions of miscellaneous parameters
  1.  ;  $$RPCMISC^RAMAGU01   Parses miscellaneous RPC parameters
  1.  ;
  1.  ;  $$ORDSTAT^RAMAGU02   Returns current order status
  1.  ; $$UPDORDST^RAMAGU02   Updates order status
  1.  ;
  1.  ;  $$CHKPROC^RAMAGU03   Checks Radiology procedure and modifiers
  1.  ; $$DESCPLST^RAMAGU03   Translates parent procedure into descendents
  1.  ;
  1.  ;   $$ACCNUM^RAMAGU04   Constructs the site accession number
  1.  ; $$CHKEXMID^RAMAGU04   Checks examination identifiers
  1.  ;  $$DAYCASE^RAMAGU04   Constructs the day-case exam identifier
  1.  ; $$EXAMIENS^RAMAGU04   Converts exam identifiers into the exam IENS
  1.  ; $$EXAMNODE^RAMAGU04   Returns the exam global node
  1.  ;   $$INVDTE^RAMAGU04   Calculates 'inverted' date/time
  1.  ;  $$RAPTREG^RAMAGU04   Registers the patient in the file #70
  1.  ; $$UPDEXMPR^RAMAGU04   Updates exam procedure and modifiers
  1.  ;
  1.  ;  $$EXMSTAT^RAMAGU05   Returns current exam status
  1.  ; $$UPDEXMAL^RAMAGU05   Updates exam activity log
  1.  ; $$UPDEXMST^RAMAGU05   Updates exam status
  1.  ;
  1.  ; $$EXMSTINF^RAMAGU06   Returns descriptor of the exam status
  1.  ; $$EXMSTREQ^RAMAGU06   Returns exam status requirements
  1.  ; $$GETEXMND^RAMAGU06   Searches for "EXAMINED" status
  1.  ; $$NXTEXMST^RAMAGU06   Returns the following exam status
  1.  ;
  1.  ;    $$RAINP^RAMAGU07   Returns service, ward, and bedsection
  1.  ;    $$VADEM^RAMAGU07   Wrapper for the DEM^VADPT
  1.  ;    $$VAIN5^RAMAGU07   Wrapper for the IN5^VADPT
  1.  ;
  1.  ;    $$VAL70^RAMAGU08   Validates RAMISC params related to file #70
  1.  ;    $$VAL74^RAMAGU10   Validates RAMISC params related to file #74
  1.  ;
  1.  ;       VARS^RAMAGU11   Writes variables and their values
  1.  ;          W^RAMAGU11   Writes a long string
  1.  ;
  1.  ;  $$RPTSTUB^RAMAGU12   Creates a report stub record
  1.  ;  $$RPTSTAT^RAMAGU12   Returns report status
  1.  ; $$UPDRPTAL^RAMAGU12   Updates report activity log
  1.  ; $$UPDRPTST^RAMAGU12   Updates report status
  1.  ;
  1.  ; $$NMEDSTUB^RAMAGU13   Creates a nuclear medicine stub record
  1.  ; $$RARSNIEN^RAMAGU13   Searches for reason synonym
  1.  ;  $$UPDMULT^RAMAGU13   Updates values of the multiple(s)
  1.  ;
  1.  ; REMOTE PROCEDURE ---- DESCRIPTION
  1.  ;
  1.  ; RAMAG EXAM CANCEL     Cancels the exam
  1.  ; RAMAG EXAM COMPLETE   Completes the exam
  1.  ; RAMAG EXAM ORDER      Orders/requests an exam
  1.  ; RAMAG EXAM REGISTER   Registers the exam
  1.  ; RAMAG EXAMINED        Procedure has been performed
  1.  ; RAMAG ORDER CANCEL    Cancels the order
  1.  ;
  1.  Q