You are on page 1of 8

Batch Compiler XML Interface Specification

The Batch Compiler Server interprets XML in addition to a McKesson proprietary command language (IERL) to perform import processing. These XML files provide identification, format, and index information for files destined for import. Any host application or filter program used to produce source text must be able to generate XML files that are compliant with the specifications as described below. Alternatively, XML files can be created using any text editor. In addition, the host application or filter program must be configured to save the XML files and source files to directories where they can be accessed by the Batch Compiler Server.

Element Hierarchy
Batch is a group of one or more documents, each comprised of one or more pages. The batch element tags are structured in the following hierarchy.

<Batch>

<Documents>

<Document>

<Pages>

<Page>

Batch Level Elements


Tag
<BatchCompiler>

Type
Required

Description
Identifies it as a file for batch compiler. Tag should include the following: <?xml version="1.0" encoding="UTF-16"?> <BatchCompiler xsi:noNamespaceSchemaLocation="CrossRefSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Batch>

Required

Use to mark the beginning of a new batch of documents. This tag must be the first tag for each new batch of documents. Example: <Batch> </Batch>

<BQueue>

Required

Use to assign the input queue to which the batch is being sent. Example: <BQueue>RELMAGQ</BQueue>

<BLabel>

Required

Use to give a name to a batch of documents. Example: <BLabel>D-0000-0000845_0000049BWF</BLabel>

<Documents>

Required

Use to define a set of documents. Example: <Documents> <Document> </Document> <Document> </Document> </Documents>

Document Level Elements


Tag
<Document>

Type
Required

Description
Use to define a document with one or more pages Example: <Document> <Pages> </Pages> </Document>

<Pages>

Required

Use to define a set of pages within a document Example: <Pages> <Page> </Page> <Page> </Page> </Pages>

<LookUps>

Optional

Use to define a set of lookup indexes used for a specific document Example: <LookUps> <LookUp> </LookUp> </LookUps>

<LookUp>

Optional

Use to specify a lookup index name Example: <LookUp> <IndexName>ClaimsNo</IndexName> <Value>00013425</Value> </LookUp> NOTE: The lookup value must match with the claim number defined for ClaimNumber index field.

<Indexes>

Required

Use to define a set of document indexing fields and values Example: <Indexes> <Index>

Tag

Type

Description
.. </Index> <Index> . </Index> .. </Indexes> Use to specify the value for the index field in the index form The following document indexes are minimum required for encounter-centric document: Facility DocType Encounter (*) HealthQuest Business Office users The following document indexes are minimum required: DocType ClaimNumber (**) NOTE: Facility and Encounter information are not required, since they will be looked up by claim number. Human Resources Solution users: The following document indexes are minimum required: Facility DocType EmployeeNo (or ApplicantNo) (***) Examples: <Index> <Name>Facility</Name> <Value>General Hospital</Value> </Index> <Index> <Name>DocType</Name> <Value>CBO_EXPLANATION OF BENEFITS</Value> </Index> <Index> <Name>Encounter</Name> <Value>3456283</Value> </Index> <Index> <Name>EmployeeNo</Name> <Value>15467</Value> </Index> <Index> <Name>ApplicantNo</Name>

<Index>

Required

Facility (Required)

DocType (Required)

Encounter (Required)(*) EmployeeNo (Required for HR solution) ApplicantNo (Required for

Tag

Type
HR solution)

Description
<Value>15467</Value> </Index> <Index> <Name>ClaimNumber</Name> <Value>00013425</Value> </Index> NOTE: This value must match with the lookup value defined in ClaimsNo LookUp tag. <Index> <Name>DateTime</Name> <Value>Mar 15 2004 14:53:07:592</Value> </Index> <Index> <Name>SubTitle</Name> <Value>United Healthcare</Value> </Index> <Index> <Name>PageNumber</Name> <Value>0</Value> </Index>

ClaimNumber (HQ customers Required) DateTime (Optional)

SubTitle (Optional)

PageNumber (Optional)

ScanUser (Optional)

NOTE Set to 0 for Append, 1 for Insert. If the index value is not defined, Replace page option will be used. <Index> <Name>ScanUser</Name> <Value>user1</Value> </Index> <Index> <Name>IndexUser</Name> <Value>user2</Value> </Index> NOTE If ScanUser and/or IndexUser is specified, the scan and/or index user activity will be audited.

IndexUser (Optional)

Page Level Elements


Tag
<Page>

Type
Required

Description
Use to define a page within a document Example: <Page> </Page>

<PType>

Required

Use to identify the page as an ASCII text file or a bitmap. RAW - a bitmapped graphic ASCII ASCII text Example: <PType>RAW</PType>

<PLoc>

Rrequired

Use to indicate the location information, either in the source file or in a separate DOS file. DOS - indicate that the image file is located in a separate DOS file Example: <PLOC>DOS</PLOC>

<PData>

Required

Use to indicate that the next line contains page location information for the separate DOS file Example: <PData>c:\test\52.tif</PData>

Example 1: Medical Record Document Batch


<?xml version="1.0" encoding="UTF-16"?> <BatchCompiler xsi:noNamespaceSchemaLocation="CrossRefSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Batch> <BQueue>RELMAGQ</BQueue> <BLabel>01242003_045</BLabel> <Documents> <Document> <Pages> <Page> <PType>RAW</PType> <PLOC>DOS</PLOC> <PData>d:\GEH\012242003\045\13425_3.tif</PData> Page section </Page> <Page> <PType>RAW</PType> <PLOC>DOS</PLOC> <PData>d:\GEH\012242003\045\13425_4.tif</PData> </Page> </Pages> <Indexes> Document index <Index> information <Name>Facility</Name> <Value>North Hospital</Value> </Index> <Index> <Name>DocType</Name> <Value>HISTORY AND PHYSICAL</Value> </Index> <Index> <Name>Encounter</Name> <Value>13425</Value> </Index> <Index> <Name>DateTime</Name> <Value>Mar 15 2004 14:53:07:592</Value> </Index> </Indexes> </Document> </Documents> </Batch> </BatchCompiler>

Example 2: EOB batch, requiring claim cross-reference to index documents


<?xml version="1.0" encoding="UTF-16"?> <BatchCompiler xsi:noNamespaceSchemaLocation="CrossRefSchema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Batch> <BQueue>RELMAGQ</BQueue> <BLabel>D-0000-0000845_0000049BWF</BLabel> <Documents> <Document> <LookUps> <LookUp> Request Batch <IndexName>ClaimsNo</IndexName> Compiler to look up an <Value>00002456</Value> encounter by claim </LookUp> number </LookUps> <Pages> <Page> <PType>RAW</PType> <PLOC>DOS</PLOC> <PData>c:\test\50.tif</PData> </Page> <Page> <PType>RAW</PType> <PLOC>DOS</PLOC> <PData>c:\test\52.tif</PData> </Page> </Pages> <Indexes> <Index> <Name>DocType</Name> <Value>CBO_EXPLANATION OF BENEFITS</Value> </Index> Claim number index <Index> field and value <Name>ClaimNumber</Name> <Value>2456</Value> </Index> <Index> <Name>DateTime</Name> <Value>Mar 15 2004 14:53:07:592</Value> </Index> <Index> <Name>SubTitle</Name> <Value>United Healthcare</Value> </Index> </Indexes> </Document> </Documents> </Batch> </BatchCompiler>