Name | Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NUMBER | 1889 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IA # | 1889 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DATE CREATED | 1997/01/23 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CUSTODIAL PACKAGE | PCE PATIENT CARE ENCOUNTER | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CUSTODIAL ISC | Albany | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USAGE | Controlled Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TYPE | Routine | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DBIC APPROVAL STATUS | APPROVED | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ROUTINE | PXAPI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NAME | ADD/EDIT/DELETE PCE DATA SILENTLY | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ORIGINAL NUMBER | 1889 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GENERAL DESCRIPTION | PURPOSE: Provide a utility for ancillary packages such as Laboratory, Surgery, Medicine, Radiology, Text Integration Utility (TIU) and Computerized Patient Record System (CPRS) to non- interactively (silently) add/edit/delete data, including encounter, provider, diagnosis and procedure information. Dr. Kizer's 10/1/96 mandate which requires a provider, a procedure and a diagnosis to positively document the occurrence of an encounter, and the resulting change to use this data rather than stop codes to document workload and initiate third party billing, necessitated the development of an application programmer interface (API) which would support the mandated requirements. PCE was tasked with developing the API. $$DATA2PCE^PXAPI was developed to enable the adding, editing and deletion of encounter, provider, diagnosis and procedure data. Data will be stored in the Visit and V files and will be posted on the PXK VISIT DATA EVENT for use by subscribing packages such as Scheduling. This document includes: 1. Definitions and Conventions used to describe the API. 2. Description of $$DATA2PCE^PXAPI, its parameter definitions, and the returned values. 3. A table which describes the subscripts used for passing data to PCE. 4. An example array for passing data to PCE. DEFINITIONS AND CONVENTIONS: Listed below are definitions and conventions used to describe this API. 1. Valid data values: [ 1 | 0 | null ] `1' Denotes TRUE or YES `0' Denotes FALSE or NO null Denotes VALUE NOT KNOWN 2. Counter "i" is used as a subscript. It denotes a sequence number, i.e., 1, 2, 3. To denote deletion of a data ITEM, pass the "@" symbol as the data value in the node for the item being deleted. You may not delete required data items. 4. To denote deletion of an ENTRY, pass "1" as the data value in the "DELETE" node of the identified entry. $$DATA2PCE^PXAPI(INPUT_ROOT,PKG,SOURCE,.VISIT,USER,ERRDISP,.ERRARRAY,PPEDIT, .ERRPROB,.ACCOUNT) This is a function which will return a value identifying the status of the call. Data that is processed by PCE will be posted on the PXK VISIT DATA EVENT protocol. Parameter Description: 1. INPUT_ROOT: (required) Where INPUT_ROOT is a unique variable name, either local array or global array, which identifies the defined data elements for the encounter. An example of an INPUT_ROOT is ^TMP("LRPXAPI",$J) or ^TMP("RAPXAPI",$J). The gross structure of the array includes four additional subscripts (ENCOUNTER, PROVIDER, DX/PL, PROCEDURE and STOP) for defining the data passed. A detailed description of this array and its structure are included below in a table format. 2. PKG: (required) Where PKG is a pointer to the Package File (9.4). 3. SOURCE: (required) Where SOURCE is a string of text (3-30 character) identifying the source of the data. The text is the SOURCE NAME field (.01) of the PCE Data Source file (839.7). If the SOURCE currently does not exist in the file, it will be added. Examples of SOURCE are: "LAB DATA" or "RADIOLOGY DATA" or "PXCE DATA ENTRY" or "AICS ENCOUNTER FORM." 4. VISIT: (optional) Where VISIT is a pointer to the Visit file (9000010) which identifies the encounter which this data must be associated with. If the pointer to the Visit file does not match data passed in INPUT_ROOT then this DBIA will return negative value '-3', see the Returned Value description below. If the pointer value to the Visit is saved, it is necessary to also subscribe to IA 1902. 5. USER: (optional) User who is responsible for add/edit/delete action on the encounter. Pointer to the New Person file (200). If USER is not defined, DUZ will be used. 6. ERRDISP: (optional) To display errors during development, this variable may be set to "1". If it is defined the errors will be displayed on screen when the error occurs. If ERRDISP is not defined, errors will be posted on the defined INPUT_ROOT subscripted by "DIERR". BLD^DIALOG is used to manage errors. Review BLD^DIALOG and MSG^DIALOG descriptions included in the FileMan v. 22.0 Programmer Manual on pages 2-33 to 2-38. 7. ERRARRAY: (optional) A dotted variable name. When errors and warnings occur, the array will contain the PXKERROR array elements to the caller. 8. PPEDIT: (optional) Set to 1 if you want to edit the Primary Provider. Only use for the moment that editing is being done. 8. ERRPROB: (optional) A dotted variable name. When errors and warnings occur, they will be passed back in the form of an array with the general description of the problem. 8. ACCOUNT: (optional) A dotted variable name. Where ACCOUNT is the PFSS Account Reference associated with the data being by the calling application. Each PFSS Account represents an internal entry number in the PFSS ACCOUNT file (#375). Returned Value: 1 If no errors occurred and data was processed. -1 An error occurred. Data may or may not have been processed. If ERR_DISPLAY is undefined, errors will be posted on the INPUT_ROOT subscripted by "DIERR". -2 Unable to identify a valid VISIT. No data was processed. -3 API was called incorrectly. No data was processed. It is advisable to verify a Return Value for confirmation if the passed data was processed or not, also if this DBIA is called in background. ENCOUNTER: All data must be associated with an entry in the VISIT file (#9000010). Only one "ENCOUNTER" node may be passed with each call to $$DATA2PCE^PXAPI. The "ENCOUNTER" node documents encounter specific information and must be passed: 1. To create an entry in the VISIT file (9000010). All provider, diagnosis and procedure data is related to an entry in the VISIT file. 2. To enable adding, editing or deleting "ENCOUNTER" node data elements. When encounter data elements are not added, edited or deleted, the VISIT parameter may be passed in lieu of defining an "ENCOUNTER" node. SUBSCRIPT DESCRIPTION: "ENCOUNTER",1,"ENC D/T") Required This is the encounter date/ time for primary encounters or the date for occasions of service. If the encounter is related to an appointment, this is the appointment date/time. If this is an occasion of service created by an ancillary package, this is the date/time of the instance of care. Imprecise dates are allowed for historical encounters. Encounter date/time may be added, but not edited. *Deletions of encounters can occur only when nothing is pointing to the encounter. *"ENC D/T" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the VISIT/ADMIT DATE&TIME field (#.01) in the Visit file of the vistit IEN passed as the VISIT parameter. Only matching values will be accepted and if on match occurs then '-3' will be retured, see the Returned Value above. Format: FileMan Internal Format for date/time "ENCOUNTER",1,"PATIENT") Required This is the patient DFN. This cannot be edited or deleted. *"PATIENT" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the PATIEN NAME field (# .05) in the Visit file of the visit IEN passed as the VISIT parameter. Only matching values will be accepted and if on match occurs then -3 will be returned, see the Returned Value above. Format: Pointer to IHS Patient file (9000001) This file is Dinumed to the Patient file (2) "ENCOUNTER",1,"HOS LOC") Required This is the hospital location where the encounter took place for primary encounters, or this is the ordering location for ancillary encounters. *"HOS LOC" is not required for existing visits where the visit number is included in the parameter list but if it is passed then it will be checked against the HOSPITAL LOCATION filed (#.22) in the Visit file of the visit IEN passed as the VISIT parameter. Only matching values will be accepted and if no match occurs then '-3' will be returned, see the Returned Value above. Format: Pointer to Hospital Location file (44) "ENCOUNTER",1,"OUTSIDE LOCATION") Optional This is an outside location of an encounter, not included in the INSTITUTION file. The OUTSIDE LOCATION should exclude the INSTITUTION: "ENCOUNTER",1,"INSTITUTION") and the INSTITUTION should exclude the OUTSIDE LOCATION. Format: Free text (2-245 characters) "ENCOUNTER",1,"INSTITUTION") Optional This is the Institution where the encounter took place. If it is not defined, the division defined for the Hospital Location is used. If that is not defined, $$SITE^VASITE is used. Format: Pointer to IHS Location file (9999999.06). This file is dinumed to the Institution file (4). "ENCOUNTER",1,"SC") Optional This encounter is related to a service connected condition. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CV") Optional This encounter is related to Combat Veteran Format: [ 1 | 0 | null ] "ENCOUNTER",1,"AO") Optional This encounter is related to Agent Orange exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"IR") Optional This encounter is related to Ionizing Radiation exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"EC") Optional This encounter is related to Environmental Contaminant exposure. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"SHAD") Optional This encounter is related to Project 112/SHAD Format: [ 1 | 0 | null ] "ENCOUNTER",1,"MST") Optional This encounter is related to Military Sexual Trauma. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"HNC") Optional This encounter is related to Head & Neck Cancer. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CLV") Optional This encounter is related to Camp Lejeune. Format: [ 1 | 0 | null ] "ENCOUNTER",1,"CHECKOUT D/T") Optional This is the date/time when the encounter was checked out. Format: FileMan Internal Format for date/time "ENCOUNTER",1,"ELIGIBILITY") Optional This is the eligibility of the patient for this encounter. Format: Pointer to Eligibility Code file (8) "ENCOUNTER",1,"APPT") Optional This is the appointment type of the encounter. Format: Pointer to Appointment Type file (409.1) "ENCOUNTER",1,"SERVICE CATEGORY") Required This denotes the type of encounter. Format: Set of Codes. A::=Ambulatory Should be used for clinic encounters. "A" s are changed to "I" s by Visit Tracking if patient is an inpatient at the time of the encounter. H::=Hospitalization Should be used for an admission. I::=In Hospital C::=Chart Review T::=Telecommunications N::=Not Found S::=Day Surgery E::=Event (Historical) Documents encounters that occur outside of this facility. Not used for workload credit or 3rd party billing. R::=Nursing Home D::=Daily Hospitalization Data X::=Ancillary Package Daily Data. "X" s are changed to "D" s by Visit Tracking if patient is an inpatient at the time of the encounter. "ENCOUNTER",1,"DSS ID") Optional This is required for ancillary occasions of service such as laboratory and radiology or telephone encounters Format: Pointer to Clinic Stop file (40.7) "ENCOUNTER",1,"ENCOUNTER TYPE") Required This identifies the type of encounter, e.g., primary encounter, ancillary encounter, etc. A "Primary" designation indicates that the encounter is associated with an appointment or is a standalone. Examples of ancillary encounters include Laboratory and Radiology instances of care. Format: Set of Codes. P::=Primary O::=Occasion of Service S::=Stop Code A::=Ancillary Ancillary packages such as Laboratory and Radiology Should pass an "A" C::=Credit Stop If the visit number is included in passed parameters then the passed code will be checked against the ENCOUNTER TYPE field (#15003) in the Visit file of the visit IEN passed as VISIT parameter. Only matching values will be accepted and if no match occurs then '-3' will be returned, see the Returned Value above. "ENCOUNTER",1,"PARENT") Optional This is the parent encounter for which the ENCOUNTER is a supporting encounter. For example, this would be the primary encounter for which this occasion of service supports and should be associated. Format: Pointer to Visit file (9000010). "ENCOUNTER",1,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "ENCOUNTER",1,"DELETE") Optional This is a flag that denotes deletion of the encounter entry. Encounter will not be deleted if other data is pointing to it. Format: [ 1 | null ]| PROVIDER: The "PROVIDER" node may have multiple entries (i) and documents the provider, indicates whether he/she is the primary provider, and indicates whether the provider is the attending provider. Comments may also be passed. To delete the entire "PROVIDER" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PROVIDER",i,"NAME") Required Provider's IEN. Format: Pointer to NEW PERSON file (200) "PROVIDER",i,"PRIMARY") Optional Indicator that denotes this provider as the "primary" provider. Format: [ 1 | 0 | null ] "PROVIDER",i,"ATTENDING") Optional Indicator that denotes this provider as the attending provider. Format: [ 1 | 0 | null ] "PROVIDER",i,"COMMENT") Optional Comment Format: Free text (1 - 245 characters) "PROVIDER",i,"DELETE") Optional This is a flag that denotes deletion of the Provider entry. Format: [ 1 | null ]| DX/PL: The "DX/PL" node may have multiple entries (i) and documents diagnoses and/or problems. Only active ICD-9-CM codes will be accepted. The "DX/PL" node adds diagnoses to the PCE database as well as adding an active or inactive diagnosis or problem to the Problem List. If a diagnosis or problem already exists on the Problem List, this node may be used to inactivate it. To delete the entire "DX/PL" entry from PCE (not Problem List), set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "DX/PL",i,"DIAGNOSIS") Required for PCE Optional for PL Diagnosis code Format: Pointer to ICD9 Diagnosis file (80) "DX/PL",i,"PRIMARY") Optional for PCE N/A for PL Code that specifies that the diagnosis is the "primary" diagnosis for this encounter. Only one "primary" diagnosis is recorded for each encounter. Format: "P"::=Primary "1"::=Primary "S"::=Secondary "0"::=Secondary "DX/PL",i,"ORD/RES") Optional for PCE N/A for PL Code that specifies that the diagnosis is either an "ordering diagnosis or is a "resulting diagnosis or "both for this encounter. Format: "O ::=Ordering "R ::=Resulting "OR ::=Both Ordering and Resulting "DX/PL",i,"LEXICON TERM") Optional for PCE Optional for PL This is a term that is contained in the Clinical Lexicon. Format: Pointer to the Expressions file (757.01) "DX/PL",i,"PL IEN") Optional for PCE *Optional for PL This is the problem IEN that is being acted upon. *This node is required to edit an existing problem on the Problem List. Format: Pointer to Problem List file (9000011) "DX/PL",i,"PL ADD") N/A for PCE *Optional for PL *This is required to Add a diagnosis/problem to the Problem List. "1" indicates that the entry should be added to the Problem List. Format: [ 1 | 0 | null ] "DX/PL",i,"PL ACTIVE") N/A for PCE Optional for PL This documents whether a problem is active or inactive. The Default is Active if not specified. Format: Set of Codes. A::=Active I::=Inactive "DX/PL",i,"PL ONSET DATE") N/A for PCE Optional for PL The date that the problem began. Format: FileMan Internal Format for date. "DX/PL",i,"PL RESOLVED DATE") N/A for PCE Optional for PL The date that the problem was resolved. Format: FileMan Internal Format for date. "DX/PL",i,"PL SC") Required for PCE Optional for PL This problem is related to a service connected condition. Format: [ 1 | 0 | null ] "DX/PL",i,"PL CV") Required for PCE Optional for PL This problem is related to Combat Veteran Format: [ 1 | 0 | null ] "DX/PL",i,"PL AO") Required for PCE Optional for PL This problem is related to Agent Orange exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL IR") Required for PCE Optional for PL This problem is related to Ionizing Radiation exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL SHAD") Required for PCE Optional for PL This problem is related to Project 112/SHAD Format: [ 1 | 0 | null ] "DX/PL",i,"PL EC") Required for PCE Optional for PL This problem is related to Environmental Contaminant exposure. Format: [ 1 | 0 | null ] "DX/PL",i,"PL MST") Required for PCE Optional for PL This problem is related to Military Sexual Trauma. Format: [ 1 | 0 | null ] "DX/PL",i,"PL HNC") Required for PCE Optional for PL This problem is related to Head and/or Neck Cancer Format: [ 1 | 0 | null ] "DX/PL",i,"PL CLV") Required for PCE Optional for PL This problem is related to Camp Lejeune. Format: [ 1 | 0 | null ] "DX/PL",i,"NARRATIVE") *Optional for PCE *Optional for PL The provider's description of the diagnosis/problem. *If NARRATIVE is not passed for a diagnosis/problem, the Description from the ICD Diagnosis file (80) will be used as the default. Format: Free text (2-245 characters) "DX/PL",i,"CATEGORY") Optional for PCE N/A for PL A term that denotes a grouping or category for a set of related diagnosis/problem. Format: Free text (2-245 characters) "DX/PL",i,"ENC PROVIDER") Optional for PCE *Optional for PL Provider who documented the diagnosis/problem. *This is required to Add a diagnosis/problem to the Problem List. Format: Pointer to New Person file (200) "DX/PL",i,"EVENT D/T") Optional for PCE N/A for PL Date/Time Diagnosis was documented. Format: FileMan Internal Format for date/time "DX/PL",i,"COMMENT") Optional for PCE *Optional for PL Comment Format: PCE Free Text (1-245 char) PL Free Text (3-60 char) "DX/PL",i,"DELETE") Optional for PCE N/A for PL This is a delete flag used to denote deletion of the diagnosis entry. Format: [ 1 | null ]| PROCEDURE: The "PROCEDURE" node may have multiple entries (i). Only active CPT/HCPCS codes will be accepted. The "PROCEDURE" node documents the procedure(s), the number of times the procedure was performed, the diagnosis the procedure is associated with and the narrative that describes the procedure. It also enables documentation of the provider who performed the procedure, the date/time the procedure was performed and any comments that are associated with the procedure. To delete the entire "PROCEDURE" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PROCEDURE",i,"PROCEDURE") Required Procedure code Format: Pointer to CPT file (81) "PROCEDURE",i,"MODIFIERS",MODIFIER)="" Optional CPT Modifier(s) Format: external form. Any number of modifiers may be listed. "PROCEDURE",i,"QTY") Required Number of times the procedure was performed. Format: Whole number > 0 "PROCEDURE",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified procedure and is the primary diagnosis associated with this procedure. Format: Pointer to ICD Diagnosis file (80) "PROCEDURE",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified procedure. "PROCEDURE",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified procedure. Format: Pointer to ICD Diagnosis file (80) "PROCEDURE",i,"NARRATIVE") *Optional The provider's description of the procedure performed. *If NARRATIVE is not passed for a procedure, the Short Name from the CPT file (81) will be used as the default. Format: Free text (2-245 characters) "PROCEDURE",i,"CATEGORY") Optional A term that denotes a grouping or category for a set of related procedures. Format: Free text (2-245 characters) "PROCEDURE",i,"ENC PROVIDER") Optional Provider who performed the procedure. Format: Pointer to New Person file (200) "PROCEDURE",i,"ORD PROVIDER") Optional Provider who ordered the procedure. Format: Pointer to New Person file (200) "PROCEDURE",i,"ORD REFERENCE") Optional Order reference for the ordered procedure. Format: Pointer to the Order file (100) "PROCEDURE",i,"EVENT D/T") Optional Date/Time procedure was done. Format: FileMan Internal Format for date/time "PROCEDURE",i,"DEPARTMENT") Optional A 3-digit code that defines the service area. Missing Department Codes will be assigned a Department Code. The Department Code will be the Stop Code associated (in the HOSPITAL LOCATION file, #44) with the Hospital Location of the patient visit. If no Department Code can be established, a 999 will be passed to the PFSS Cache. Format: Set of Codes. 1::=Poor 2::=Fair 3::=Good 4::=Group--No Assessment 5::=Refused 108::=Laboratory 160::=Pharmacy 419::=Anesthesiology 423::=Prosthetics 180::=Oral Surgery 401::=General Surgery 402::=Cardiac Surgery 403::=Otorhinolaryngology (ENT) 404::=Gynecology 406::=Neurosurgery 407::=Ophthalmology 409::=Orthopedics 410::=Plastic Surgery (inc. H&N) 411::=Podiatry 412::=Proctology 413::=Thoracic Surgery 415::=Peripheral Vascular 457::=Transplantation 105::=General Radiology 109::=Nuclear Medicine 109::=Cardiology Studies (Nuclear Med) 115::=Ultrasound 703::=Mammography 150::=CT Scan 151::=Magnetic Resonance Imaging 152::=Angio-Neuro-Interventional 421::=Vascular Lab "PROCEDURE",i,"COMMENT") Optional Comment Free Text (1-245 characters) "PROCEDURE",i,"DELETE") Optional This is a flag that denotes deletion of the Procedure entry. Format: [ 1 | null ]| PATIENT ED: The "PATIENT ED" node may have multiple entries (i). To delete the entire "PATIENT ED" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "PATIENT ED",i,"TOPIC") Required Education Topic that patient received education. Format: Pointer to Education Topics file (9999999.09) "PATIENT ED",i,"UNDERSTANDING") Optional The patients level of understanding of the education. Format: Set of Codes. 1::=Poor 2::=Fair 3::=Good 4::=Group--No Assessment 5::=Refused "PATIENT ED",i,"ENC PROVIDER") Optional Provider who was the educator. Format: Pointer to New Person file (200) "PATIENT ED",i,"EVENT D/T") Optional Date/Time of Event Format: FileMan Internal Format for date/time "PATIENT ED",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "PATIENT ED",i,"DELETE") Optional This is a flag that denotes deletion of the Provider entry. Format: [ 1 | null ]| "PATIENT ED",i,"DELETE") Optional This is a flag that denotes deletion of the Patient Ed entry. Format: [ 1 | null ]| HEALTH FACTOR: The "HEALTH FACTOR" node may have multiple entries (i). To delete the entire "HEALTH FACTOR" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "HEALTH FACTOR",i,"HEALTH FACTOR") Required Health Factor that contributes to a patient's state of health. Format: Pointer to Health Factors file (9999999.64) "HEALTH FACTOR",i,"LEVEL/SEVERITY") Optional Level/Severity of health factor related to the patient's state of health. Format: Set of Codes. M::=Minimal MO:=Moderate H:=Heavy/Severe "HEALTH FACTOR",i,"ENC PROVIDER") Optional Provider who documented the health factor. Format: Pointer to New Person file (200) "HEALTH FACTOR",i,"EVENT D/T") Optional Date/Time of Event Format: FileMan Internal Format for date/time "HEALTH FACTOR",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "HEALTH FACTOR",i,"DELETE") Optional This is a flag that denotes deletion of the Health Factor entry. Format: [ 1 | null ]| EXAM: The "EXAM" node may have multiple entries (i). To delete the entire "EXAM" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "EXAM",i,"EXAM") Required Exam that was performed. Format: Pointer to Exam file (9999999.15) "EXAM",i,"RESULT") Optional Result of Exam Format: Set of Codes. A::=Abnormal N::=Normal "EXAM",i,"ENC PROVIDER") Optional Provider who performed the exam.. Format: Pointer to New Person file (200) "EXAM",i,"EVENT D/T") Optional Date/Time of Exam Format: FileMan Internal Format for date/time "EXAM",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "EXAM",i,"DELETE") Optional This is a flag that denotes deletion of the Exam entry. Format: [ 1 | null ]| SKIN TEST: The "SKIN TEST" node may have multiple entries (i). To delete the entire "SKIN TEST" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "SKIN TEST",i,"TEST") Required Skin Test that was performed Format: Pointer to Skin Test file (9999999.28) "SKIN TEST",i,"READING") Optional Numeric measurement of the surface area tested (in millimeters). Format: Whole number between 0 and 40 inclusive. "SKIN TEST",i,"RESULT") Optional Results of the Skin Test Format: Set of Codes. P::=Positive D::=Doubtful N::=Negative O::=No Take "SKIN TEST",i,"D/T READ") Optional Date/time skin test was read Format: FileMan Internal Format for date/time "SKIN TEST",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified skin test and is the primary diagnosis associated with this skin test. Format: Pointer to ICD Diagnosis file (80) "SKIN TEST",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified skin test. "SKIN TEST",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified skin test. Format: Pointer to ICD Diagnosis file (80) "SKIN TEST",i,"ENC PROVIDER") Optional Provider who read the skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"EVENT D/T") Optional Date/Time test was administered. Format: FileMan Internal Format for date/time "SKIN TEST",i,"COMMENT") Optional Comment Format: Free Text field (1-245 characters) "SKIN TEST",i,"READER") Optional The person who read the skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"ORD PROVIDER") Optional The provider who ordered this skin test. Format: Pointer to New Person file (200) "SKIN TEST",i,"D/T PLACEMENT RECORDED") Optional The date and time of documentation of the placement of the skin test. Format: FileMan Internal Format for date/time "SKIN TEST",i,"ANATOMIC LOC") Optional The anatomic location of skin test placement. Format: Pointer to Imm Administration Site (Body) file (920.3) "SKIN TEST",i,"D/T READING RECORDED") Optional The date and time of documentation of the reading of the skin test. Format: FileMan Internal Format for date/time "SKIN TEST",i,"READING COMMENT") Optional Comment related to the reading of the patient's skin test. Format: Free Text field (1-245 characters) "SKIN TEST",i,"DELETE") Optional This is a flag that denotes deletion of the Skin Test entry. Format: [ 1 | null ]| IMMUNIZATION: The "IMMUNIZATION" node may have multiple entries (i). To delete the entire "IMMUNIZATION" entry, set the "DELETE" node to 1. Effective with PX*1*209, the "IMMUNIZATION" node contains modifications to include additional fields: Event Info Source, Dosage, Route, Admin Site, Lot #. These new fields are optional, and therefore backward compatible. SUBSCRIPT DESCRIPTION: "IMMUNIZATION",i,"IMMUN") Required Immunization that was performed. Format: Pointer to Immunization file (9999999.14) "IMMUNIZATION",i,"SERIES") Optional Series specifies the sequence of the series for the immunization that was administered. Format: Set of Codes. P::=Partially complete C::=Complete B::=Booster 1::=Series1 thru 8::=Series8 "IMMUNIZATION",i,"REACTION") Optional The observed reaction to the immunization. Format: Set of Codes. 0::=None 1::=Fever 2::=Irritability 3::=Local Reaction or Swelling 4::=Vomiting 5::=Rash or Itching 6::=Lethargy 7::=Convulsions 8::=Arthritis or Arthralgias 9::=Anaphylaxis or Collapse 10::=Respiratory Distress 11::=Other "IMMUNIZATION",i,"CONTRAINDICATED") Optional This field may be used to indicate that this immunization should not be administered again. "1" indicates that the immunization should not be given to the patient in the future. Format: [ 1 | 0 | null ] "IMMUNIZATION",i,"DIAGNOSIS") Optional The first diagnosis that is associated with the identified immunization and is the primary diagnosis associated with this immunization. Format: Pointer to ICD Diagnosis file (80) "IMMUNIZATION",i,"DIAGNOSIS 2") Optional The second diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 3") Optional The third diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 4") Optional The fourth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 5") Optional The fifth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 6") Optional The sixth diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 7") Optional The seventh diagnosis that is associated with the identified immunization. "IMMUNIZATION",i,"DIAGNOSIS 8") Optional The eighth diagnosis that is associated with the identified immunization. Format: Pointer to ICD Diagnosis file (80) "IMMUNIZATION",i,"ENC PROVIDER") Optional Provider who performed the immunization. Format: Pointer to New Person file (200) "IMMUNIZATION",i,"EVENT D/T") Optional Date/Time immunization was administered. Format: FileMan Internal Format for date/time "IMMUNIZATION",i,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "IMMUNIZATION",i,"LOT NUM") Optional The lot number of the Immunization entered for this event. Format: Pointer to Immunization Lot file (9999999.41) "IMMUNIZATION",i,"INFO SOURCE") Optional The source of the information obtained for this immunization event. Format: Pointer to Immunization Info Source file (920.1) "IMMUNIZATION",i,"ADMIN ROUTE") Optional The method this vaccine was administered. Format: Pointer to Imm Administration Route file (920.2) "IMMUNIZATION",i,"ANATOMIC LOC") Optional The area of the patient's body through which the vaccine was administered. Format: Pointer to Imm Administration Site (Body) file (920.3) "IMMUNIZATION",i,"DOSE") Optional The amount of vaccine product administered for this immunization. Format: Numeric (between 0 and 999, 2 fractional digits) "IMMUNIZATION",i,"DOSE UNITS") Optional The units that reflect the actual quantity of the vaccine product administered. Format: Pointer to the UCUM Codes file (#757.5) "IMMUNIZATION",i,"VIS",SEQ #,0)=VISIEN^DATE Optional The Vaccine Information Statement (VIS) offered to or given to the patient before administration of the immunization, and the date it was offered or given. Format: "VISIEN" is a pointer to the Vaccine Information Statement file (#920). "DATE" is a date (without time) in FileManager internal format. NOTE: If the caller is updating a previously recorded immunization: 1) If the caller passes in VIS data in the "VIS" subscript, the system will purge the previously filed VIS data before filing the updates. 2) If the caller does not pass in any VIS data, the previously filed VIS data persists. 3) If the caller wants to delete the previously filed VIS without replacing it with anything else, that is done explicitly by setting the "VIS" subscript as follows: "IMMUNIZATION",i,"VIS")="@" "IMMUNIZATION",i,"REMARKS",SEQ #,0) Optional Comments related to the immunization encounter with the patient. Format: Free-text in the format of a FileManager word-processing field. NOTE: If the caller is updating a previously recorded immunization: 1) If the caller passes in remarks in the "REMARKS" subscript, the system will purge the previously filed remarks before filing the updates. 2) If the caller does not pass in any remarks, the previously filed remarks persist. 3) If the caller wants to delete the previously filed remarks without replacing it with anything else, that is done explicitly by setting the "REMARKS" subscript as follows: "IMMUNIZATION",i,"REMARKS")="@" "IMMUNIZATION",i,"ORD PROVIDER") Optional The provider who ordered the immunization. Format: Pointer to New Person file (#200). "IMMUNIZATION",i,"WARNING ACK") Optional This field indicates acknowledgement of a contraindication/refusal event warning for this immunization with the decision to proceed with administration. Format: [ 1 | 0 | null ] "IMMUNIZATION",i,"OVERRIDE REASON" Optional This is the reason for overriding the warning of existing contraindication and/or refusal reasons. Format: Free Text (3-245 characters). "IMMUNIZATION",i,"DELETE") Optional This is a flag that denotes deletion of the Immunization entry. Format: [ 1 | null ]| TREATMENT: The "TREATMENT" node may have multiple entries (i). To delete the entire "TREATMENT" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "TREATMENT",i,"TREATMENT") Required Name of Treatment Format: Pointer to Treatment file (9999999.17) "TREATMENT",i,"QTY") Optional Number of times the treatment was performed. Format: Whole number > 0 "TREATMENT",i,"NARRATIVE") *Optional The provider's description of the treatment performed. *If NARRATIVE is not passed for a treatment, the Treatment Name from the Treatment file (9999999.17) will be used as the default. Format: Free text (2-245 characters) "TREATMENT",i,"CATEGORY") Optional A term that denotes a grouping or category for a set of related treatments. Format: Free text (2-245 characters) "TREATMENT",i,"ENC PROVIDER") Optional Provider who performed the treatment. Format: Pointer to New Person file (200) "TREATMENT",i,"EVENT D/T") Optional Date/Time treatment was done. Format: FileMan Internal Format for date/time "TREATMENT",i,"COMMENT") Optional Comment Format: Free Text (1-245 characters) "TREATMENT",i,"DELETE") Optional This is a flag that denotes deletion of the Treatment entry. Format: [ 1 | null ]| IMM CONTRA/REFUSAL: The "IMM CONTRA/REFUSAL" node may have multiple entries (i). To delete the entire "IMM CONTRA/REFUSAL" entry, set the "DELETE" node to 1. SUBSCRIPT DESCRIPTION: "IMM CONTRA/REFUSAL",i,"CONTRA/REFUSAL") Required The Contraindication or Refusal Reason. Format: Variable Pointer to: IMM Contraindication Reasons file (920.4) or IMM Refusal Reasons file (920.5). "IMM CONTRA/REFUSAL",i,"IMMUN") Required The immunization contraindicated or refused. Format: Pointer to Immunization file (9999999.14) "IMM CONTRA/REFUSAL",i,"WARN UNTIL DATE") Optional The date until which a warning should be given for this contraindication/refusal. Format: FileManager Internal Format for date. "IMM CONTRA/REFUSAL",i,"EVENT D/T") Optional The date/time of this contraindication/refusal event. Format: FileManager Internal Format for date/time. "IMM CONTRA/REFUSAL",i,"ENC PROVIDER") Optional This is the provider who recorded the contraindication/refusal event. Format: Pointer to New Person file (#200). "IMM CONTRA/REFUSAL",i,"COMMENT") Optional Comment. Format: Free Text (1-245 characters). "IMM CONTRA/REFUSAL",i,"DELETE") Optional This is a flag that denotes deletion of the IMM Contra/Refusal entry. Format: [ 1 | null ] EXAMPLE OF DATA PASSED TO $$DATA2PCE^PXAPI Provided below is an example of data passed to $$DATA2PCE^PXAPI where Laboratory is the ancillary package reporting the data. $$DATA2PCE^PXAPI("LRPXAPI",$J,182,"LAB DATA") This is an example where Laboratory passes two laboratory tests (Glucose and CPK) which were resulted on 4/20/96 at 9:30 a.m. This occasion of service is defined as an Ancillary Package Daily Data (X). ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"CREDIT STOP") = 59 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"ENC D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"HOS LOC") = 59 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"PATIENT") = 1030 ^TMP("LRPXAPI",543173595,"ENCOUNTER",1,"SERVICE CATEGORY") = X ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"ENC PROVIDER") = 58 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"EVENT D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"PROCEDURE") = 82950 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"QTY") = 1 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"ENC PROVIDER") = 58 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"EVENT D/T") = 2960420.093 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"PROCEDURE") = 82552 ^TMP("LRPXAPI",543173595,"PROCEDURE",2,"QTY") = 1 ^TMP("LRPXAPI",543173595,"PROVIDER",1,"NAME") = 58 ^TMP("LRPXAPI",543173595,"PROVIDER",1,"PRIMARY") = 1 ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"PROCEDURE") = ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"MODIFIERS",57) = "" ^TMP("LRPXAPI",543173595,"PROCEDURE",1,"QUANTITY") = 1 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STATUS | Active | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DURATION | Till Otherwise Agreed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ID | PXAPI | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
COMPONENT/ENTRY POINT | DATA2PCE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SUBSCRIBING PACKAGE |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DATE ACTIVATED | 2017/01/10 |