Print Page as PDF
DBIA4205 ICR (4205)

DBIA4205    ICR (4205)

Name Value
NUMBER 4205
IA # 4205
DATE CREATED 2003/12/23
CUSTODIAL PACKAGE REGISTRATION
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGAPI
NAME DBIA4205
GENERAL DESCRIPTION
API to allow access to Inpatient CPTs and Inpatient
POVs.
STATUS Active
KEYWORDS
  • CPT
  • POV
  • Diagnosis
ID DGAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$DATA2PTF(DFN,PTFIEN,PSDATE,USER,ERR_DISPLAY,SOURCE)
This function adds professional services to file 46.
The data is passed using ^TMP("PTF",$J,FILE #,SEQUENCE #)=  Professional
Services are in the Inpatient CPT Procedure file (46) and Inpatient Diagnoses
in file 46.1.  At least one procedure or diagnosis is required.  This function
returns the IEN for the PTF file entry if successful.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
(required)  The IEN for the Patient file (2).
PTFIEN Input
(optional)  The IEN for the PTF file (45).
PSDATE Input
(required)  The date and time of the professional
service.
USER Input
(optional)  User who is responsible for
add/edit/delete action on the encounter.  Pointer to the New Person file
(200).
ERR_DISPLAY Input
(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 ERR_DISPLAY is not defined, errors are posted
to the TMP file subscripted by "DIERR" at the next level to the node that
caused the error.
SOURCE Input
(optional)  Where SOURCE is a string of text (3-30
character) identifying the source of the data. Examples of  SOURCE are:  "LAB
DATA" or "RADIOLOGY DATA".
~TMP('PTF',$J,46,0) Output
REFPROV^PERFPROV^PRIMARY DIAGNOSIS^RENDERING LOCATION

1. REFPROV (optional)  The referring or ordering provider.

2. PERFPROV (required)  The performing provider.

3. PRIMARY DIAGNOSIS (required)  The first diagnosis to list in box 21 on the
HCFA 1500.

4. RENDERING LOCATION (optional)  The location the service was rendered if it
was different from the provider's location.  The name and address are printed
in box 32 on the HCFA 1500.
~TMP('PTF',$J,46,SEQ) Output
Inpatient CPT data.  Each diagnosis must have a
cooresponding entry in file 46.1

CPT IEN^CPT CODE^CPT MODIFIER 1^CPT MODIFIER 2^RELATED DIAGNOSIS 1^RELATED
DIAGNOSIS 2^RELATED DIAGNOSIS 3^RELATED DIAGNOSIS 4^TREATED FOR SC
CONDITION^TREATED FOR AO CONDITION^EXPOSED TO ENVIR CONTAMINANTS^TREATMENT FOR
MST^TREATMENT FOR HEAD/N ECK CA

SEQ   Sequence number to allow for multiple entries.

CPT IEN                   0;1 IEN for CPT Record (Optional) If the IEN is
provided and there is an existing record, this information will overlay the
existing record.  The CPT Code must match the existing record.  This value is
passed back by th e API if the call is successful.

HELP-PROMPT: Enter the IEN for the CPT record in the Inpatient CPT file (46).
CPTINFO(DFN,PTFIEN,PSDATE)
This entry point will return the CPT procedure data
for a single professional service from file 46 in ^TMP("PTF",$J,46,
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
(required)  The IEN for the Patient file (2).
PTFIEN Input
(optional)  The IEN for the PTF file (45).
PSDATE Input
(required)  The date and time of the professional
service.
~TMP('PTF',$J,46,0) Output
REFPROV^PREFPROV^PRIMARY DIAGNOSIS^RENDERING LOCATION

1.REFPROV (optional)  The referring or ordering provider.

2.  PERFPROV
(required)  The performing provider.

2.  PRIMARY DIAGNOSIS
(required)  The first diagnosis to list in box 21 on the HCFA 1500.

3.  RENDERING LOCATION
(optional)  The location the service was rendered if it was different from the
provider's location.  The name and address are printed in box 32 on the HCFA
1500.
~TMP('PTF',$J,46,SEQ) Output
CPT IEN^CPT CODE^CPT MODIFIER 1^CPT MODIFIER
2^RELATED DIAGNOSIS 1 ^ RELATED DIAGNOSIS 2^RELATED DIAGNOSIS 3^RELATED
DIAGNOSIS 4^TREATED FOR SC CONDITION^TREATED FOR AO CONDITION^EXPOSED TO ENVIR
CONTAMINANTS^TREATMENT FOR MST^TREATMENT FOR HEAD/NECK CA

1.  CPT IEN                   0;1 IEN for CPT Record

2.  CPT CODE               0;2 POINTER TO CPT FILE (#81) (Required)
HELP-PROMPT: Enter the procedure, services or supplies using CPT or HCPCS
DESCRIPTION:  This is the procedure, services, or supplies used for the
patient.  It is using the HCFA Common Procedure Coding System (HCPCS) or
Common Procedure Terminology (CPT) code.  This value appears on the HCFA 1500
in box 24d.  the value s in this field will be provided to the billing package
when the record is closed.

3.  CPT MODIFIER 1         0;3 POINTER TO CPT MODIFIER FILE (#81.3)
HELP-PROMPT:      Indicates that a service or procedure has been altered, but
code unchanged. DESCRIPTION:      Used to indicate that a service or procedure
has been altered by some specific circumstance but without changing the
definition or code.

4.  CPT MODIFIER 2         0;4 POINTER TO CPT MODIFIER FILE (#81.3)
HELP-PROMPT:      Indicates that a service or procedure has been altered, but
code UNCHANGED. DESCRIPTION:      Used to indicate that a service or procedure
has been altered by some specific circumstance but not changed definition or
code.

5.  RELATED DIAGNOSIS 1    0;5 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)
HELP-PROMPT:      The primary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      The diagnosis code most directly
related to the procedure code performed for this professional service.  This
field must be entered for each CPT code entered.  It appears in box 21 on the
HCFA-1500 and is associated with a proc edure in box 24e.

6.  RELATED DIAGNOSIS 2    0;6 POINTER TO ICD DIAGNOSIS FILE (#80)
HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

7.  RELATED DIAGNOSIS 3    0;7 POINTER TO ICD DIAGNOSIS FILE (#80)
HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

8.  RELATED DIAGNOSIS 4    0;8 POINTER TO ICD DIAGNOSIS FILE (#80)
HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

9.  TREATED FOR SC CONDITION 0;9 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; DESCRIPTION:      Enter 'Y' if this applicant is
service connected and the professional service is related to that service
connection.  Otherwise enter 'N'.  This field can only be entered if the
service connection information was entered in reg istration.  See field .301
in file 2.

10. TREATED FOR AO CONDITION 0;10 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Agent Orange
exposure indicated! DESCRIPTION:      The Agent Orange questions must be
answered yes in registration before this field can be entered.  Enter 'Y' if
this procedure is related to Agent Orange exposure based on the related
diagnosis.  See field .32102 in file 2.

11. TREATED FOR IR CONDITION 0;11 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Ionizing
Radiation exposure indicated! DESCRIPTION:      Enter 'Y' if the procedure
performed is related to exposure to ionizing .  Enter 'N' if the procedure
performed is unrelated to ionizing radiation.  The ionizing radiation
information must be entered in registration before it c an be entered here.
See field .32111 in file 2.

12. EXPOSED TO ENVIR CONTAMINANTS 0;12 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Environment
Contaminants exposure! DESCRIPTION:      Enter 'Y' if the procedure performed
is related to exposure to environmental contamination.  Enter 'N' if the
procedure performed is unrelated to environmental contamination.  This
information must be entered in Registration be fore it can be entered here.
See field .322013 in file 2.

13. TREATMENT FOR MST      0;13 SET (Required)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      Was the treatment related to
Military Sexual Trauma. DESCRIPTION:      Enter 'Y' if the procedure performed
is related to military sexual trauma.  Enter 'N' if the procedure performed is
unrelated to military sexual trauma.  This information must be entered in
registration first.

14. TREATMENT FOR HEAD/NECK CA 0;14 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      Was the treatment related to Head
and/or Neck Cancer. DESCRIPTION:      Enter 'Y' if this procedure is related
to treatment for head/neck cancer.  Enter 'N' is the procedure is unrelated to
the patient's head/neck cancer.

15. QUANTITY               0;15 NUMBER

INPUT TRANSFORM:  K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X HELP-PROMPT:
Enter a number between 1 and 99 indicating how many times this procedure was
done. DESCRIPTION: This is the number of times this procedure was done to the
patient for one professional service.

RELATED DIAGNOSIS 5    0;16 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)

HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

RELATED DIAGNOSIS 6    0;17 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)

HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

RELATED DIAGNOSIS 7    0;18 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)

HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.

RELATED DIAGNOSIS 8    0;19 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)

HELP-PROMPT:      A secondary diagnosis associated with the procedure
performed on the HCFA 1500. DESCRIPTION:      A secondary diagnosis related to
the procedure performed for this professional service.  This field is
optional.  It appears in box 21 on the HCFA-1500 and is associated with a
procedure in box 24e.
PTFINFOR(DFN,PTFIEN,DATE)
This entry point will return an array of Professional
Service dates and times for an inpatient visit in the PTF file (45).
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
(required) The IEN in the Patient file (2)
PTFIEN Input
(required) The IEN in the PTF file (45)
DATE Input
(required if PTFIEN is not provided)  The date and
time of the order.  This will be used to identify the inpatient stay if the
PTFIEN is not provided.
~TMP('PTF',$J,SEQUENCE #) Output
PSDATE ^ REFPROV ^ PERFPROV ^ PRIMARY DIAGNOSIS ^
RENDERING LOCATION

SEQUENCE NUMBER  A number to allow for multiple
entries to be returned.

PSDATE           (required)  The date and time of the professional service.

REFPROV          (required)  The referring or ordering provider.

PERFPROV         (required)  The performing provider.

PRIMARY DIAGNOSIS (required)  The first diagnosis to list in box 21
on the HCFA 1500.
This diagnosis must appear at leat once associated with a
CPT code for this professional service.

RENDERING LOCATION  (optional) The location the service was rendered if
it was different from the provider's location.
The name and address are printed in box 32 on
the HCFA 1500.
$$DELCPT(CPTIEN)
This entry point deletes indivdual entries in the
Inpatient CPT file (46).  If this results in a professional service with no
CPT codes, the professional service will be deleted.  It is the responsibility
of the calling routine to fix any pointers to the Inpatient CPT file.  All
deletes are logical.
VARIABLES TYPE VARIABLES DESCRIPTION
CPTIEN Input
(Required) The IEN for the CPT in the Inpatient CPT
cile (46).
$$DELCPT Output
1      No errors occurred -1     Record was locked,
no changes made
$$DELPOV(POVIEN)
This entry point deletes individual entries in the
Inpatient CPT file (46).  If this results in a professional service with no
codes, the professional service will be deleted.  It is the responsibility of
the calling routine to fix any pointers from the Inpatient CPT file.  All
deletes are logical.
VARIABLES TYPE VARIABLES DESCRIPTION
POVIEN Input
(required) The IEN for the diagnosis in the Inpatient
POV file (46.1).
$$DELPOV Output
2   No errors occurred -1  Record was locked, no
changes made
ICDINFO(DFN,PTFIEN,DATE,ICDIEN)
This function returns the ICD9 Diagnosis data for a
single inpatient stay from ~TMP('PTF',$J,46.1,
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
(required) This is the patient DFN.
PTFIEN Input
(optional) The IEN from the PTF file (45).
DATE Input
(required if the PTFIEN and ICDIEN are not provided)
The date and time of the order.  This will be used to identify the inpatient
stay if the PTFIEN is not provided.
ICDIEN Input
(optional)  The IEN from the Inpatient POV file
(46.1)
~TMP('PTF',$J,46.1,SEQ) Output
=POV IEN^DIAGNOSIS^TREATED FOR SC CONDITION^TREATED
FOR AO CONDITION^EXPOSED TO ENVIR CONTAMINANTS^TREATMENT FOR MST^TREATMENT FOR
HEAD/NECK CA

1.POV IEN                   0;1 IEN for Diagnosis Record (Optional)  If the
IEN is provided and there is an existing record, this information will overlay
the existing record.  This value is passed back by the API if the call is
successful.

HELP-PROMPT: Enter the IEN for the Diagnosis record in the Inpatient POV file
(46).  DESCRIPTION:  This is the IEN for the Diagnosis record in the Inpatient
POV file.  It should be stored in the orders file.

2. DIAGNOSIS   0;2 POINTER TO ICD DIAGNOSIS FILE (#80) (Required) HELP-PROMPT:
The primary diagnosis associated with the procedure performed on the HCFA
1500. DESCRIPTION:      The diagnosis code most directly related to the
procedure code performed for this professional service.  This field must be
entered for each CPT code entered.  It appears in box 21 on the HCFA-1500 and
is associated with a proc edure in box 24e.

3. TREATED FOR SC CONDITION 0;3 SET (Required if YES for registration.) '1'
FOR YES; '0' FOR NO; DESCRIPTION:      Enter 'Y' if this applicant is service
connected and the professional service is related to that service connection.
Otherwise enter 'N'.  This field can only be entered if the service connection
information was entered in reg istration.  See field .301 in file 2.

4. TREATED FOR AO CONDITION 0;4 SET (Required if YES for registration.) '1'
FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Agent Orange
exposure indicated! DESCRIPTION:      The Agent Orange questions must be
answered yes in registration before this field can be entered.  Enter 'Y' if
this procedure is related to Agent Orange exposure based on the related
diagnosis.  See field .32102 in file 2.

5. TREATED FOR IR CONDITION 0;5 SET (Required if YES for registration.) '1'
FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Ionizing
Radiation exposure indicated! DESCRIPTION:      Enter 'Y' if the procedure
performed is related to exposure to ionizing .  Enter 'N' if the procedure
performed is unrelated to ionizing radiation.  The ionizing radiation
information must be entered in registration before it c an be entered here.
See field .32111 in file 2.

6. EXPOSED TO ENVIR CONTAMINANTS 0;6 SET (Required if YES for registration.)
'1' FOR YES; '0' FOR NO; HELP-PROMPT:      The Patient must have Environment
Contaminants exposure! DESCRIPTION:      Enter 'Y' if the procedure performed
is related to exposure to environmental contamination.  Enter 'N' if the
procedure performed is unrelated to environmental contamination.  This
information must be entered in Registration be fore it can be entered here.
See field .322013 in file 2.

7. TREATMENT FOR MST      0;7 SET (Required) '1' FOR YES; '0' FOR NO;
HELP-PROMPT:      Was the treatment related to Military Sexual Trauma.
DESCRIPTION:      Enter 'Y' if the procedure performed is related to military
sexual trauma.  Enter 'N' if the procedure performed is unrelated to military
sexual trauma.  This information must be entered in registration first.

8. TREATMENT FOR HEAD/NECK CA 0;8 SET (Required if YES for registration.) '1'
FOR YES; '0' FOR NO; HELP-PROMPT:      Was the treatment related to Head
and/or Neck Cancer. DESCRIPTION:      Enter 'Y' if this procedure is related
to treatment for head/neck cancer.  Enter 'N' is the procedure is unrelated to
the patient's head/neck cancer.
SUBSCRIBING PACKAGE
DBA Comments
7/2/15-MM:  Clincal Case Registries added as a subscriber to
ICR #4205 for patch ROR*1.5*26.  Clinical Case Registries (CCR - ROR
namespace)  would like to request that the package be added as a subscriber to
existing IA #4205 to allow access to inpatient CPT codes for use in inclusion
logic for adding patients into a registry.

Amy Harper confirm IB uses this API for third party billing and is the
appropriate API to use to access CPT data in PTF.
MAIL MESSAGE 37563325
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2015/07/02 17:19 SUBSCRIBER ADDED KOPP,TERRY KOPP,TERRY
DESCRIPTION [u"Enter 'Y' if this procedure is related to treatment for", u"head/neck cancer. Enter 'N' is the procedure is unrelated to the patient's", u'head/neck cancer.', u'QUANTITY 0;15 NUMBER', u'INPUT TRANSFORM: K:+X\'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X HELP-PROMPT:', u'Enter a number between 1 and 99 indicating how many times this procedure was', u'done. DESCRIPTION: This is the number of times this procedure was done to the', u'patient for one professional service.', u'RELATED DIAGNOSIS 5 0;16 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)', u'HELP-PROMPT: A secondary diagnosis associated with the procedure', u'performed on the HCFA 1500. DESCRIPTION: A secondary diagnosis related to', u'the procedure performed for this professional service. This field is', u'optional. It appears in box 21 on the HCFA-1500 and is associated with a', u'procedure in box 24e.', u'RELATED DIAGNOSIS 6 0;17 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)', u'HELP-PROMPT: A secondary diagnosis associated with the procedure', u'performed on the HCFA 1500. DESCRIPTION: A secondary diagnosis related to', u'the procedure performed for this professional service. This field is', u'optional. It appears in box 21 on the HCFA-1500 and is associated with a', u'procedure in box 24e.', u'RELATED DIAGNOSIS 7 0;18 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)', u'HELP-PROMPT: A secondary diagnosis associated with the procedure', u'performed on the HCFA 1500. DESCRIPTION: A secondary diagnosis related to', u'the procedure performed for this professional service. This field is', u'optional. It appears in box 21 on the HCFA-1500 and is associated with a', u'procedure in box 24e.', u'RELATED DIAGNOSIS 8 0;19 POINTER TO ICD DIAGNOSIS FILE (#80) (Required)', u'HELP-PROMPT: A secondary diagnosis associated with the procedure', u'performed on the HCFA 1500. DESCRIPTION: A secondary diagnosis related to', u'the procedure performed for this professional service. This field is', u'optional. It appears in box 21 on the HCFA-1500 and is associated with a', u'procedure in box 24e.']
Generated from JAN 24, 2019@ IA Listing Descriptions