Print Page as PDF
Patient Service Construct java components ICR (4976)

Patient Service Construct java components    ICR (4976)

Name Value
NUMBER 4976
IA # 4976
DATE CREATED 2007/02/23
CUSTODIAL PACKAGE 757
USAGE Controlled Subscription
TYPE Other
NAME Patient Service Construct java components
GENERAL DESCRIPTION
Patient Service Construct is a Veterans Health
Information Systems and Technology Architecture (VistA) re-engineering project
based on the Java technologies.  Patient Service is a composite business
service that provides a broad range of high-level patient administrative data.
The data is based on access to the individual business services such as
Patient Demographics, Eligibility/Enrollment, and Patient Identification,
which serve as authoritative sources for that data.  For those applications
that have been re-engineered, all needs to retrieve patient administrative
data through a common business service will be met.  The Patient Service
Construct functionality is invisible to existing M VistA applications.

PSC provides a CAIP compliant delegate (IPatientServiceDelegate) for
applications to use that has two main API s, retrievePatientData
(IPatientServiceRequest) and retrieveMultiplePatients(IPatientService Request,
String[]) where the array of strings is an array of ICN values.  The delegate
accesses the patient data through a session fagade EJB.  It is the
responsibility of the calling application to instantiate the EJB in an
application server for its use. The data is retrieved at the specified VistA
location through the session fagade utilizing VistaLink.  The
IPatientServiceRequest must contain the necessary information to complete the
task.

This integration agreement documents the APIs provided by Patient Service
Construct.
STATUS Pending
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
retrievePatientData
When retrieving data for one patient, either of the
two business delegate interface methods may be used.

If using retrievePatientData(IPatientServiceRequestpsReq), the interface to
the PatientId class should be used to instantiate a PatientId object with an
ICN.  The PatientId object should then be set in the PatientServiceRequest.

The delegate interface method retrieveMultiplePatients(IPatientService
RequestpsReq,String[],icnArray) may also be used to retrieve an individual
patient by declaring an icnArray with only one element.
VARIABLES TYPE VARIABLES DESCRIPTION
IPatientServiceRequest Input
IPatientServiceRequest:

IPatientId pid = new PatientId(ICN) or IPatientId pid = new
PatientId(ICN_V_ICN checksum)
When instantiating with an ICN, the checksum is optional.
services java.util.List Input
services java.util.List of RequestedServices:

Patient Service Construct permits the retrieval of as many of the datasets as
are required by the client in one call to the business delegate. This is true
for batch identifier processing as well as single ICN processing.
PatientServiceRequest contains a java.util.List of gov.va.med.patient
admin.common.RequestedServices. RequestedServices is an extension of an
integer Enumeration class.

Valid values are:

RequestedServices.PRIMARY_DEMOGRAPHICS
RequestedServices.SECONDARY_DEMOGRAPHICS
RequestedServices.TERTIARY_DEMOGRAPHICS RequestedServices.ADDRESS_DEMOGRAPHICS
RequestedServices.CONTACT_DEMOGRAPHICS RequestedServices.ADT
RequestedServices.ENROLLMENT_ELIGIBILITY
RequestedServices.INCOMPETENCE_INFORMATION
IPatientServiceTO Output
IPatientServiceTO:

The single identifier Patient Service Construct delegate method returns to
consuming applications, gov.va.med.patientadmin.transfer.
IpatientServiceTO.java, an interface to a J2EE transfer object.
IPatientServiceTO is the interface to a container object that contains
dataset-specific transfer objects for each of the eight datasets that may be
retrieved as well as an error message attribute.

In addition to the expected elements contained within the individual transfer
objects, IPatientServiceTO will always return an IIdentifier and IInstitution,
which are interfaces to corresponding classes.

IIdentifier
IInstitution
IPrimaryDemographicsTO
ISecondaryDemographicsTO
ITertiaryDemographicsTO
IAddressDemographicsTO
IContactDemographicsTO
IADTTO
IEnrollmentEligibilityTO
IIncompetenceInformationTO
retrieveMultiplePatients
The delegate interface method
retrieveMultiplePatients(IPatientServiceRequestpsReq,String[],icnArray) may
also be used to retrieve an individual patient by declaring an icnArray with
only one element.
VARIABLES TYPE VARIABLES DESCRIPTION
IPatientServiceRequest Input
IPatientServiceRequest:

IPatientId pid = new PatientId(ICN) or IPatientId pid = new
PatientId(ICN_V_ICN checksum)
When instantiating with an ICN, the checksum is optional.
services.java.util.List Input
services java.util.List of RequestedServices:

Patient Service Construct permits the retrieval of as many of the datasets as
are required by the client in one call to the business delegate. This is true
for batch identifier processing as well as single ICN processing.
PatientServiceRequest contains a java.util.List of
gov.va.med.patientadmin.common.RequestedServices. RequestedServices is an
extension of an integer Enumeration class.

Valid values are:

RequestedServices.PRIMARY_DEMOGRAPHICS
RequestedServices.SECONDARY_DEMOGRAPHICS
RequestedServices.TERTIARY_DEMOGRAPHICS RequestedServices.ADDRESS_DEMOGRAPHICS
RequestedServices.CONTACT_DEMOGRAPHICS RequestedServices.ADT
RequestedServices.ENROLLMENT_ELIGIBILITY
RequestedServices.INCOMPETENCE_INFORMATION
IPatientServiceTO[] Output
IPatientServiceTO[]:

The single identifier Patient Service Construct delegate method returns to
consuming applications, gov.va.med.patientadmin.transfer.
IpatientServiceTO.java, an interface to a J2EE transfer object.  An array of
Patient Service Transfer objects is returned to consumers when using batch ICN
processing.  IPatientServiceTO is the interface to a container object that
contains dataset-specific transfer objects for each of the eight datasets that
may be retrieved as well as an error message attribute.

In addition to the expected elements contained within the individual transfer
objects, IPatientServiceTO will always return an IIdentifier and IInstitution,
which are interfaces to corresponding classes.

IIdentifier
IInstitution
IPrimaryDemographicsTO
ISecondaryDemographicsTO
ITertiaryDemographicsTO
IAddressDemographicsTO
IContactDemographicsTO
IADTTO
IEnrollmentEligibility
IIncompetenceInformationTO
SUBSCRIBING PACKAGE