All ICR List

Package: 769 ICR List

IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
4619 DBIA4619 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
patient specific and common order entry data to VistA for the purpose of
creating VBECS orders for blood products and diagnostic tests performed in the
Blood Bank.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Patient.dfn Patient.VistaPatientId
Patient.firstName Patient.PatientFirstName
Patient.lastName Patient.PatientLastName
Patient.abo fnGetAbo(Patient.PatientGuid)
Patient.rh fnGetRh(Patient.PatientGuid)
TransfusionReaction.type TransfusionReactionType.TransfusionReactionTypeText
TransfusionReaction.date
fnDateTimeConversionToHL7DateTime(PatientTransfusionReaction.NotedDateTim e
)
TransfusionRequirement.modifier
PatientTransfusionRequirement.TransfusionRequirementText
Antibody.name AntibodyType.AntibodyTypeName
Unit.status UnitStatus.UnitStatusCode OR
DonationType.RestrictionTypeCode
Unit.id BloodUnit.EyeReadableUnitId
Unit.product ProductType.ProductTypePrintName
Unit.location VamcDivision.DivisionName
Unit.expDate
fnDateTimeConversionToHL7DateTime(BloodUnitMedia.UnitExpirationDate)
Specimen.expDate
fnDateTimeConversionToHL7DateTime(PatientSpecimen.SpecimenExpirationDate)
Specimen.uid PatientSpecimen.SpecimenUid
Component.name ComponentClass.ComponentClassShortName
Component.id ComponentClass.CprsOrderableItemId
Component.specimen ComponentClassParameter.SpecimenRequiredIndicator
LabTest.id SpecimenTestThreshold.LabTestId
LabTest.name SpecimenTestThreshold.VistALaboratoryTestName
Msbos.name Msbos.SurgeryName
Msbos.threshold MsbosComponentClass.MaximumSetupUnitQuantity
Surgery.name Msbos.SurgeryName
Function Description:
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
fnDateTimeConversionToHL7DateTime - This function converts a SQL DateTime
data type to HL7 format.
XML Example:
<?xml version="1.0" encoding="utf-8" ?>
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
ssn="000000000" abo=A"" rh="P">
<TransfusionReactions>
<TransfusionReaction type="Acute Hemolytic"
date="20010101120035-0600" />
</TransfusionReactions>
<TransfutionRequirements>
<TransfusionRequirement modifier="Washed RBC products">
<Antibodies>
<Antibody name="Anti-E" />
</Antibodies>
<Units>
<Unit status="C" id="04215" product="RBC" location="4E"
expDate="20010103115535-0600" />
</Units>
<Specimen expDate="20010115115535-0600" uid="1234567890" />
</Patient>
<Components>
<Component name="RED BLOOD CELLS" id="2" specimen="R">
<LabTests>
<LabTest id="320" name="HGB" />
</LabTests>
<MsbosList>
<Msbos name="Esophogectomy" threshold="5" />
</MsbosList>
</Component>
</Components>
<Surgeries>
<Surgery name="Esophogectomy" />
</Surgeries>
</BloodBank>
4620 DBIA4620 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a list of Blood Units associated with a patient.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Patient.dfn Patient.VistaPatientId
Patient.firstName Patient.PatientFirstName
Patient.lastName Patient.PatientLastName
Patient.dob
fnPatientDobConversionToFileManDateTime(Patient.PatientGuid)
Patient.ssn Patient.PatientSsn
Patient.abo fnGetAbo(Patient.PatientGuid)
Patient.rh fnGetRh(Patient.PatientGuid)
Unit.status DonationType.RestrictionTypeCode
Unit.id BloodUnit.EyeReadableUnitId
Unit.product ProductType.ProductTypeName
Unit.productCode BloodProduct.ProductCode
Unit.abo BloodUnitMedia.BloodTypeCode
Unit.rh BloodUnitMedia.RhFactorCode
Unit.volume BloodUnit.OriginalVolume
Unit.dateAssigned
fnDateTimeConversionToFileManDateTime(OrderedUnit.SelectedDate)
Unit.divisionCode VamcDivision.DivisionCode
Unit.location IssuedUnit.IssueToLocation
Unit.expDate
fnDateTimeConversionToFileManDateTime(BloodUnitMedia.UnitExpirationDate)
fnPatientDobConversionToFileManDateTime - This function returns the patient's
date of birth in FileMan format based on the patient unique identifier in the
VBECS database.
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
fnDateTimeConversionToFileManDateTime - This function converts a SQL DateTime
data type to FileMan format.
XML Example:
<?xml version="1.0" encoding="utf-8" ?>
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient" dob="19500101"
ssn="000000000" abo="A" rh="P" />
<Units>
<Unit status="C" id="04215" product="RBC" productCode="E0335" abo="A"
rh="P" volumn="250" dateAssigned="20010430115535-0600" divisionCode="589"
location="4E" expDate="20010430115535-0600" />
</Units>
</BloodBank>
4621 DBIA4621 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA application with a list of Transfusions given to a patient.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Patient.dfn Patient.VistaPatientId
Patient.firstName Patient.PatientFirstName
Patient.lastName Patient.PatientLastName
Patient.dob
fnPatientDobConversionToFileManDateTime(Patient.PatientGuid)
Patient.ssn Patient.PatientSsn
Patient.abo fnGetAbo(Patient.PatientGuid)
Patient.rh fnGetRh(Patient.PatientGuid)
Transfusion.date
fnDateTimeConversionToFileManDateTime(PatientTransfusion.TransfusinoEndDat
eTime)
Transfusion.unitsPooled BloodUnit.PooledUnitsCount
Transfusion.productTypeName ProductType.ProductTypeName
Transfusion.productTypePrintName ProductType.ProductTypePrintName
Function Description:
fnPatientDobConversionToFileManDateTime - This function returns the patient's
date of birth in FileMan format based on the patient unique identifier in the
VBECS database.
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
fnDateTimeConversionToFileManDateTime - This function converts a SQL DateTime
data type to FileMan format.
XML Example:
<Bloodbank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
dob="19500101" ssn="000000000" abo="A" rh="P">
<Transfusions>
<Transfusion date="20000101115535-0600" unitsPooled="3"
productTypeName="RED BLOOD CELLS" productTypePrintName="RBC" />
</Transfusions>
</Patient>
</Bloodbank>
4622 DBIA4622 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a list of Blood Products, or Component Classes, that
can be ordered for a patient.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
ComponentClass.name ComponentClass.ComponentClassName
ComponentClass.shortName ComponentClass.ComponentClassShortName
XML Example:
<ComponentClasses>
<ComponentClass name="RED BLOOD CELLS" shortName="RBC" />
<ComponentClass name="FRESH FROZEN PLASMA" shortName ="FFP" />
<ComponentClass name="CRYOPRECIPITATE" shortName ="CRYO" />
<ComponentClass name="PLATELETS" shortName ="PLT" />
<ComponentClass name="OTHER" shortName ="OTHER" />
<ComponentClass name="WHOLE BLOOD" shortName ="WB" />
</ComponentClasses>
4623 DBIA4623 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a list of Blood Bank patient diagnostic testing
results, blood products requested, and blood units associated with a patient.
XML Mapping:
____________
XML Element.Attribute / VBECS SQL Table.Column or Function
Patient.dfn / Patient.VistaPatientId
Patient.firstName / Patient.PatientFirstName
Patient.lastName / Patient.PatientLastName
Patient.dob / fnPatientDobConversionToFileManDateTime(Patient.PatientGuid)
Patient.ssn / Patient.PatientSsn
Patient.abo / fnGetAbo(Patient.PatientGuid)
Patient.rh / fnGetRh(Patient.PatientGuid)
SpecimenTest.printTestName / BloodTestType.BloodTestName
SpecimenTest.orderableTestName / OrderableTest.OrderableTestName
SpecimenTest.result / TestResult.TestResultText
SpecimenTest.testDate /
fnDateTimeConversionToFileManeDateTime(SpecimenTest.TestDate)
SpecimenTest.cprsOrderId / PatientOrder.OrderGroupNumber
SpecimenTest.divisionCode / SpecimenTest.DivisionCode
SpecimenTest.enteringTechId / VbecsUser.UserDuz
SpecimenTest.requestorId / PatientOrder.OrderingProviderId
SpecimenTestComments / InformationMessage.InformationMessageText
ComponentRequest.dateRequested /
fnDateTimeConversionToFileManDateTime(PatientOrder.orderPlacedDatetime)
ComponentRequest.dateWanted /
fnDateTimeConversionToFileManDateTime(OrderedComponent.RequiredDatetime)
ComponentRequest.unitsRequested / OrderedComponent.RequiredUnitQuantity
ComponentRequest.cprsOrderId / PatientOrder.OrderGroupNumber
ComponentRequest.componentClassName / ComponentClass.ComponentClassName
ComponentRequest.componentClassShortName /
ComponentClass.ComponentClassShortName
ComponentRequest.requestorId / PatientOrder.OrderingProviderId
ComponentRequest.enteredById / PatientOrder.OrderEnteredById
Unit.status / UnitStatus.UnitStatusCode
Unit.id / BloodUnit.EyeReadableUnitId
Unit.product / ProductType.ProductTypePrintName
Unit.abo / BloodUnitMedia.BloodTypeCode
Unit.rh / BloodUnitMedia.RhFactorCode
Unit.divisionCode / BloodUnit.DivisionCode
Unit.location / IssuedUnit.LocationIen
Unit.expDate /
fnDateTimeConversionToFileManDateTime(BloodUnitMedia.UnitExpirationDate)
Function Description:
_____________________
fnPatientDobConversionToFileManDateTime - This function returns the patient's
date of birth in FileMan format based on the patient unique identifier in the
VBECS database.
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
fnDateTimeConversionToFileManDateTime - This function converts a SQL DateTime
data type to FileMan format.
XML Example:
____________
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
dob="19500101" ssn="000000000" abo="A" rh="P">
<SpecimenTests>
<SpecimenTest printTestName="ABO Interp"
orderableTestName="ABO/Rh" result="A" testDate="20030101115535-0600"
cprsOrderId="12345" divisionCode="589" enteringTechId="5335"
requestorId="3553">
<SpecimenTestComments></SpecimenTestComments>
</SpecimenTest>
</SpecimenTests>
<ComponentRequests>
<ComponentRequest dateRequested="20030101115535-0600"
dateWanted="20030102" cprsOrderId="12346" componentClassName="RED BLOOD CELLS"
componentClassShortName="RBC" requestorId="3553" enteredById="3553"
/>
</ComponentRequests>
<Units>
<Unit status="C" id="04215" product="RBC" abo="A" rh="P"
divisionCode="589" location="4E" expDate="20030103115535-0600" />
</Units>
</Patient>
</BloodBank>
4624 DBIA4624 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a patient's current ABO Blood Group and Rh Type.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Patient.dfn Patient.VistaPatientId
Patient.firstName Patient.PatientFirstName
Patient.lastName Patient.PatientLastName
Patient.dob
fnPatientDobConversionToFileManDateTime(Patient.PatientGuid)
Patient.ssn Patient.PatientSsn
Patient.abo fnGetAbo(Patient.PatientGuid)
Patient.rh fnGetRh(Patient.PatientGuid)
Function Description:
fnPatientDobConversionToFileManDateTime - This function returns the patient's
date of birth in FileMan format based on the patient unique identifier in the
VBECS database.
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
XML Example:
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
dob="19500101" ssn="000000000" abo="A" rh="P" />
</BloodBank>
4625 DBIA4625 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a list of antibodies identified for a patient.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Patient.dfn Patient.VistaPatientId
Patient.firstName Patient.PatientFirstName
Patient.lastName Patient.PatientLastName
Patient.ssn Patient.PatientSsn
Patient.abo fnGetAbo(Patient.PatientGuid)
Patient.rh fnGetRh(Patient.PatientGuid)
Antibody.name AntibodyType.AntibodyTypeName
Antibody.comment InformationMessage.InformationMessageText
Function Description:
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
XML Example:
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
dob="19500101" ssn="000000000" abo="A" rh="P" >
<Antibodies>
<Antibody name="Anti-E" comment="Unexpected Antibody Detected:
Preparation of red cell components for transfusion may be delayed due to the
presence of serum red cell specific antibody(ies), which may require antigen
negative red cell components. Contact transfusion service for information on
potential clinical significance and availability of red cell components." />
</Antibodies>
</Patient>
</BloodBank>
4626 DBIA4626 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
VistA applications with a list of Transfusion Reactions associated with a
patient.
XML Mapping:
____________
XML Element.Attribute / VBECS SQL Table.Column or Function
Patient.dfn / Patient.VistaPatientId
Patient.firstName / Patient.PatientFirstName
Patient.lastName / Patient.PatientLastName
Patient.dob / fnPatientDobConversionToFileManDateTime(Patient.PatientGuid)
Patient.ssn / Patient.PatientSsn
Patient.abo / fnGetAbo(Patient.PatientGuid)
Patient.rh /fnGetRh(Patient.PatientGuid)
TransfusionReaction.type /
TransfusionReactionType.TransfusionReactionTypeText
TransfusionReaction.date /
fnDateTimeConversionToFileManDateTime(PatientTransfusionReaction.NotedDate
Time)
TransfusionReaction.unitId / BloodProduct.EyeReadableUnitId
TransfusionReaction.productTypeName / ProductType.ProductTypeName
TransfusionReaction.productTypePrintName / ProductType.ProductTypePrintName
TransfusionReaction.comment /
PatientTransfusionComment.PatientTransfusionCommentText
Function Description:
_____________________
fnGetAbo - This function returns the patient's current ABO Group.
fnGetRh - This function returns the patient's current Rh Type.
fnDateTimeConversionToFileManDateTime - This function converts a SQL DateTime
data type to FileMan format.
XML Example:
____________
<BloodBank>
<Patient dfn="5000" firstName="One" lastName="VBECSpatient"
dob="19500101" ssn="000000000" abo="A" rh="P" >
<TransfusionReactions>
<TransfusionReaction type="Acute Hemolytic"
date="20000101113555-0600" unitId="04215" productTypeName="RED BLOOD CELLS"
productTypePrintName="RBC" comment="The patient is also experiencing severe
headaches.">
</TransfusionReactions>
</Patient>
</BloodBank>
4627 DBIA4627 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
Blood Bank related workload data to VistA for workload reporting.
XML Mapping:
XML Element.Attribute VBECS SQL Table.Column or Function
_____________________ __________________________________
Transaction.id WorkloadEvent.WorkloadEventGuid
Transaction.type VbecsProcess.TransactionType
Transaction.division WorkloadEvent.DivisionCode
Transaction.accessionArea VamcDivision.AccessionAreaId
Transaction.dateTime
fnDateTimeConversionToFileManDateTime(WorkloadEvent.WorkloadEventDate)
Transaction.status WorkloadEvent.WorkloadEventStatusCode
Workload.code WorkloadProcess.WorkloadCode
Workload.multiplyFactor WorkloadEvent.WeightMultiplier
Patient.dfn Patient.VistaPatientId
VbecsUser.duz VbecsUser.UserDuz
Lab.accessionNumber OrderedTest.SpecimenWorkloadUid OR
OrderedComponent.SpecimenWorkloadUid
Lab.testPerformed OrderedTest.LabTestId OR
OrderedComponent.LabTestId
Unit.id BloodUnit.UnitProductCode
Note:
Transaction.type is a conditional code where the values can be
one of the following depending on the type of workload event being
returned.
U = Unit
P = Patient
M = Miscellaneous
The WorkloadEventStatusCode is always P for 'Pending Processing'.
Function Description:
fnDateTimeConversionToFileManDateTime - This function converts a SQL DateTime
data type to FileMan format.
XML Example:
<WorkloadTransactions>
<Transaction id="28711464-EFB3-453E-8B8A-025BA85CCD10" type="U"
division="589" accessionArea="29" dateTime="20030101113555-0600" status="P">
<Workload code="86832.0000" multiplyFactor="1" />
<VbecsUser duz="53555" />
<Lab accessionNumber="2930160023" testPerformed="6478" />
</Transaction> </WorkloadTransactions>
4628 DBIA4628 Other 769 2005/05/17 APPROVED Active Private
The purpose of this Integration Agreement is to provide
a bi-directional data exchange between the rehosted gov.va.med.vbecs Blood
Bank software application and the VistA Laboratory VBECS application to update
workload event data in the rehosted SQL Server database as well as the VistA
VBECS WORKLOAD CAPTURE file (#6002.01). The VistA Laboratory VBECS application
will initiate the data exchange.
XML Mapping of input XML Message:
_________________________________
{XML Element.Attribute / VBECS SQL Table.Column or Function / Field in file
#6002.01}
WorkloadEvent.WorkloadEventGuid / WorkloadEvent.WorkloadEventGuid /
TRANSACTION ID (#.01)
WorkloadEvent.WorkloadEventStatusCode / WorkloadEvent.WorkloadEventStatusCode
/ STATUS (#5)
WorkloadEvent.ProcessedDate /
fnFileManDateTimeConversionToDateTime(WorkloadEvent.ProcessedDate) / PROCESSED
DATE (#4)
WorkloadEvent.ErrorText / WorkloadEvent.ErrorText / ERROR TEXT (#20)
WorkloadEvent.PceEncounterNumber / WorkloadEvent.PceEncounterNumber / PCE
ENCOUNTER (#99)
Function Description:
_____________________
fnFileManDateTimeConversionToDateTime - This function converts a FileMan
datetime type to a SQL datetime type.
Input XML Example:
__________________
This XML message is sent from the VistA Laboratory VBECS software when VBECS
workload data has been
updated by the Lab package.
<WorkloadEvents>
<WorkloadEvent>
<WorkloadEventGuid>28711464-EFB3-453E-8B8A-025BA85CCD10 </WorkloadEventGuid>
<WorkloadEventStatusCode>S</WorkloadEventStatusCode>
<ProcessedDate>3020101</ProcessedDate>
<ErrorText></ErrorText>
<PceEncounterNumber>55566666</PceEncounterNumber>
</WorkloadEvent>
</WorkloadEvents>
XML Mapping of Output XML Message:
__________________________________
{XML Element.Attribute / VBECS SQL Table.Column or Function / Field in file
#6002.01}
WorkloadEvent.id / WorkloadEvent.WorkloadEventGuid / TRANSACTION ID (#.01)
WorkloadEvent.successfullyUpdate /
WorkloadEvent.WorkloadEvent.WorkloadEventStatusCode / STATUS (#5)
WorkloadEvent.ErrorText / WorkloadEvent.ErrorText / ERROR TEXT (#20)
Output XML Example:
___________________
This XML message is returned from the rehosted gov.va.med.vbecs software to
update the VBECS WORKLOAD
CAPTURE file (#6002.01).
<WorkloadEvents>
<WorkloadEvent id="28711464-EFB3-453E-8B8A-025BA85CCD10"
successfullyUpdated="S" >
<ErrorText></ErrorText>
</ WorkloadEvent >
</WorkloadEvents>