PX SAVE DATA    ICR (6023)

The purpose of this RPC is to allow the calling
application to save data to PCE.

Revision History:
----------------
Added 8/8/24, effective with the ENHANCED PCE ENCOUNTER LOOKUP 1.0
multi-Package, PX*1.0*238, TIU*1.0*362 and OR*3.0*606 the sequence of calls to
add PCE data using PX SAVE DATA, should be:
1) call PX SAVE DATA, then
2) call TIU CREATE NOTE.  This will ensure the PKGNAME and SRC fields
populate the Visit and PCE data and this supports reporting PCE results based
on the PKGNAME or SRC fields. ICR 7315 is preferred as it returns error
information.

Added 8/1/24, effective with PX*1*217, note the explanation of INPUT
PARAMETERS for PKGNAME and SRC and RETURN PARAMETERs expanded return values.



INPUT PARAMETER: PCELIST                PARAMETER TYPE: LIST
MAXIMUM DATA LENGTH: 10000            REQUIRED: YES
SEQUENCE NUMBER: 1
DESCRIPTION:
PCELIST (n)=HDR^Encounter Inpatient?^Note has CPT codes?^Visit
string [Encounter location; Encounter date/time; Encounter
Service category]  (REQUIRED)
(n)=VST^DT^Encounter date/time
(n)=VST^PT^Encounter patient (DFN) (n)=VST^HL^Encounter location
(n)=VST^VC^ Encounter Service Category

If  applicable:

(n)=VST^PR^ Parent for secondary visit
(n)=VST^OL^ Outside Location for Historical visits
(n)=VST^SC^ Service Connected related?
(n)=VST^AO^ Agent Orange related?
(n)=VST^IR^ Ionizing Radiation related?
(n)=VST^EC^ Environmental Contaminates related?
(n)=VST^MST^ Military Sexual Trauma related?
(n)=VST^HNC^ Head and/or Neck Cancer related?
(n)=VST^CV^ Combat Vet related?
(n)=VST^SHD^ Shipboard Hazard and Defense related?
(n)=PRV(+:  add, -: delete) ^ Provider IEN ^^^ Provider Name ^
Primary Provider?
(n)=POV(+:  add, -: delete) ^ ICD diagnosis code ^ Category  ^
Narrative (Diagnosis description) ^ Primary Diagnosis? ^
Provider String ^ Add to Problem List? ^^^ Next comment
sequence # if saving comments
(n)=COM^COM (Comments) ^ Next comment sequence # ^ @ = no
comments added
(n)=CPT (+:  add, -: delete) ^ Procedural  CPT code ^ Category ^
Narrative (Procedure description) ^ Quantity ^ Provider IEN
^^^ [# of modifiers;  Modifier code/Modifier IEN ^ Next
comment sequence # ^

Effective with PX*1*209, the PCELIST input parameter contains
modifications for IMM (Immunization) type data to include
additional fields:  Encounter Provider, Event Info Source,
Dosage, Route, Admin Site, Lot #, Manufacturer, Expiration Date.
The IMM PCELIST items are not required to have the new fields -
to support backward compatibility.

(n)=IMM (+:  add, -: delete) ^ Immunization IEN ^ Category ^
Narrative (Immunization description/name) ^ Series ^
Encounter Provider ^ Reaction ^ Contraindicated? ^^ Next
comment sequence # ^ CVX Code ^ Event Info Source HL7
Code;IEN ^ Dose;Units;Units IEN ^ Route Name;HL7 Code;IEN ^
Admin Site Name;HL7 Code;IEN^ Lot #;IEN ^ Manufacturer ^
Expiration Date ^ Event Date and Time ^ Ordering Provider ^
VIS1 IEN/VIS1 Date;VISn IEN/VISn Date;...^ Remarks Start Seq
#;End Seq # ^ Warning Ack ^ Override Reason (Seq #)

(n)=SK (+:  add, -: delete) ^ Skin Test IEN ^ Category ^
Narrative (Skin Test description/name) ^ Results ^ Enc
Provider ^ Reading ^ D/T Read ^ Event D/T ^ Next comment
sequence # ^ Reader ^ Ordering Provider ^ Anatomic Location
of Placement;HL7 Code;IEN ^ Reading Comment (Seq #)
(n)=PED (+:  add, -: delete) ^ Patient Education IEN ^ Category ^
Narrative (Patient Education description/name) ^ Level of
understanding ^^^^^ Next comment sequence #
(n)=HF (+:  add, -: delete) ^ Health Factor IEN ^ Category ^
Narrative (Health Factor description/name) ^ Level ^^^^^ Next
comment sequence # ^ Get Reminder
(n)=XAM(+:  add, -: delete) ^ Exam IEN ^ Category ^ Narrative
(Exam description/name) ^ Results ^^^^^ Next comment sequence
#
(n)=ICR (+:  add, -: delete) ^ Variable Pointer IMM
Contraindication Reasons/IMM Refusal Reasons ^ Category ^
Narrative ^ Immunization IEN ^ Warn Until Date ^ Event
Date/Time ^ Enc Provider IEN ^ ^ Next comment sequence #

INPUT PARAMETER: LOC                    PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 40               REQUIRED: NO
SEQUENCE NUMBER: 2
DESCRIPTION:
This is the hospital location. This is not used when the information is
from an outside source.

INPUT PARAMETER: PKGNAME                PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 60               REQUIRED: YES
SEQUENCE NUMBER: 3
DESCRIPTION:
The package name that is sending the data to PCE. This should be the
full package name from the PACKAGE file or a pointer to the PACKAGE file
(#9.4). If Middleware is involved, the Middleware package name should be the
PKGNAME. If the calling product has a PACKAGE file entry and is not
middleware, then the product's PACKAGE file name should be the PKGNAME. For
CPRS PCE updates, the PKGNAME is PATIENT CARE ENCOUNTERS, but that should not
be used generically for any product.

Note:The Package Name field will only be updated in the PCE Visit and
V-files when PX SAVE DATA is called before TIU CREATE NOTE by the
application/middleware.

INPUT PARAMETER: SRC                    PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 64               REQUIRED: YES
SEQUENCE NUMBER: 4
DESCRIPTION:
The source of the data being sent to PCE. If the source is an application
using middleware, the SRC should be the name of that application.  This
applies to COTS, Class 3, Class 2, and Class 1 applications. SRC can be text
or a pointer to the PCE DATA SOURCE file (#839.7). The text does not need to
be pre-defined in the PCE DATA SOURCE file because it will be added using
LAYGO for new data sources.

Note: The Data Source will only be updated in the PCE Visit and V-files when
PX SAVE DATA is called before TIU CREATE NOTE by the application/middleware.


RETURN PARAMETER DESCRIPTION:   Returned Value:
1  If no errors occurred and data was processed.
-1  If errors occurred, but data was processed as completely as
possible.
-2  Unable to identify a valid Visit. No data was processed.
-3  RPC was called incorrectly. No data was processed.
-4  If cannot get a lock on the encounter.
-5  If there were only warnings.

Optionally, if the argument RETVISIT was "1", than the Visit IEN will be
returned as the second piece (e.g., "1^65234").