Food Safety and Inspection Service (FSIS)

United States Department of Agriculture (USDA)

Public Health Information System (PHIS)

Export Batch User Guide

June 2022
Public Health Information System (PHIS) Export Batch User Guide

ii

Contents

Introduction............................................................................................................................................... 6

Methods for Transferring Batch Files .................................................................................................... 7

Process Flow .............................................................................................................................................. 7

PHIS Pre-Processing Steps ..................................................................................................................... 8

PHIS Processing and Application Creation Steps................................................................................... 8

PHIS Submission Steps........................................................................................................................... 8

PHIS Review and Approval Steps .......................................................................................................... 9

PHIS Status ............................................................................................................................................. 9

Updates.................................................................................................................................................... 9

PHIS Milestones.................................................................................................................................... 10

Batch Upload through PHIS User Interface ........................................................................................ 10

Upload Files .......................................................................................................................................... 10

Batch Results......................................................................................................................................... 12

Manage Service Accounts..................................................................................................................... 13

Data File Specifications .......................................................................................................................... 14

XML Assumptions................................................................................................................................ 14

XSD....................................................................................................................................................... 14

Application Number vs. Certificate Number..................................................................................... 15

Data Size............................................................................................................................................ 15

Structures............................................................................................................................................... 15

Envelope ............................................................................................................................................ 15

Export Application 9060 ................................................................................................................... 16

Export Application 9060 Cancel ....................................................................................................... 23

Export Application 9060 Basic.......................................................................................................... 24

Export Application 9060 Update....................................................................................................... 24

Export Application 9060 Replacement.............................................................................................. 30

Export Application 9060 Paper Replacement ................................................................................... 36

Export Application 9060 Consolidate Replacement ......................................................................... 42

Export Application 9060 Split Replacement..................................................................................... 49

Export Application 9060 Product...................................................................................................... 54

Export Application 9060 Product Replacement ................................................................................ 58

Attachment......................................................................................................................................... 61
Public Health Information System (PHIS) Export Batch User Guide

iii

Container ........................................................................................................................................... 62

PHIS ID ............................................................................................................................................. 62

Permission ......................................................................................................................................... 62

Access Control................................................................................................................................... 62

Address.............................................................................................................................................. 63

Applicant ........................................................................................................................................... 64

Application Number .......................................................................................................................... 64

Import/Export Entity.......................................................................................................................... 65

Weight ............................................................................................................................................... 65

Service Accounts ..................................................................................................................................... 66

Creating and Accepting NDA/ISA Agreement..................................................................................... 66

Creating and Modifying Service Accounts........................................................................................... 68

Limits on Service Account Access........................................................................................................ 68

Modifying NDA/ISA............................................................................................................................. 69

Service Call Log.................................................................................................................................... 69

Creating a Software Application for Web Service Connections........................................................... 69

Access to Application Records............................................................................................................... 70

PHIS ID................................................................................................................................................. 71

Application Access Control .................................................................................................................. 71

Export Brokers ...................................................................................................................................... 73

Appendix A – Additional Files............................................................................................................... 74

Appendix B – Common Error Messages .............................................................................................. 75

Appendix C – Batch Defined Values..................................................................................................... 79

Certification Statement – <ICertifyStatement> .................................................................................... 79

HACCP Categories - <HaccpCategory>............................................................................................... 79

Access Control Type - <Type>............................................................................................................. 79

Access Control Permission – Permission.............................................................................................. 80

Replacement Reason - <ReasonForReplacement> ............................................................................... 80

Package Type - <TypeOfPackagesInLot> ............................................................................................ 80

Species - <Species>............................................................................................................................... 82

USDA Export Mark - <UsdaExportMark>........................................................................................... 82

Attachment Type - <Type>................................................................................................................... 83

Subtype - <Subtype>............................................................................................................................. 83

Shipment Type - <ShipmentType>....................................................................................................... 84
Public Health Information System (PHIS) Export Batch User Guide

iv

Appendix D: Sample SOAP Request .................................................................................................... 85

Export Batch machine-to-machine request format................................................................................ 85

Appendix E: Service Calls and Responses............................................................................................ 88
Public Health Information System (PHIS) Export Batch User Guide

v

Table of Figures

Figure 1 - Upload File Page ...................................................................................................................... 11

Figure 2 - Batch Results Page................................................................................................................... 12

Figure 3 - Service Accounts Main Page ................................................................................................... 13

Figure 4 - NDA/ISA Agreement Page ...................................................................................................... 66

Figure 5 - NDA/ISA Agreement (New) Page........................................................................................... 67

Figure 6 - Service Account Page .............................................................................................................. 68

Figure 7 - Configuration Tab to Access the NDA/ISA............................................................................. 69

Figure 8 - Application Access Control for Applications Online .............................................................. 71

Figure 9 - User Search for Access Control ............................................................................................... 72

Figure 10 - Setting Access Control Levels............................................................................................... 73
Public Health Information System (PHIS) Export Batch User Guide

6

Introduction

The PHIS Batch process allows you to create and update PHIS export applications by:

• Uploading export application data via individual XML files

• Uploading export application packages that include XML application files and associated 

supplemental PDF documents as a zip file

• Uploading export application data via individual Excel files

• Uploading export application packages that include the Excel application files and associated 

supplemental PDF documents as a zip file

There are two options for uploading (or transferring) the files to PHIS:

• Machine-to-machine (XML only) 

• PHIS Interface (XML and Excel)

These options provide flexibility for different-sized establishments and various corporate structures to 

manage PHIS export applications. 

Using the machine-to-machine option (via a web service) requires that you:

• Have an eAuthentication account with a completed identity verification

• Register for a Service Account in PHIS (requires either the Export Broker or Export Applicant 

role)

Using the PHIS Interface requires that you:

• Have an eAuthentication account with a completed identity verification

• Have either the Export Broker or Export Applicant role

Once the file(s) are uploaded, the batch processor operates the same as the online process. As the 

process reaches certain milestones, status updates are recorded within PHIS. Batch result updates are 

available by:

• An Application Program Interface (API) call from the web service

• The Batch Results page in PHIS

• Email messages from the application (the application sends messages to the email addresses 

referenced in the XML or Excel files)

• For information about other calls you can make from the web service, see Appendix D: Sample 

SOAP Request and Appendix E: Service Calls and Responses starting on page 85
Public Health Information System (PHIS) Export Batch User Guide

7

Methods for Transferring Batch Files 

Two methods are available to transfer Batch files to PHIS:

Method 1: Machine-to-machine

Applicant system connects to the web service, which results in the following events happening:

• eAuthentication procedure

• File(s) transferred 

• Logging process begins

Method 2: PHIS Interface

Applicant logs into PHIS 

• Opens the Batch Processing menu

• Selects Upload Files and follows steps to upload the file(s)

• Logging process begins

Process Flow

The batch application process follows many of the same steps as the online process. You still need to 

collect the necessary information to create the application, but rather than entering the information 

online via the PHIS application, you enter the data into a local system that then creates an application 

file. The created application file provides data for the following pages/tabs in PHIS:

• My Establishment 

• Application Type

• Export Country Information

• Import Country Information

• Products Summary

• Shipment Information

• Access Control

• Statements 

• Submission for Approval

Files can be .xml, xlsx, or .xls.

The XML file contains:

• Application envelope (the beginning and end of the xml message, mandatory element)

• Product data

• Access control information

The Excel file (either .xlsx or .xls) contains the following tabs:

• Instructions (Do not edit information on this tab.)

• Version (Do not edit information on this tab.)

• Overall 

• Access Control 

• Application 
Public Health Information System (PHIS) Export Batch User Guide

8

• Statements

• Custom Placeholders

• Container 

• Importer & Exporter 

• Attachments

• Products 

PHIS Pre-Processing Steps

Once the files are transferred, PHIS performs the following steps:

• Export Batch Pre-Processor

o Receives the files from the web service

o Evaluates the file types

▪ Verifies the files are .xml, .xls, .xlsx, or .zip

▪ Generates email response, if applicable

▪ For the PHIS Interface process, PHIS displays status messages in real-time

o Unpacks the zip files (if applicable)

▪ Zip files are required for PDF attachment files

▪ At least one XML or Excel file must be included in each zip file 

▪ Zip files can contain multiple application XML and Excel files and associated 

PDFs

o Extracts data from the XML or Excel file

▪ Stores application data in a temporary location

▪ Verifies the PDF attachment exists if referenced in the batch file

PHIS Processing and Application Creation Steps

When the Pre-Processing milestone is successful, the system uses the Batch Application Processor to 

create one or more applications in PHIS based on the information from the XML/Excel file(s). 

• Batch Application Processor

o Processes application data, including:

▪ Identity data (ApplicationUID/Application Number/Applicant Name/Notification 

Email)

▪ Access control information

▪ Exporter information

▪ Importer information

o Processes the product data

▪ Processes each product individually

o Submit Flag

▪ Application can be marked for submission (Submit=true or 1) or added with a 

status of Unsubmitted (Submit=false or 0)

Note: The Submit flag is case-sensitive and it must be in all lowercase letters. The 

next section explains more about how to submit an application for approval.

PHIS Submission Steps

As PHIS finishes with the processing step, PHIS notes if the Submit flag in the file is set to true or false

(or 1 or 0). If false, PHIS adds the application as an unsubmitted application; otherwise, PHIS starts the 
Public Health Information System (PHIS) Export Batch User Guide

9

submission steps. These steps are analogous to selecting the Submit button on the Submit Application 

page in the user interface.

• Submission

o All required application fields are populated

o All required product fields are populated

o Product information, together with other information, is validated against published Rule 

Sets in the PHIS Export Library.

If the submission process is successful and the Submit flag is true or 1, PHIS changes the status of the 

application to Submitted. If the submission process is not successful, PHIS still creates the application, 

but the status is Unsubmitted.

PHIS Review and Approval Steps

The review and approval steps for export applications are the same regardless of how the applications 

were created.

PHIS Status 

Successfully created applications are viewable from the Create/View 9060-6 Export Applications page. 

If you are an Export Broker or an Export Applicant, this page includes only the applications and 

certificates that you can access based on the Access Control page of the record. 

On the 9060 grid, PHIS lists the status of the applications and other attributes but does not indicate how 

the applications were created. However, after selecting an application to view or edit from the 9060 grid, 

a History tab is available that displays user information, date, and time stamps for the following actions: 

• Create

• Submit

• Update

• Unlock

When applicable, PHIS indicates when those actions were processed through the batch function. 

Updates

You can edit unsubmitted applications via the:

• User interface

• Transfer of updated application records by manual file uploads via the batch function

• Transfer of updated application records by machine-to-machine file uploads via the batch 

function

For all applications with a status of Submitted, PHIS creates inspection tasks for FSIS personnel.

Limited updates to a submitted application can be made up until the final approval by FSIS by unlocking 

the application. Applications with statuses of Submitted, Reviewed by CSI, and Signed by 1st PHV can 

be unlocked, edited, and re-submitted via the user interface or transfer of updated applications via batch 

upload or machine-to-machine. Please notify your FSIS In-Plant Personnel (IPP) of any updates you 

make to the application after the first Submittal action. Statuses that do not allow updates, with a few 

exceptions, include: Pending Upload, Approved, Pending Replacement, Replaced, and Rejected.
Public Health Information System (PHIS) Export Batch User Guide

10

The updates that are allowed up until final approval (Statuses = Pending Upload and Approved) include: 

Exporter and Importer data, Product Name(s), weights and numbers of packages, slaughter and 

processing establishments, Total Net Weight, container, seal, and Port of Entry values. Additional 

updates include, adding or removing statements and custom placeholder data, selecting or deselecting

PHIS generated statements for replacements and unique identifier. For replacement type applications, 

values for Total Net Weight, product weight and number of packages can be only reduced in value.

Submitted Applications with unopened task are fully updatable.

Most countries allow you to edit the seal and container information, even after the application is 

Approved. You cannot update the seal and container information for certificates that are pending 

replacement (Status = Pending Replacement), have been replaced (Status = Replaced) or applications 

that have been rejected (Status = Rejected). Some importing countries require that additional data values 

are completed at the time of approval. For example, before approval by FSIS, applications to export 

product to China, Commercial Seal and Container data values are required to be present when the 

application receives its final review prior to a FSIS PHV approving the record and signing the 

Certificate.

PHIS Milestones 

When the processing is complete, you can view the milestones of your file transfers through several

methods. 

The first such method is email. If you included email addresses in your files, PHIS sends status emails

for every failed application. Only one email address is allowed per XML or Excel file. PHIS may send 

multiple email messages for a failed application as the system reviews the application at several 

processing stages. For each set of successful applications transferred over a 24-hour period, PHIS sends 

a summary email with a list of all the successfully transferred applications. 

The second method is the Batch Results page. The Batch Results page in PHIS displays the upload and 

creates a log of the processing details for each file transfer. 

The third method is a web-service API call. You can request the status information for a specific batch 

ID by using web service API call. The web service returns the batch ID as part of the return information 

once the file upload process concludes. For more information about calls you can make from the web 

service, see Appendix D: Sample SOAP Request and Appendix E: Service Calls and Responses starting 

on page 85

Batch Upload through PHIS User Interface

Upload Files

The Upload Files page (Figure 1) has options to:

• Download the Statements Record CSV file for country-specific Statement Records by selecting 

one or more Importing Countries from the drop-down list. The downloaded Excel file contains 

Statement Record Codes and other information like Statement Name, Species, and country. 

When you insert a Statement Record Code into a batch file, the code instructs PHIS to include 

one of the importing country’s statements. Some Statement records also require additional data 

values that are required by the importing country. The Statement Record CSV file has a second 

worksheet that contains Statement Record Codes and related Unknown/Custom Placeholder 
Public Health Information System (PHIS) Export Batch User Guide

11

Codes with defined data types, sample values, and any associated elements required for 

placeholder data validations that apply.

• Download the Export Batch Schema XSD to create well-formed XML files. 

• Download the Export Batch Schema Excel File to create well-formed Excel files. 

• Select a file or files to upload to PHIS. Multiple files can be selected at a time when choosing 

files to upload. Like the web service (used for machine-to-machine communication), only XML, 

Excel, and zip files can be uploaded. The PDF files must be in a zip file to be uploaded. A 

maximum of 5 MB is enforced for each file in the zip file, while the zip file itself should not be 

larger than 25 MB. Multiple PDFs can be included for each application as long as those attached 

PDF files are identified within the corresponding XML or Excel files.

Figure 1 - Upload File Page
Public Health Information System (PHIS) Export Batch User Guide

12

Batch Results

The Batch Results page provides a view of all the attempted batch application file uploads that passed 

the first critical milestone of having the application Global Universal ID (GUID) read. The results are 

recorded in Central Time.

Figure 2 - Batch Results Page

The Batch Results page includes the following functions:

1. Filter by date, file name, establishment, and/or Application UID (unique identifier generated 

specifically for each application in forming the batch file) and Batch ID, Application ID, or 

Application Number, all assigned by PHIS.

2. Filter by method by which the files were transferred to PHIS

3. Filter records with and/or without errors
Public Health Information System (PHIS) Export Batch User Guide

13

4. Download batch file submitted for processing along with milestone log files with details of any 

errors recorded at the record, application, and product levels

5. Ability to directly access the application created through a hyperlink

6. Ability to view the 9060 application status

7. Establishment number and name display with batch result records under App. Info

8. Ability to expand batch record and display application record on one page

A list of common error messages is available in Appendix B – Common Error Messages.

If you uploaded an XML/Excel file, but do not see a corresponding entry on the Batch Results page, this 

may be because you were not granted access in the Access Control section of the XML/Excel file.

Manage Service Accounts

The service administrator uses the Manage Service Accounts page to complete the Non-Disclosure 

Agreement/Interconnection Security Agreement (NDA/ISA) agreement required for machine-tomachine communication and to set up the service accounts and settings. Any active user with Export 

Applicant or Export Broker role can create a service account on behalf of their organization.

Figure 3 - Service Accounts Main Page

Details on completing the NDA/ISA and setting up service accounts are provided in a later section of the 

guide (see page 66).
Public Health Information System (PHIS) Export Batch User Guide

14

Data File Specifications

Data files must conform to certain specifications to be accepted by the system.

• Application files are in XML or Excel

• Files can perform different functions:

o Create a new application

o Update an existing application

o Cancel an existing application

o Perform certificate replacement functions:

▪ One-to-one

▪ Split

▪ Consolidation

• Rules

o Follow the XSD validation

▪ The XSD allows creation of incomplete applications 

▪ Product fields are required for submission

o Excel files do not have an XSD, but the system performs a set of similar data validations

XML Assumptions

In processing XML files to create 9060 applications in PHIS for review and approval, the following 

assumptions are made:

• XML, Excel, and zip files are uploaded through a web service accessible through a PHIS user 

interface (human-to-machine interaction) or through a programmatic interface (machine-tomachine interaction).

• You can upload an incomplete application based on the assumption that an updated XML/Excel

will be uploaded later or that updates will be made through the PHIS user interface to complete 

any outstanding information.

• After submitting properly formed XML/Excel application files and after processing by PHIS, 

you can expect PHIS to assign Application Number(s). 

• Each XML/Excel application produces either a message with an Application Number or an error 

message explaining the nature of the error.

• A previously submitted application can be updated by using the same application UID. PHIS 

subjects the data to the same validation as the originally accepted application. For more 

information, see Updates on page 9.

• You can upload a Cancel file to cancel an application as long as the application is not Rejected, 

Replaced, or Approved. You identify the application by using the same application UID that 

was used to create it or its application number. 

XML fields that are not on the 9060 but maintained in PHIS as part of the Batch Results record:

• Application UID. This ID is a GUID provided by the applicant that is a unique identifier for the 

application.

• Product UID. Similar to the Application UID but at the product level.

XSD

General notes used to evaluate the XSD elements necessary to create a well-formed XML file.
Public Health Information System (PHIS) Export Batch User Guide

15

Application Number vs. Certificate Number 

When a 9060 application is first created, PHIS assigns it an Application Number. This Application 

Number is used to identify the application as it goes through the PHIS system. Once the application 

has been approved by IPP, the Application Number becomes the Certificate Number.

Data Size 

Elements with a String data type in the following tables have a size value in parenthesis if it is 

limited in length outside of what is listed in the XSD. For example, the Additional Statement 

information included in the XML is limited to 500 characters.

Decimal numbers have a similar layout as strings but show two values: precision and scale. Precision 

indicates how many total digits can be used in the number while scale indicates the number of digits 

that can be used to the right of the decimal point.

Structures

Envelope

Table 1 contains elements required for all applications in an XML file. Each file must have one and 

only one envelope structure.

Table 1: Envelope Structure

Element Node Name Req Data Type Count Notes

Access Control AccessControl Access 

Control

1 Information regarding the 

permissions applied to the 

resultant application.

Notification Email NotificationEmail See 

note

Email 0 or 1 An email address to send 

process notifications. See 

note on page 22.

This field is optional but 

recommended.

Export Application 

9060s

ExportApplication9060s Collection 

of Export 

Application 

9060

1 Collection of all 9060 

applications to process (at 

least one application is 

required)
Public Health Information System (PHIS) Export Batch User Guide

16

Export Application 9060

Table 2 represents a single, new 9060 application in XML form.

Only a basic amount of information is required to create an application. Subsequent update files 

may be uploaded to submit the application for approval. In Table 2, the Req (Required) column 

provides two answers. The first answers the question whether the element is required to create the 

application and the second answers the question whether the element is required to submit the 

application. If there is only one answer, the same answer applies to both questions. 

Table 2: Export Application 9060 Structure

Element Node Name Req Data Type Count Notes

Additional 

Statement

AdditionalStatement No String (500) 0 or 1 Any additional 

statements to make 

regarding the application 

or any of the products.

Applicant Applicant No/

Yes

Applicant 0 or 1 The name of the 

individual responsible for 

the 9060 application. 

This name goes in the 

signature section of the 

9060 application.

Once an application has 

been created through 

the batch process, the 

only way to update this 

value is through an 

Export Application 

9060 Update structure. 

The Applicant field is 

not available in the user 

interface when editing 

an application record.

Application 

UID

ApplicationUID Yes GUID 1 An arbitrary unique 

identifier assigned by the 

applicant to identify the 

application. 
Public Health Information System (PHIS) Export Batch User Guide

17

Element Node Name Req Data Type Count Notes

Country of 

Destination

CountryOfDestination Yes String (3) 1 The country code where 

the export is immediately 

headed. This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code

Country of 

Final 

Destination

CountryOfFinalDestination Yes String (3) 1 The country code where 

the export is ultimately 

headed. This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code

Export 

Application 

Attachments

ExportApplicationAttachme

nts

No Collection of 

Attachment

0 or 1 A collection of all 

attachments associated 

with this application. 

This block is optional.

Consignor/

Exporter

ConsignorExporter Yes Import/Export 

Entity

1 The block containing the 

consignor/ exporter 

information

Export 

Establishment 

Number

ExportEstablishmentNumbe

r

Yes String (64) 1 The official 

establishment number of 

the exporting 

establishment.

Include the predominant 

Grant type as it applies to 

the application, i.e.,

M9999 or P1111.

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – Include 

Commodity prefix 

false or 0 – Do not 

include Commodity 

prefix
Public Health Information System (PHIS) Export Batch User Guide

18

Element Node Name Req Data Type Count Notes

I Certify 

Statement

IcertifyStatement No/ 

Yes

String 

(selection)

0 or 1 Acceptable values are:

• Meat

• Poultry

• Meat and Poultry

• Siluriformes Fish

• None of the Above

Consignee/ 

Importer

ConsigneeImporter Yes Import/Export 

Entity

1 The block containing the 

consignee/ importer 

information

Shipment 

Type

ShipmentType No/ 

Yes

Integer 0 or 1 Acceptable values are:

• 1: Commercial Sale

• 2: Personal 

Consumption

• 3: Ship’s Store

• 4: U.S. Military

• 5: Samples

• 6: U.S. Embassy

• 7: Airlines

Once an application has 

been created through 

the batch process, the 

only way to update this 

value is through an 

Export Application 

9060 Update structure. 

There is no Shipment 

Type field available in 

the user interface when 

editing an application 

record.

Submit Submit See 

note

Boolean 1 true or false (or 1 or 0)

**The Submit field is 

required. See note on 

page 22.

More information on the 

Submit Flag and 

submission is on page 8.
Public Health Information System (PHIS) Export Batch User Guide

19

Element Node Name Req Data Type Count Notes

Total Net 

Weight in 

Pounds

TotalNetWeightInPounds No/ 

Yes

Weight 0 or 1 The total net weight of 

all the products in 

pounds.

This field or Total Net 

Weight in Kilograms is 

required to submit the 

application. 

Total Net 

Weight in 

Kilograms

TotalNetWeightInKilogram

s

No/ 

Yes

Weight 0 or 1 The total net weight of 

all the products in 

kilograms.

This field or Total Net 

Weight in Pounds is 

required to submit the 

application.

Unique 

Identifier

UniqueIdentifier No/ 

Yes

String (50) 0 or 1 The unique identifier to 

use as the export mark. 

This ID cannot be used in 

conjunction with USDA 

Export Mark. 

This field is required if 

tag UsdaExportMark = 2

USDA Export 

Mark

UsdaExportMark No/ 

Yes

Integer 0 or 1 Acceptable values are:

• 1: USDA Export 

Mark

• 2: Unique Identifier

Final 

Destination 

Port

FinalDestinationPort No String 0 or 1 This is the receiving port 

for the importing 

country. This 

corresponds to the field 

labeled Port of Entry in 

the PHIS user interface.

Containers Containers No Collection of 

Container

0 or 1 A collection of all 

containers associated 

with this application
Public Health Information System (PHIS) Export Batch User Guide

20

Element Node Name Req Data Type Count Notes

Statements StatementCode No String (64) 0 or 1 Statement record(s) are 

inserted into the Remarks 

section of the application 

to be a part of the 

Certificate package by 

country or 

country/species 

combination. Repeat 

node sequence for 

multiple Statement Code 

values.

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder record(s) are

inserted into the 

statements that are in turn 

inserted into Remarks 

section of the application 

to be a part of the 

Certificate package by 

country or 

country/species 

combination. Repeat 

node sequence for 

multiple Placeholder 

Code values.

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values 

matching placeholder 

codes are inserted into 

statements indicated that 

are in turn inserted into 

remarks section of the 

applications to be a part 

of the Certificate package 

by country or 

country/species 

combination. Repeat 

node sequence under 

node placeholder for 

multiple values for 

multiple Placeholder 

Code entries.
Public Health Information System (PHIS) Export Batch User Guide

21

Element Node Name Req Data Type Count Notes

Placeholder 

Values

PlaceholderValues No This node is used in 

place of node 

PlaceholderValue to 

provide values for multiselect list type 

placeholder.

Value Value No String(64) multiple Value node is used to 

provide multiple 

placeholder values for 

multi-select list type 

placeholder within 

PlaceholderValues node.

Replacement 

history 

remarks

ShowReplacementHistoryR

emarks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1- PHIS generated 

replacement history 

remarks 

false or 0 - Do not 

include PHIS generated 

history remarks

Display 

export 

remarks 

(unique 

identifier)

ShowExportMarkRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS 

generated remarks when 

unique identifier value is 

entered as the export 

mark

false or 0- Do not include 

PHIS generated remarks 

when unique identifier 

value is entered as the 

export mark
Public Health Information System (PHIS) Export Batch User Guide

22

Element Node Name Req Data Type Count Notes

Display 

container 

remarks

ShowContainerRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS 

generated container 

remarks with container 

data value

false or 0 - Do not 

include PHIS generated 

container remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS 

generated seal remarks 

with seal data value

false or 0 - Do not 

include PHIS generated 

seal remarks 

Display Port 

of Entry 

remarks

ShowPortRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS 

generated port of entry 

remarks with port data 

value

false or 0 - Do not 

include PHIS generated 

port of entry remarks 

Export 

Application 

Products

ExportApplication9060Prod

ucts

Yes Collection of 

Export 

Application 

9060 Product

1 A collection of all 

products in the export 

application.

**A Submit value of true or 1 explicitly informs PHIS that after the file has been parsed and the 

first stage of processing has been successful, it should apply the PHIS Export Library rule set 

validation process. If the validation fails, PHIS returns an error indicating the problem or problems 

with the file and/or the application to the Batch Results page. PHIS also emails the pertinent 

information about the failure to the notification user. Even though the file was not submitted, it

stills resides in PHIS for future resubmission.
Public Health Information System (PHIS) Export Batch User Guide

23

A Submit value of false or 0 explicitly informs PHIS to not apply the PHIS Export Library rule set 

validation process. 

Export Application 9060 Cancel

This structure includes the Cancel tag and requests cancelation of an existing 9060 application. To 

identify the application, either the Application Number or Application UID must be provided. If the 

Application Number is provided, the Application UID is ignored.

Table 3 Export Application 9060 Cancel Structure

Element Node Name Req Data Type Count Notes

Application 

Number

ApplicationNumber See 

note

Application 

Number

0 or 1 The Application Number of the 

9060 that is being cancelled. PHIS 

uses this field over the Application 

UID if both are provided.

This field is required if 

ApplicationUID is not present.

Application UID ApplicationUID See 

note

GUID 0 or 1 An arbitrary unique identifier 

previously assigned by the 

applicant to identify the 

application that is being cancelled.

This field is required if 

ApplicationNumber is not present.
Public Health Information System (PHIS) Export Batch User Guide

24

Export Application 9060 Basic

Table 4 describes the structure of a basic 9060 application where only an identifier is needed. This 

is used to reference previously submitted applications for actions during Cancels, Replacements, 

Splits, and Consolidations.

To identify the application, either the Application Number or Application UID must be provided. If 

the Application Number is provided, the Application UID is ignored.

Table 4: Export Application 9060 Basic Structure

Element Node Name Req Data Type Count Notes

Application 

Number

ApplicationNumber See 

note

Application 

Number

0 or 1 The Application Number of the 

9060 Certificate that is being 

replaced, updated, or canceled.

PHIS uses this field over the 

Application UID if both are 

provided.

This field is required if 

ApplicationUID is not present.

Application UID ApplicationUID See 

note

GUID 0 or 1 An arbitrary unique identifier 

previously assigned by the 

applicant to identify the 

application.

This field is required if 

ApplicationNumber is not 

present.

Export Application 9060 Update

This structure contains the Update tag and represents an update of a single existing 9060 application 

in XML form. This is largely the same as Export Application 9060 except for the application 

number element, which can be used as an alternate identifier for the application instead of the 

Application UID.

Table 5: Export Application 9060 Update Structure

Element Node Name Req Data Type Count Notes

Additional 

Statement

AdditionalStatemen

t

No String (500) 0 or 1 Any additional statements to 

make regarding the application 

or any of the products.
Public Health Information System (PHIS) Export Batch User Guide

25

Element Node Name Req Data Type Count Notes

Applicant Applicant No/ 

Yes

Applicant 0 or 1 The name of the individual 

responsible for the 9060 

application. This name goes in 

the signature section of the 9060 

application.

Once an application has been 

created through the batch 

process, the only way to update 

this value is through an Export 

Application 9060 Update

structure. The Applicant field 

is not available in the user 

interface when editing an 

application record. 

Application 

Number

ApplicationNumber See 

note

Application 

Number

0 or 1 The PHIS-generated Application 

Number that uniquely identifies 

the application. If present for 

new files, it is ignored

PHIS uses this field over the 

Application UID if both are 

provided.

This field is required if 

ApplicationUID is not present.

Application UID ApplicationUID See 

note

GUID 0 or 1 An arbitrary unique identifier 

assigned by the applicant to 

identify the application. 

This field is required if 

ApplicationNumber is not 

present.

Country of 

Destination

CountryOfDestinati

on

Yes String (3) 1 The country code where the 

export is immediately headed. 

This can be:

• 2-character country code

• 3-character country code

• 3-digit country code
Public Health Information System (PHIS) Export Batch User Guide

26

Element Node Name Req Data Type Count Notes

Country of Final 

Destination

CountryOfFinalDes

tination

Yes String (3) 1 The country code where the 

export is ultimately headed. This 

can be:

• 2-character country code

• 3-character country code

• 3-digit country code

Export 

Application 

Attachments

ExportApplication

Attachments

No Collection of 

Attachment

0 or 1 A collection of all attachments 

associated with this application.

Consignor/ 

Exporter

ConsignorExporter Yes Import/Expo

rt Entity

1 The block containing the 

consignor/exporter information.

Export 

Establishment 

Number

ExportEstablishme

ntNumber

Yes String (64) 1 The official establishment 

number of the exporting 

establishment.

Include the predominant Grant 

type as it applies to the 

application, i.e., M9999 or 

P1111.

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – Include Commodity 

prefix 

false or 0 – Do not include 

Commodity prefix

I Certify 

Statement

ICertifyStatement No/ 

Yes

String 

(selection)

0 or 1 Acceptable values are:

• Meat

• Poultry

• Meat and Poultry

• Siluriformes Fish

• None of the Above

Consignee/ 

Importer

ConsigneeImporter Yes Import/Expo

rt Entity

1 The block containing the 

consignee/importer information.
Public Health Information System (PHIS) Export Batch User Guide

27

Element Node Name Req Data Type Count Notes

Shipment Type ShipmentType Yes Integer 0 or 1 Acceptable values are:

• 1: Commercial Sale

• 2: Personal Consumption

• 3: Ships Store

• 4: U.S. Military

• 5: Samples

• 6: U.S. Embassy

• 7: Airlines

Submit Submit Yes Boolean 1 **The Submit field is required. 

See note on page 22.

More information on the Submit 

Flag and submission is on page 

8.

Total Net 

Weight in 

Pounds

TotalNetWeightInP

ounds

See 

Not

e

Weight 0 or 1 The total net weight of all the 

products in pounds.

This field or Total Net Weight in 

Kilograms is required to submit 

the application. 

Total Net 

Weight in 

Kilograms

TotalNetWeightInK

ilograms

See 

Not

e

Weight 0 or 1 The total net weight of all the 

products in kilograms.

This field or Total Net Weight in 

Pounds is required to submit the 

application.

Unique Identifier UniqueIdentifier See 

note

String (50) 0 or 1 The unique identifier to use as 

the export mark. This cannot be 

used in conjunction with USDA 

Export Mark. 

This field is required if tag 

UsdaExportMark = 2.

USDA Export 

Mark

UsdaExportMark No/ 

Yes

Integer 0 or 1 Acceptable values are:

• 1: USDA Export Mark

• 2: Unique Identifier

Final Destination 

Port

FinalDestinationPor

t

String 0 or 1 This is the receiving port for the 

importing country. This 

corresponds to the field labeled 

Port of Entry in the PHIS user 

interface.
Public Health Information System (PHIS) Export Batch User Guide

28

Element Node Name Req Data Type Count Notes

Containers Containers Collection of 

Container

0 or 1 A collection of all containers 

associated with the application.

Statements StatementCode No String (500) 0 or 1 Statement record(s) matching 

codes is inserted into the 

remarks section of the 

application s to be a part of the 

Certificate package by country 

or country/species combination. 

Repeat node sequence for 

multiple Statement Code values.

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder values matching 

codes is inserted into the 

statements that are in turn 

inserted into remarks section of 

the applications to be a part of 

the Certificate package by 

country or country/species 

combination. Repeat node 

sequence for multiple 

Placeholder Code values.

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values matching 

placeholder codes are inserted 

into statements indicated that are 

in turn inserted into remarks 

section of the applications to be 

a part of the Certificate package 

by country or country/species 

combination. Repeat node 

sequence under node placeholder 

for multiple values for multiple 

Placeholder Code entries.

Placeholder 

Values

PlaceholderValues No String(64) This node is used in place of 

node PlaceholderValue to 

provide values for multi-select 

list type placeholder.

Value Value No Value node is used to provide 

multiple placeholder values for 

multi-select list type placeholder 

within node PlaceholderValues.
Public Health Information System (PHIS) Export Batch User Guide

29

Element Node Name Req Data Type Count Notes

Replacement 

history remarks

ShowReplacement

HistoryRemarks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – PHIS generated 

replacement history remarks 

false or 0 – Do not include PHIS 

generated history remarks

Display export 

remarks (unique 

identifier)

ShowExportMarkR

emarks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – PHIS generated 

remarks when unique identifier 

value is entered as the export 

mark

false or 0 – Do not include PHIS 

generated remarks when unique 

identifier value is entered as the 

export mark

Display 

container 

remarks

ShowContainerRe

marks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – PHIS generated 

container remarks with container 

data value

false or 0 – Do not include PHIS 

generated container remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false(or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – PHIS generated seal 

remarks with seal data value

false or 0 – Do not include PHIS 

generated seal remarks 
Public Health Information System (PHIS) Export Batch User Guide

30

Element Node Name Req Data Type Count Notes

Display Port of 

Entry remarks

ShowPortRemarks No Boolean 1 true or false(or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated port 

of entry remarks with port data 

value

false or 0 - Do not include PHIS 

generated port of entry remarks 

Export 

Application 

Products

ExportApplication9

060Products

Yes Collection of 

Export 

Application 

9060 

Product

1 A collection of all products in 

the application for export.

Export Application 9060 Replacement

This structure contains the Replacement tag and represents the 1:1 replacement of an approved

9060 certificate. 

This structure is largely the same as Export Application 9060 except for the presence of the 

Application Number element, which can be used as an alternate identifier for the approved 

application, and Products are represented by a more restricted Product block.

This operation differs from an Update in that this operation, if successful, results in one new 

Application Number. All Update operations keep the existing Application Number.

Table 6: Export Application 9060 Replacement Structure

Element Node Name Req Data Type Count Notes

Additional 

Statement

AdditionalStatement No String 

(500)

0 or 1 Any additional statements to 

make regarding the application 

or any of the products. 
Public Health Information System (PHIS) Export Batch User Guide

31

Element Node Name Req Data Type Count Notes

Applicant Applicant No/

Yes

Applicant 0 or 1 The name of the individual 

responsible for the 9060 

application. This name goes in 

the signature section of the 9060 

application.

Once an application has been 

created through the batch 

process, the only way to update 

this value is through an Export 

Application 9060 Update

structure. The Applicant field 

is not available in the user 

interface when editing an 

application record. 

Application 

Number

ApplicationNumber See 

note

Application 

Number

0 or 1 The PHIS-generated Application 

Number that uniquely identifies 

the application. PHIS uses this 

field over the Application UID if 

both are provided.

This field is required if 

ApplicationUID is not present.

Application 

UID

ApplicationUID See 

note

GUID 0 or 1 An arbitrary unique identifier 

assigned by the applicant to 

identify the application.

This field is required if 

ApplicationNumber is not 

present.

Country of 

Destination

CountryOfDestinatio

n

Yes String (3) 1 The country code where the 

export is immediately headed. 

This can be:

• 2-character country code

• 3-character country code

• 3-digit country code

Country of 

Final 

Destination

CountryOfFinalDesti

nation

Yes String (3) 1 The country code where the 

export is ultimately headed. This 

can be:

• 2-character country code

• 3-character country code

• 3-digit country code
Public Health Information System (PHIS) Export Batch User Guide

32

Element Node Name Req Data Type Count Notes

Export 

Application 

Attachments

ExportApplicationAtt

achments

No Collection 

of 

Attachment

0 or 1 A collection of all attachments 

associated with this application.

Consignor/

Exporter

ConsignorExporter Yes Import/Exp

ort Entity

1 The block containing the 

consignor/exporter information.

Export 

Establishment 

Number

ExportEstablishment

Number

Yes String (64) 1 The official establishment 

number of the exporting 

establishment.

Include the predominant Grant 

type as it applies to the 

application, i.e., M9999 or 

P1111.

Include Prefix IncludePrefix No Boolean 1 true or false(or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – Include Commodity 

prefix 

false or 0 – Do not include 

Commodity prefix

I Certify 

Statement

ICertifyStatement No/ 

Yes

String 

(selection)

0 or 1 Acceptable values are:

• Meat

• Poultry

• Meat and Poultry

• Siluriformes Fish

• None of the Above

Consignee/

Importer

ConsigneeImporter Yes Import/Exp

ort Entity

1 The block containing the 

consignee/importer information. 

Reason for 

Replacement

ReasonForReplaceme

nt

Yes Integer 1 The reason the replacement is 

requested. 

Acceptable values are:

• 1: Lost Certificate

• 2: Incorrect Certificate

• 3: Importer/ Exporter 

Changed

• 4: Certificate Missing 

Required Information

• 5: Importing Country 

Border Closure
Public Health Information System (PHIS) Export Batch User Guide

33

Element Node Name Req Data Type Count Notes

Shipment Type ShipmentType No/ 

Yes

Integer 0 or 1 Acceptable values are:”

• 1: Commercial Sale

• 2: Personal Consumption

• 3: Ships Store

• 4: U.S. Military

• 5: Samples

• 6: U.S. Embassy

• 7: Airlines

Submit Submit Yes Boolean 1 The Submit field is required. See 

note on page 22.

More information on the Submit 

Flag and submission is on page 

8.

Total Net 

Weight in 

Pounds

TotalNetWeightInPo

unds

See 

Note

Weight 0 or 1 The total net weight of all the 

products in pounds.

This field or Total Net Weight in 

Kilograms is required to submit 

the application. 

Total Net 

Weight in 

Kilograms

TotalNetWeightInKil

ograms

See 

Note

Weight 0 or 1 The total net weight of all the 

products in kilograms.

This field or Total Net Weight in 

Pounds is required to submit the 

application.

Unique 

Identifier

UniqueIdentifier See 

note

String (50) 0 or 1 The unique identifier to use as 

the export mark. This cannot be 

used in conjunction with USDA 

Export Mark. 

This field is required if tag 

UsdaExportMark = 2.

USDA Export 

Mark

UsdaExportMark No/ 

Yes

Integer 0 or 1 Acceptable values are:

• 1: USDA Export Mark

• 2: Unique Identifier

Final 

Destination Port

FinalDestinationPort No String 0 or 1 This is the receiving port for the 

importing country. This 

corresponds to the field labeled 

Port of Entry in the PHIS user 

interface.
Public Health Information System (PHIS) Export Batch User Guide

34

Element Node Name Req Data Type Count Notes

Containers Containers No Collection 

of 

Container

0 or 1 A collection of all containers 

associated with this application

Statements StatementCode No String 

(500)

0 or 1 Codes assigned to statement 

records documented in PHIS to 

indicate inclusion in Application 

and Certificate packages. 

Statements apply to Importing 

Countries or Importing 

Country/Species combinations. 

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder values are inserted 

into the statements that are in 

turn inserted into Remarks 

section of the applications to be 

a part of the Certificate package 

by country or country/species 

combination. Repeat node 

sequence for multiple 

Placeholder Code values.

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values matching 

placeholder codes are inserted 

into statements indicated that are 

in turn inserted into remarks 

section of the applications to be 

a part of the Certificate package 

by country or country/species 

combination. Repeat node 

sequence under node placeholder 

for multiple values for multiple 

Placeholder Code entries.

Placeholder 

Values

PlaceholderValues No 0 0r 1 This node is used in place of 

node PlaceholderValue to 

provide values for multi-select 

list type placeholder.

Value Value No String(64) multip

le

Value node is used to provide 

multiple placeholder values for 

multi-select list type placeholder 

within node PlaceholderValues.
Public Health Information System (PHIS) Export Batch User Guide

35

Element Node Name Req Data Type Count Notes

Display 

container 

remarks

ShowContainerRema

rks

No Boolean 1 true or false(or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

container remarks with container 

data value

false or 0 - Do not include PHIS 

generated container remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated seal 

remarks with seal data value

false or 0 - Do not include PHIS 

generated seal remarks 

Display Port of 

Entry remarks

ShowPortRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated port 

of entry remarks with port data 

value

false or 0 - Do not include PHIS 

generated port of entry remarks 

Export 

Application 

9060 Product 

Replacement

ExportApplication90

60Products

Yes Collection 

of Export 

Application 

9060 

Product 

Replaceme

nt

1 A collection of products from 

the original approved certificate. 

Changes from original values are 

limited to Product Name(s),

decreases in marked Net Weight 

of Lot values, and Est. Number 

on Product
Public Health Information System (PHIS) Export Batch User Guide

36

Export Application 9060 Paper Replacement

This structure contains the Export Application 9060 Paper Replacement tag represents a request to 

replace an existing paper export certificate with a digital application in PHIS. This differs from a 

Replacement application in that it does not require an existing certificate in PHIS.

Table 7: Export Application 9060 Paper Replacement Structure

Element Node Name Req Data Type Count Notes

Additional 

Statement

AdditionalStatement No String (500) 0 or 1 Any additional statements to 

make regarding the 

application or any of the 

products. 

Applicant Applicant No/ 

Yes

Applicant 0 or 1 The name of the individual 

responsible for the 9060 

application. This name goes 

in the signature section of the 

9060 application.

Once an application has 

been created through the 

batch process, the only way 

to update this value is 

through an Export 

Application 9060 Update

structure. The Applicant 

field is not available in the 

user interface when editing 

an application record.

Application 

Number

ApplicationNumber Yes Application 

Number

1 The original paper 

application number is 

inserted into the Applicant 

Number field to create a 1:1 

paper replacement. The 

format should be three letters 

and six numbers, for 

example: MPL123456.

This field is required when 

creating a 1:1 paper 

replacement application

record.

Application 

UID

ApplicationUID Yes GUID 1 An arbitrary unique identifier 

assigned by the applicant to 

identify the application.
Public Health Information System (PHIS) Export Batch User Guide

37

Element Node Name Req Data Type Count Notes

Country of 

Destination

CountryOfDestination Yes String (3) 1 The country code where the 

export is immediately 

headed. This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code

Country of 

Final 

Destination

CountryOfFinalDestina

tion

Yes String (3) 1 The country code where the 

export is ultimately headed. 

This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code

Export 

Application 

Attachments

ExportApplicationAtta

chments

No Collection of 

Attachment

0 or 1 A collection of all 

attachments associated with 

this application.

This block is optional.

Consignor/ 

Exporter

ConsignorExporter Yes Import/Export 

Entity

1 The block containing the 

consignor/exporter 

information.

Export 

Establishment 

Number

ExportEstablishmentN

umber

Yes String (64) 1 The official establishment 

number of the exporting 

establishment.

Include the predominant 

Grant type as it applies to the 

application, i.e., M9999 or 

P1111.

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – Include 

Commodity prefix 

false or 0 – Do not include 

Commodity prefix
Public Health Information System (PHIS) Export Batch User Guide

38

Element Node Name Req Data Type Count Notes

I Certify 

Statement

ICertifyStatement No/ 

Yes

String 

(selection)

0 or 1 Acceptable values are:

• Meat

• Poultry

• Meat and Poultry

• Siluriformes Fish

• None of the Above

Consignee/ 

Importer

ConsigneeImporter Yes Import/Export 

Entity

1 The block containing the 

consignee/importer 

information. 

Reason for 

Replacement

ReasonForReplacement Yes Integer 1 The reason the replacement 

is requested. Acceptable 

values are:

• 1: Lost Certificate

• 2: Incorrect Certificate

• 3: Importer/ Exporter 

Changed

• 4: Certificate Missing 

Required Information

• 5: Importing Country 

Border Closure

Shipment Type ShipmentType No/ 

Yes

Integer 0 or 1 Acceptable values are:

• 1: Commercial Sale

• 2: Personal 

Consumption

• 3: Ships Store

• 4: U.S. Military

• 5: Samples

• 6: U.S. Embassy

• 7: Airlines

Submit Submit No/ 

Yes

Boolean 1 The Submit field is required. 

See note on page 22.

More information on the 

Submit Flag and submission 

is on page 8.
Public Health Information System (PHIS) Export Batch User Guide

39

Element Node Name Req Data Type Count Notes

Total Net 

Weight in 

Pounds

TotalNetWeightInPoun

ds

See 

Note

Weight 0 or 1 The total net weight of all the 

products in pounds.

This field or Total Net 

Weight in Kilograms is 

required to submit the 

application. 

Total Net 

Weight in 

Kilograms

TotalNetWeightInKilo

grams

See 

Note

Weight 0 or 1 The total net weight of all the 

products in kilograms.

This field or Total Net 

Weight in Pounds is required 

to submit the application.

Unique 

Identifier

UniqueIdentifier See 

note

String (50) 0 or 1 The unique identifier to use 

as the export mark. This 

cannot be used in 

conjunction with USDA 

Export Mark. 

This field is required if tag 

UsdaExportMark = 2.

USDA Export 

Mark

UsdaExportMark No/ 

Yes

Integer 0 or 1 Acceptable values are:

1: USDA Export Mark

2: Unique Identifier

Final 

Destination 

Port

FinalDestinationPort No String 0 or 1 This is the receiving port for 

the importing country. This 

corresponds to the field 

labeled Port of Entry in the 

PHIS user interface.

Containers Containers No Collection of 

Container

0 or 1 A collection of all containers 

associated with this 

application.

Statements StatementCode No String (500) 0 or 1 Statement record(s) matching 

codes is inserted into the 

remarks section of the 

application s to be a part of 

the Certificate package by 

country or country/species 

combination. Repeat node 

sequence for multiple 

Statement Code values.
Public Health Information System (PHIS) Export Batch User Guide

40

Element Node Name Req Data Type Count Notes

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder values matching 

codes is inserted into the 

statements that are in turn 

inserted into remarks section 

of the applications to be a 

part of the Certificate 

package by country or 

country/species combination. 

Repeat node sequence for 

multiple Placeholder Code

values.

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values matching 

placeholder codes are 

inserted into statements 

indicated that are in turn 

inserted into remarks section 

of the applications to be a 

part of the Certificate 

package by country or 

country/species combination. 

Repeat node sequence under 

node placeholder for 

multiple values for multiple 

Placeholder Code entries.

Placeholder 

Values

PlaceholderValues No This node is used in place of 

node PlaceholderValue to 

provide values for multiselect list type placeholder.

Value Value No String(64) multip

le

Value node is used to 

provide multiple placeholder 

values for multi-select list 

type placeholder within node 

PlaceholderValues.

Replacement 

history 

remarks

ShowReplacementHist

oryRemarks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

replacement history remarks 

false or 0 - Do not include 

PHIS generated history 

remarks
Public Health Information System (PHIS) Export Batch User Guide

41

Element Node Name Req Data Type Count Notes

Display export 

remarks 

(unique 

identifier)

ShowExportMarkRema

rks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1– PHIS generated 

remarks when a unique 

identifier value is entered as 

the export mark

false or 0 - Do not include 

PHIS generated remarks 

when a unique identifier 

value is entered as the export 

mark

Display 

container 

remarks

ShowContainerRemark

s

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

container remarks with 

container data value

false or 0 - Do not include 

PHIS generated container 

remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 PHIS generated seal 

remarks with seal data value

false or 0 - Do not include 

PHIS generated seal remarks 

Display Port of 

Entry remarks

ShowPortRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 PHIS generated port 

of entry remarks with port 

data value

false or 0 - Do not include 

PHIS generated port of entry 

remarks 
Public Health Information System (PHIS) Export Batch User Guide

42

Element Node Name Req Data Type Count Notes

Export 

Application 

Products

ExportApplication9060

Products

Yes Collection of 

Export 

Application 

9060 Product 

Replacement

1 A collection of all products 

in the application for 

replacement.

IPP validate that weight 

values entered do not exceed 

original product and total net 

weights. 

Export Application 9060 Consolidate Replacement

This structure contains the tag called Export Application 9060 Consolidate Replacement and 

represents the consolidation of multiple 9060 certificates into one 9060 application.

Table 8: Export Application 9060 Consolidate Replacement Structure

Element Node Name Req Data Type Count Notes

Source 

Applications

SourceApplications Yes Collection 

of Export 

Application 

9060 Basic

1 This is a collection of 9060 

certificates that are being 

consolidated into one 

application.

Consolidated 

Application

ConsolidatedApplication Yes Collection 

of Export 

Application 

9060

1 Collection of 9060 source 

application data

Reason for 

Replacement

ReasonForReplacement Yes Integer 1 The reason the replacement is 

being requested. 

Acceptable values are:

• 1: Lost Certificate

• 2: Incorrect Certificate

• 3: Importer/Exporter 

Changed

• 4: Certificate Missing 

Required Information

• 5: Importing Country 

Border Closure
Public Health Information System (PHIS) Export Batch User Guide

43

Table 9 represents a truncated view of a 9060-application data used for consolidations. The data 

contained in this object is a subset of the overall 9060 data and represents the fields that can be 

updated through the Batch Export process.

Table 9: Consolidation Source Application

Element Node Name Req Data Type Count Notes

Additional 

Statement

AdditionalStatement No String 

(500)

0 or 1 Any additional statements 

to make regarding the 

application or any of the 

products.

Applicant Applicant No/ 

Yes

Applicant 0 or 1 The name of the individual 

responsible for the 

application. This name 

goes in the signature 

section of the 9060 

application.

Once an application has 

been created through the 

batch process, the only 

way to update this value 

is through an Export 

Application 9060 Update

structure. The Applicant 

field is not available in 

the user interface when 

editing an application 

record.

Application 

UID

ApplicationUID Yes GUID 1 An arbitrary unique 

identifier assigned by the 

applicant/broker to identify 

the application. 

Country of 

Destination

CountryOfDestination Yes String (3) 1 The country code where 

the export is immediately 

headed. This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code
Public Health Information System (PHIS) Export Batch User Guide

44

Element Node Name Req Data Type Count Notes

Country of 

Final 

Destination

CountryOfFinalDestination Yes String (3) 1 The country code where 

the export is ultimately 

headed. This can be:

• 2-character country 

code

• 3-character country 

code

• 3-digit country code

Export 

Application 

Attachments

ExportApplicationAttachment

s

No Collection 

of 

Attachmen

t

0 or 1 A collection of all 

attachments associated 

with this application. 

Consignor/

Exporter

ConsignorExporter Yes Import/Ex

port Entity

1 The block containing the 

consignor/exporter 

information

Export 

Establishment 

Number

ExportEstablishmentNumber Yes String (64) 1 The official establishment 

number of the exporting 

establishment.

Include the predominant 

Grant type as it applies to 

the application, i.e., M9999 

or P1111.

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 – Include 

Commodity prefix 

false or 0 – Do not include 

Commodity prefix

I Certify 

Statement

ICertifyStatement No/ 

Yes

String 

(selection)

0 or 1 Acceptable values are:

• Meat

• Poultry

• Meat and Poultry

• Siluriformes Fish

• None of the Above

Consignee/ 

Importer

ConsigneeImporter Yes Import/Ex

port Entity

1 The block containing the 

consignee/ importer 

information
Public Health Information System (PHIS) Export Batch User Guide

45

Element Node Name Req Data Type Count Notes

Shipment Type ShipmentType No/ 

Yes

Integer 0 or 1 Acceptable values are:

1: Commercial Sale

2: Personal Consumption

3: Ship’s Store

4: U.S. Military

5: Samples

6: U.S. Embassy

7: Airlines

Submit Submit Yes Boolean 1 The Submit field is 

required. See note on page 

22.

More information on the 

Submit Flag and 

submission is on page 8.

Total Net 

Weight in 

Pounds

TotalNetWeightInPounds See 

Note

Weight 0 or 1 The total net weight of all 

the products in pounds.

This field or Total Net 

Weight in Kilograms is 

required to submit the 

application. 

Total Net 

Weight in 

Kilograms

TotalNetWeightInKilograms See 

Note

Weight 0 or 1 The total net weight of all 

the products in kilograms.

This field or Total Net 

Weight in Pounds is 

required to submit the 

application.

Unique 

Identifier

UniqueIdentifier See 

note

String (50) 0 or 1 The unique identifier to use 

as the export mark. This 

cannot be used in 

conjunction with USDA 

Export Mark. 

This field is required if tag 

UsdaExportMark = 2
Public Health Information System (PHIS) Export Batch User Guide

46

Element Node Name Req Data Type Count Notes

USDA Export 

Mark

UsdaExportMark No/ 

Yes

Integer 0 or 1 Acceptable values are:

1: USDA Export Mark

2: Unique Identifier

Final 

Destination 

Port

FinalDestinationPort No String 0 or 1 This is the receiving port 

for the importing country. 

This corresponds to the 

field labeled Port of Entry 

in the PHIS user interface.

Containers Containers No Collection 

of 

Container

0 or 1 A collection of all 

containers associated with 

this application

Statements StatementCode No String 

(500)

0 or 1 Statement record(s) 

matching codes is inserted 

into the remarks section of 

the application s to be a 

part of the Certificate 

package by country or 

country/species 

combination. Repeat node 

sequence for multiple 

Statement Code values.

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder values 

matching codes is inserted 

into the statements that are 

in turn inserted into 

remarks section of the 

applications to be a part of 

the Certificate package by 

country or country/species 

combination. Repeat node 

sequence for multiple 

Placeholder Code values.
Public Health Information System (PHIS) Export Batch User Guide

47

Element Node Name Req Data Type Count Notes

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values 

matching placeholder 

codes are inserted into 

statements indicated that 

are in turn inserted into 

remarks section of the 

applications to be a part of 

the Certificate package by 

country or country/species 

combination. Repeat node 

sequence for multiple 

values for multiple 

Placeholder Code entries.

Placeholder 

Values

PlaceholderValues No This node is used in place 

of node PlaceholderValue 

to provide values for multiselect list type placeholder.

Value Value No String(64) multip

le

Value node is used to 

provide multiple 

placeholder values for 

multi-select list type 

placeholder within node 

PlaceholderValues.

Replacement 

history 

remarks

ShowReplacementHistoryRe

marks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

replacement history 

remarks 

false or 0 - Do not include 

PHIS generated history 

remarks
Public Health Information System (PHIS) Export Batch User Guide

48

Element Node Name Req Data Type Count Notes

Display export 

remarks 

(unique 

identifier)

ShowExportMarkRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

remarks when unique 

identifier value is entered 

as the export mark

false or 2 - Do not include 

PHIS generated remarks 

when unique identifier 

value is entered as the 

export mark

Display 

container 

remarks

ShowContainerRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true - PHIS generated 

container remarks with 

container data value

false or 0 - Do not include 

PHIS generated container 

remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

seal remarks with seal data 

value

false or 0 - Do not include 

PHIS generated seal 

remarks 

Display Port of 

Entry remarks

ShowPortRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

port of entry remarks with 

port data value

false or 0- Do not include 

PHIS generated port of 

entry remarks 
Public Health Information System (PHIS) Export Batch User Guide

49

Element Node Name Req Data Type Count Notes

Export 

Application 

9060 Product 

Replacement

ExportApplication9060Produ

cts

Yes Collection 

of Export 

Applicatio

n 9060 

Product 

Replaceme

nt

1 A collection records for all 

products from the original 

approved certificates being 

replaced. Updates are 

limited to the Product 

Names, decreases in 

marked Net Weight of Lot 

values, and the Est. 

Number on Product.

Export Application 9060 Split Replacement

This structure contains the tag Export Application 9060 Split Replacement and represents the 

splitting of one 9060 certificate into two or more new 9060 applications in XML form.

Table 10: Export Application 9060 Split Replacement Structure

Element Node Name Req Data Type Count Notes

Source 

Application

SourceApplication Yes Export 

Application 

9060 Basic

1 The 9060 certificate that is to be 

split into two or more 

applications.

Split 

Applications

SplitApplications Yes Collection 

of resulting 

Export 

Application 

9060

1 These are collections of 9060 

applications. The number of 

Split Application collections 

determines the number of 

resulting applications.

Split 

Application

SplitApplication Yes This is 

once 

instance of 

the 

resulting 

Export 

Application 

9060

2 to n These are individual 9060 

applications.
Public Health Information System (PHIS) Export Batch User Guide

50

Element Node Name Req Data Type Count Notes

Reason for 

Replacement

ReasonForReplacement Yes Integer 1 The reason the replacement is 

requested. 

Acceptable values are:

1: Lost Certificate

2: Incorrect Certificate

3: Importer/ Exporter Changed

4: Certificate Missing Required 

Information

5: Importing Country Border 

Closure
Public Health Information System (PHIS) Export Batch User Guide

51

Element Node Name Req Data Type Count Notes

Statements StatementCode No String 

(500)

0 or 1 Statement record(s) matching 

codes is inserted into the 

remarks section of the 

application s to be a part of the 

Certificate package by country 

or country/species combination. 

Repeat node sequence for 

multiple Statement Code 

values.

Placeholder 

Code

PlaceholderCode No String (64) 0 or 1 Placeholder values matching 

codes is inserted into the 

statements that are in turn 

inserted into remarks section of 

the applications to be a part of 

the Certificate package by 

country or country/species 

combination. Repeat node 

sequence for multiple 

Placeholder Code values.

Placeholder 

Value

PlaceholderValue No String (64) 0 or 1 Placeholder values matching 

placeholder codes are inserted 

into statements indicated that 

are in turn inserted into remarks 

section of the applications to be 

a part of the Certificate package 

by country or country/species 

combination. Repeat node 

sequence for multiple values for 

multiple Placeholder value 

entries.

Placeholder 

Values

PlaceholderValues No This node is used in place of 

node PlaceholderValue when 

we need to provide values for 

multi-select list type 

placeholder.

Value Value No String(64) multip

le

Value node is used to provide 

multiple placeholder values for 

multi-select list type 

placeholder within node 

PlaceholderValues.
Public Health Information System (PHIS) Export Batch User Guide

52

Element Node Name Req Data Type Count Notes

Replacement 

history 

remarks

ShowReplacementHistory

Remarks

No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

replacement history remarks 

false or 0 - Do not include PHIS 

generated history remarks

Display 

export 

remarks 

(unique 

identifier)

ShowExportMarkRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

remarks when unique identifier 

value is entered as the export 

mark

false or 0 - Do not include PHIS 

generated remarks when unique 

identifier value is entered as the 

export mark

Display 

container 

remarks

ShowContainerRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated 

container remarks with 

container data value

false or 0 - Do not include PHIS 

generated container remarks 

Display seal 

remarks

ShowSealRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated seal 

remarks with seal data value

false or 0 - Do not include PHIS 

generated seal remarks 
Public Health Information System (PHIS) Export Batch User Guide

53

Element Node Name Req Data Type Count Notes

Display Port 

of Entry 

remarks

ShowPortRemarks No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1 - PHIS generated port 

of entry remarks with port data 

value

false or 0 - Do not include PHIS 

generated port of entry remarks 

Export 

Application 

9060 Product 

Replacement

ExportApplication9060Pr

oducts

Yes Collection 

of Export 

Application 

9060 

Product 

Replaceme

nt

1 A collection of all products in 

the application for replacement. 

Updates to original data values 

are limited to Product Name(s) 

and decreases in marked Net 

Weight of Lot.
Public Health Information System (PHIS) Export Batch User Guide

54

Export Application 9060 Product

This structure provides details on individual products within new or update applications. This is the 

actual product being exported. This represents an entire line as seen on a 9060 application form.

Table 11: Export Application Product Structure

Element Node Name Req Data 

Type

Count Notes

Establishment 

Number on 

Product

EstablishmentNumberOnPro

duct

Yes String 

(50)

0 or 1 The establishment number 

stamped on the shipping 

cartons.

Include the predominant Grant 

type as it applies to the 

application, i.e., M9999 or 

P1111.

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1– Include Commodity 

prefix 

false or 2– Do not include 

Commodity prefix

Frozen Shelf 

Stable

FrozenShelfStable Yes Boolean 0 or 1 true or false (or 1 or 0)

HACCP 

Category

HaccpCategory Yes String 

(selectio

n)

0 or 1 Acceptable values are:

• 03B

• 03C

• 03D

• 03E

• 03F

• 03G

• 03H

• 03I

Line Number LineNumber No Integer 1 Number associated with the 

product allowing for 

identification of products 

otherwise not sent in via Batch 

Export.

This value is not actively 

processed.
Public Health Information System (PHIS) Export Batch User Guide

55

Element Node Name Req Data 

Type

Count Notes

Maturity Less 

Than 30 Months

MaturityLessThan30Months No/ 

Yes 

Boolean 0 or 1 true or false (or 1 or 0)

No value or Null is accepted 

when the species is not beef.

Net Weight of 

Lot in Pounds

NetWeightOfLotInPounds See 

Note

Weight 0 or 1 The total net weight of all the 

products in pounds.

This field or Total Net Weight 

in Kilograms is required to 

submit the application. 

Net Weight of 

Lot in 

Kilograms

NetWeightOfLotInKilogram

s

See 

Note

Weight 0 or 1 The total net weight of all the 

products in kilograms.

This field or Total Net Weight 

in Pounds is required to submit 

the application.

Number of 

Packages in Lot

NumberOfPackagesInLot Yes Integer 0 or 1 A value greater than 0 must be 

entered.

Product Code ProductCode No String 

(100)

0 or 1 The product code used in part 

to create the Description for 

the product.

Product Name ProductName Yes String 

(100)

0 or 1 The name of the product used 

in part to create the 

Description for the product.

This field is required to submit 

for approval.

Product UID ProductUID Yes GUID 1 An arbitrary unique identifier 

assigned by the applicant to 

identify the individual product.

Shipping 

Identification 

Marks

ShippingIdentificationMarks No String 

(50)

0 or 1 The shipping/identification 

marks that links this product to 

an FSIS export certificate. 
Public Health Information System (PHIS) Export Batch User Guide

56

Element Node Name Req Data 

Type

Count Notes

Species Species Yes String 

(selectio

n)

0 or 1 Acceptable values are:

• Antelope

• Beef

• Bison

• Buffalo

• Catalo

• Chicken

• Deer

• Duck

• Egg Products

• Elk

• Emu

• Goat

• Goose

• Guinea

• Horse

• Lamb

• Mutton

• Ostrich

• Pheasant

• Pork

• Quail

• Rabbit

• Ratite

• Reindeer

• Rhea 

• Siluriformes Fish

• Squab

• Turkey

• Veal

• Water Buffalo

Field is case-sensitive. Species 

should be listed with the first 

letter upper case and the 

remaining letters lower case.
Public Health Information System (PHIS) Export Batch User Guide

57

Element Node Name Req Data 

Type

Count Notes

Type of 

Packages in Lot

TypeOfPackagesInLot Yes String 

(selectio

n)

0 or 1 Acceptable values are:

• AG

• BG

• BI

• BJ

• BX

• CA

• COM

• CS

• CT

• CX

• DR

• EC

• FT

• FX

• IB

• IC

• JR

• MB

• NA

• NE

• NF

• NG

• PAL

• PB

• PK

• PL

• PO

• PU

• PX

• SA

• SW

• TB

• TN

• TU

• TY

• VA

• VP

• 5M
Public Health Information System (PHIS) Export Batch User Guide

58

Element Node Name Req Data 

Type

Count Notes

Processing 

Establishments

ProcessingEstablishments No String 

(50)

0 or 1 The processing establishment 

is only displayed in the PHIS 

user interface when the 

importing country requires 

FSIS verification as part of the 

approval process. 

Slaughter 

Establishments

SlaughterEstablishments No String 

(50)

0 or 1 The slaughter establishment is 

only displayed in the PHIS 

user interface when the 

importing country requires 

FSIS verification as part of the 

approval process

Export Application 9060 Product Replacement

This structure provides information on an individual product within any replacement application. 

This represents a partial line as seen on a 9060 application form, exposing the only information that 

can be changed during a Replacement action.

Table 12: Export Application Product Replacement Structure

Element Node Name Req Data 

Type

Count Notes

Line Number LineNumber No Integer 1 Number associated with the 

product allowing for 

identification of products 

otherwise not sent in via 

Batch Export

This value is not actively 

processed.

Establishment 

Number on 

Product

EstablishmentNumberOnProduct Yes String 

(50)

0 or 1 The establishment number 

stamped on the shipping 

cartons.

Include the predominant 

Grant type as it applies to the 

application, i.e., M9999 or 

P1111.
Public Health Information System (PHIS) Export Batch User Guide

59

Element Node Name Req Data 

Type

Count Notes

Include Prefix IncludePrefix No Boolean 1 true or false (or 1 or 0)

9060-6 and 9060-5 PDFs

true or 1– Include 

Commodity prefix 

false or 2– Do not include 

Commodity prefix

Product Name ProductName Yes String 

(100)

0 or 1 The name of the product 

used in part to create the 

Description for the product.

The product name value can 

be changed.

This field is required to 

submit for approval.

Net Weight of 

Lot in Pounds

NetWeightOfLotInPounds See 

Note

Weight 0 or 1 The total net weight of all the 

products in pounds.

This field or Total Net 

Weight in Kilograms is 

required to submit the 

application. 

Updates from original values 

are limited to decreases in 

marked Net Weight of Lot 

values.

Net Weight of 

Lot in 

Kilograms

NetWeightOfLotInKilograms See 

Note

Weight 0 or 1 The total net weight of all the 

products in kilograms.

This field or Total Net 

Weight in Pounds is required 

to submit the application.

Updates from original values 

are limited to decreases in 

marked Net Weight of Lot 

values.

Number of 

Packages in Lot

NumberOfPackagesInLot Yes Integer 0 or 1 A value greater than 0 must 

be entered.
Public Health Information System (PHIS) Export Batch User Guide

60

Element Node Name Req Data 

Type

Count Notes

Product UID ProductUID Yes GUID 1 An arbitrary unique identifier 

assigned by the applicant to 

identify the individual 

product. 

Processing 

Establishments

ProcessingEstablishments No String 

(50)

0 or 1 The processing establishment 

is only displayed in the PHIS 

user interface when the 

importing country requires 

FSIS verification as part of 

the approval process. 

Slaughter 

Establishments

SlaughterEstablishments No String 

(50)

0 or 1 The slaughter establishment 

is only displayed in the PHIS 

user interface when the 

importing country requires 

FSIS verification as part of 

the approval process
Public Health Information System (PHIS) Export Batch User Guide

61

Attachment

Table 13 represents a single document attached to a 9060 application for consideration when 

processing the application.

Table 13: Attachment Structure

Element Node Name Req Data Type Count Notes

Description Description No String 

(500)

0 or 1 Any additional information about the 

attached document.

Document Name DocumentName See 

note

String 

(260)

0 or 1 The filename of the attached document 

(without path).

This field is required when the 

Attachments tag is populated.

Attachment Type AttachmentType No String

(selection)

0 or 1 Identifies if the attached document is 

Supplemental or Supportive.

Acceptable values are:

• Supplemental

• Supportive

Subtype Subtype See 

note

String

(selection)

0 or 1 When paired with a Supplemental 

attachment type identifies whether the 

attached document is defined as Other 

or Transit Letterhead.

Acceptable values are:

• Other

• TransitLetterhead

This field is required for submittal when 

the Attachment Type = Supplemental.

Transit Country TransitCountry See 

note

String (3) 0 or 1 Identifies the country for the Transit 

Letterhead Certificate.

This field is required for submittal when 

the Subtype = TransitLetterhead.

Each attachment node also contains an attribute named AttachmentType. This attribute has two 

possible values:

• Supplemental: Indicates that this attachment is required for approval, which can be paired 

with the following subtypes:

o Other

o TransitLetterhead

• Supportive: Indicates that this attachment is not required but is useful in evaluating the 

application
Public Health Information System (PHIS) Export Batch User Guide

62

Container

Table 14 represents the container information for products in the 9060 application. Repeat node 

when multiple commercial seal and container values apply.

Table 14: Container Structure

Element Node Name Req Data 

Type

Count Notes

Commercial Seal 

Number

CommercialSealNumber No String 

(100)

0 or 1 The seal number found on the 

container.

Commercial 

Container Number

CommercialContainerNumber No String 

(100)

0 or 1 The number found on the 

container.

PHIS ID

This represents the arbitrary ID used to identify entities within PHIS for permission assignment. 

This value is set within PHIS. The format is as follows:

C-CCCC-9999

The first character can be E, S, or U. The next four characters allow for any capital combination of 

characters. The final four represent any digit.

The rules within Batch Export allow for more flexibility than the standard format. The central four 

characters could be as few as three characters and there is no true upper limit. Likewise, the 

numeric portion at the end can be one or more.

PHIS checks this ID against the database to ensure that it exists before processing continues. PHISIDs for individual export users can be found in the upper right corner of the page after the name of 

the person logged in. Plant Management users can view their establishment’s PHIS-ID from their 

Select Establishment page.

Permission

Table 15 represents the permissions granted or denied a user. The individual elements are as 

follows:

Table 15: Permission Structure

Element Node Name Req Data Type Count Notes

ID ID Yes PHIS ID 1 The ID of the entity either being granted or 

denied permissions. 

Permission Permission Yes String 

(selection)

1 Acceptable values are:

• Read

• Read Write

• Read Write Access

Access Control
Public Health Information System (PHIS) Export Batch User Guide

63

Table 16 shows how PHIS applies permissions to any and all applications within the Batch File. At 

least one entity has to be granted permissions in a Batch File. In the event of conflicting 

permissions, PHIS assumed the most pessimistic (restrictive) option. The individual elements are as 

follows:

Table 16: Access Control Structure

Element Node Name Req Data Type Count Notes

Grant Grant No/ 

Yes

Permission 1 A list of all entities that are specifically 

allowed access to the application. 

Deny Deny No Permission 0 or 1 A list of all entities that are specifically 

denied access to the application.

Address

Table 17 is the basic structure identifying the accepted address information for a company, person,

or entity in PHIS. The individual elements are as follows:

Table 17: Address Structure

Element Node Name Req Data Type Count Notes

Address Line 1 AddressLine1 No/ 

Yes

String 

(250)

0 or 1

Address Line 2 AddressLine2 No String 

(250)

0 or 1

Address Line 3 AddressLine3 No String 

(250)

0 or 1

City City No/ 

Yes

String 

(250)

0 or 1

Country Country No/ 

Yes

String (3) 0 or 1 This code can be (country code formats 

should not be mixed within a record):

• 2-character country code

• 3-character country code

• 3-digit country code

Postal Code PostalCode No/ 

Yes

String (20) 0 or 1
Public Health Information System (PHIS) Export Batch User Guide

64

Element Node Name Req Data Type Count Notes

State or 

Territory

StateOrTerritory See 

note

String (4) 0 or 1 Two character (A-Z, case-insensitive) 

abbreviation for the State or Territory 

information. If no state or territory exists, 

enter the value NA.

This field is required for 

Consignor/Exporter Address to submit 

for approval.

This field is optional for 

Consignee/Importer address and if not 

included, the node can be excluded.

Telephone Telephone No String (16) 0 or 1

Applicant

Table 18 represents the user who is taking responsibility for the 9060 application.

Table 18: Applicant Description Structure

Element Node Name Req Data Type Count Notes

Applicant First 

Name

ApplicantFirstName No/ 

Yes

String (50) 1 First name of the individual taking 

responsibility for the application.

Applicant Last 

Name

ApplicantLastName No/ 

Yes

String (50) 1 Last name of the individual taking 

responsibility for the application.

Application Number

This represents the Application/Certificate number for the 9060. This is restricted to seven digits for 

all application types except for the Export Application 9060 Paper Replacement type. Paper 

applications use nine alphanumeric characters.

Boolean

This is a simple data type indicating true/false, yes/no, on/off. The only allowed data elements 

are true or false (or 1 or 0). The values are case sensitive, so True results in an error. 

Email

This is a basic structure identifying the accepted format for email addresses. This is the simple 

data type of string.

GUID

This is a basic structure representing a standard GUID element. This structure is composed of the 

simple data type string. Some examples are:

5EA12D76-6668-4932-8184-089E5A1055C2

D1D498AC-E255-4104-8E76-2F110E020BC9
Public Health Information System (PHIS) Export Batch User Guide

65

39F9D6BD-DA01-4D63-BC88-4E0D3C995EA1

CA4ACF0F-8D28-41C1-9035-2113EBCBA878

DCFE97E1-3BDF-4C1B-A044-0DEEE1356BFB

The format expected is defined in short as [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-

9a-fA-F]{4}-[0-9a-fA-F]{12}. This expanded into the following:

o 8 alphanumeric characters

o A dash

o Four alphanumeric characters

o A dash

o Four alphanumeric characters

o A dash

o Four alphanumeric characters

o A dash

o Twelve alphanumeric characters

The criteria listed above has the following restrictions:

• Alphanumeric data is considered any number 0-9 (inclusive) or character A-F (inclusive)

• Character casing is not considered (i.e., ‘ABCDE’ is considered equal to ‘abcde’)

Care should be taken when working with GUIDs. They should be generated programmatically 

every time a new GUID is required. If a GUID is reused, PHIS assumes that the information 

associated with that GUID is an update. Likewise, applicants should record used GUIDs in the 

event data needs to be updated. The GUID is not visible in the user interface. 

Import/Export Entity

Table 19 is the structure that defines a consignor/exporter or consignee/importer entity. The format 

is the same for consignee/importers and consignor/exporters.

Table 19: Import/Export Entity Structure

Element Node Name Req Data Type Count Notes

Name Name Yes String (64) 0 or 1 Name of the entity be it a person or 

company.

Address Address No/ 

Yes

Address 0 or 1 The official address of the entity.

Weight

Weight is a decimal value but grouped into its own type for ease of maintenance. It allows for a 

maximum inclusive value of 9,999,999.9999.

In all application types, weight is available in pounds or kilograms. Both nodes are marked as 

optional but at least one node is expected to have a value to submit the application for approval. 
Public Health Information System (PHIS) Export Batch User Guide

66

Service Accounts

The NDA/ISA organizational level agreement must be completed prior an organization/establishment 

transferring export files from their system to PHIS using machine-to-machine communication. 

Additionally, there is the creation of the service accounts and the associated authorization username and 

password, which are required for connecting and passing data to the web service.

Completing the NDA/ISA and setting up the service accounts is required only when uploading files 

through the web service. An identity verified eAuth account is necessary to complete the NDA/ISA and 

to create the authentication username and password information. The web service connection is 

managed through IP Filtering, roles, and the authentication information.

The following steps need to be performed to create access accounts for the web service connection. 

1) Create and Accept an NDA/ISA Agreement

2) Create a service account

3) Generate authorization credentials (username and password) required to connect and pass data to 

the web service

Creating and Accepting NDA/ISA Agreement

When first entering the Service Accounts menu, PHIS displays a message if an NDA/ISA Agreement 

has not been completed. Select the Open NDA/ISA Agreement link.

Figure 4 - NDA/ISA Agreement Page
Public Health Information System (PHIS) Export Batch User Guide

67

Complete the Industry System Owner and Manager/Supervisor information. Enter the valid IP filter 

ranges required to complete the agreement. The IP addresses entered here authenticate the machine(s) 

connecting to the web service. The IP addresses should be static and need to be visible to the web 

service for the authentication process. Entering multiple individual IP addresses is done by using a 

semicolon delimiter or ranges can be entered using a hyphen. The final step is to accept the terms of the 

agreement. Complete the checkbox associated with accepting the terms of the agreement. Anytime there 

is a new or updated agreement, PHIS sends an email to the Industry Owner and Manager/Supervisor 

Figure 5 - NDA/ISA Agreement (New) Page

• NDA/ISA acceptance

o FSIS runs IP address(es) through a list of security checks to ensure they are not flagged 

for anything malicious

o Any IPs flagged for malware or blacklisted are not allowed access.

o FSIS then modifies the Web Application Firewall to explicitly allow approved IP 

address(es) to access PHIS

o Must be renewed every 3 years, any edits initiate a new agreement.

o Reviewed by USDA/FSIS annually
Public Health Information System (PHIS) Export Batch User Guide

68

Creating and Modifying Service Accounts

The service account is the machine-level settings needed to connect to the web service. You can create 

multiple accounts to provide distributed access. Select the Create an Account link to begin the process. 

PHIS displays a page so you can complete the Account Name, Roles, and a description of the account. 

Once created, the service account grid displays information about the existing account and provides an 

option to delete the account. To access the account details, select Open. The Service Account page (see 

Figure 6) enables you to edit the Account Name, Description, Active Status, and Roles. 

This page also displays the service account credentials that are needed to initiate contact with the web 

service. Select Generate Credentials to generate the username and password. The credentials are valid 

for 90 days before expiring. If at any point new credentials are needed, they can be created by selecting

the same link. Passing these credentials to the web service is necessary in order to initiate the 

connection. 

Figure 6 - Service Account Page

Limits on Service Account Access

There are a number of prerequisites to access the web service.

• The agreement is signed, and the status is Active.

• Client submitted valid credentials.

• Requests originate from allowed IP ranges.

• Requests originate from specified IP addresses (from agreement that the service accounts are 

associated with).

• Service account is assigned expected roles (service-specific step).
Public Health Information System (PHIS) Export Batch User Guide

69

Modifying NDA/ISA

When you need to make updates to the Industry System Owner or the Manager/Supervisor information

associated with the agreement, select the Reset link, and input the new data. Any changes to the original 

agreement, including updating valid IP filtering ranges, set in motion a new agreement and the terms 

must be accepted. The changes do not modify the existing agreement but create a new agreement. This 

new agreement resets the start date and is valid for up to three years. 

When a completed NDA/ISA exists, the Configuration tab enables you to view or edit the agreement. 

Figure 7 - Configuration Tab to Access the NDA/ISA

Service Call Log

This tab provides important information about any attempted connections to a service account. This is 

helpful for verifying that the IP address for the machine connecting to the web service is valid in the 

NDA/ISA.

Creating a Software Application for Web Service Connections

The development of the web service had the intent to be technology agnostic. The service is SOAPbased (Simple Object Access Protocol), meaning it allows programs that run on disparate operating 

platforms to communicate using HTTPS protocol. It supports WS-I Basic Profile 1.1 specification and 

SOAP 1.1 as a messaging protocol.

The web service exposes the service description as an XML document conforming to the Web Service 

Description Language (WSDL). The WSDL defines the methods the web service makes available. It 

also defines how client applications interact with it. 

The web service uses WS-Security 1.0 for message security. All application messages between the client 

and server are signed and encrypted using an X509 certificate. For example, the web service is using 

username and password to authenticate a caller.
Public Health Information System (PHIS) Export Batch User Guide

70

Initial connection to the web service:

1. The Web Service Description (WSD) can be retrieved from the web service. 

• For testing purposes, use the following service address:

https://phissvccert2.fsis.usda.gov/ExportBatchServicesDmzITE/ExportBatchProcessingDmz

Service.svc

• For production implementation, use the following service address:

https://phisservices.fsis.usda.gov/ExportBatchServicesDmz/ExportBatchProcessingDmzServ

ice.svc

2. Right-click your project and choose Add Service Reference...

3. Select Advanced...

4. Select Add Web Reference...

5. Add the URL listed above in the URL text box

6. Add a name for your reference in the Web reference name text box

7. Select OK on all the forms

The application has to complete a number of steps to finalize the connection to the web service.

1. Prepare input data (parameters and a batch file).

2. Instantiate the proxy object.

3. Set username and password (from a service account)

4. Call service methods using the proxy object.

5. Check returned values.

6. Dispose the proxy object.

Implementation for testing uses Microsoft .NET Framework 4.5 and Windows Communication 

Foundation (WCF) 4.5.

Once the web service connection has been established, files can be sent to PHIS or status requests on 

previously sent files can be requested. The request response includes a combination of milestone 

messages and error messages. These messages help with identifying if the processing was successful, 

where errors were encountered, and details to any issues with the file uploaded. 

Access to Application Records

PHIS controls access to 9060 application records based on which user identifier(s), also known as PHIS 

ID(s), are associated with the application. PHIS IDs can be assigned to individuals or establishment 

entities. If you grant access to an establishment entity, you are granting access to all users associated 

with that entity that also have the Export Applicant role. For more information on PHIS IDs, see the next 

section on page 62. 

There are also different levels of access: Read-Only, Read-Write, and Read-Write and Access. You can 

also use the Grant or Deny settings in your XML/Excel files to define access. 

In the User Interface, access information is maintained on the Access Control tab. You must include 

access control information within XML or Excel files in order to access the resulting application through 

the UI and retrieve Batch Results. When creating an application in the UI, full access defaults to the user 

who created the application in the UI.
Public Health Information System (PHIS) Export Batch User Guide

71

PHIS ID

All industry and corporate users, establishments in PHIS are assigned a PHIS ID. For individuals, the 

PHIS ID is located next to the login name in the upper-right corner. You can find the PHIS ID for a 

single establishment by going to the Access Control page and searching for the establishment. 

There are two types of PHIS IDs – Entity PHIS IDs and User PHIS IDs 

• Entity PHIS IDs are for establishments entities

• User PHIS IDs are for individuals, such as establishment and corporate-level users 

If you change establishments, your PHIS ID moves with you. It is up to the Establishment 

Administrators at each establishment to manage active user accounts and remove the applicable work 

area(s) from the user accounts of former employees.

Application Access Control

Access to an application is set within the application data file or through the user interface on the Access 

Control page. 

Figure 8 - Application Access Control for Applications Online

The Access Control page within the application allows you to grant or deny access to the 9060 

application. By selecting Add New Person (includes users with Establishment and Corporate level and 

Export Brokers roles) or Add New Company, PHIS displays a new window so you can search for users 

or companies. At this time, the Deny access to an individual or a company function can only be inserted 

into a 9060 record when created or updated via batch processing. 
Public Health Information System (PHIS) Export Batch User Guide

72

Figure 9 - User Search for Access Control

Once you add a user or entity, you can select that row and modify the access levels. The different access

levels are: 

• Read 

o This setting allows the user to view the application but not make updates to it

• Read Write 

o This setting allows the user to make updates to the application

• Read Write Access

o This setting allows the user to make updates to the application and change the access to 

the application for other users by adding or removing permissions. 

Be certain to review the different permission levels and set the access accordingly.
Public Health Information System (PHIS) Export Batch User Guide

73

Figure 10 - Setting Access Control Levels

Export Brokers

As an Export Broker, you enroll by logging into PHIS enrollment page using your identity verified 

eAuth account. Then complete the following steps:

1. On the FSIS Enrollment Application page, select Submit Enrollment Request.

2. Select Next. 

3. For the account type, select Export Broker.

4. Complete the remainder of the enrollment pages.

5. Once the enrollment wizard is complete, PHIS sends an email with an Activation Code to the 

address recorded in your eAuth account.

6. From the email, copy your code to your clipboard. 

7. Return to the Enrollment page.

8. Select Enter an Activation Code.

9. Paste the code.

PHIS displays the home page.
Public Health Information System (PHIS) Export Batch User Guide

74

Appendix A – Additional Files

You can find the latest Batch XSD on the PHIS Upload File of Export Applications page. Likewise, you 

can find the latest template for Excel on the PHIS Upload File of Export Applications page. To access 

that page, from the left menu select Batch Processing > Upload Files. 
Public Health Information System (PHIS) Export Batch User Guide

75

Appendix B – Common Error Messages

The following table provides a list of possible error messages to assist with identifying why a particular 

upload attempt failed. Some identify connection type issues and others are more for problems with the 

file itself.

Table 20 Common Error Messages

Error Text Triggering Event

Failed to connect to PHIS. Waiting {0} 

minute(s).

An application could not be saved to PHIS. There 

is a timeout value set in the configuration allowing 

for the periodic attempt to save the information.

OR

A Cancel application could not be saved to PHIS. 

There is a timeout value set in the configuration 

allowing for the periodic attempt to save the 

information.

Failed to connect to PHIS after {0} minute(s). 

Abandoning Save operation.

A connection could not be established and the 

allotted time for attempting reconnection has 

elapsed.

Failed to connect to PHIS after {0} minute(s). 

Abandoning Cancel operation.

A connection could not be established for a Cancel 

application and the allotted time for attempting 

reconnection has elapsed.

New Export Application missing I Certify 

statements. UID: {0}

The I Certify statement was not supplied with the 

application.

(Export Library rule set validation failure 

messages)

All Export Library rule set validation failures are 

passed through without modification.

The Application UID is blank/empty. To correct 

this error, fill out the ApplicationUID element. 

Consolidation applications requests cannot 

already exist in PHIS.

An attempt was made to upload an application 

without an Application UID.

The Application UID {0} cannot be added to 

PHIS because it already exists in the database. 

{1} applications requests cannot already exist in 

PHIS.

An Application UID is already in use in the 

database.

A Cancel application requires either an 

Application UID or Application Number.

A Cancel file was used that was missing both the

Application UID and the Application Number. At 

least one of these fields is required. 
Public Health Information System (PHIS) Export Batch User Guide

76

Error Text Triggering Event

The Country of Destination is blank/empty. To 

correct this error, fill out the 

CountryOfDestination element.

An application the Country of Destination element 

was used.

The Country of Destination length is invalid. To 

correct, update the CountryOfDestination element 

to {0} characters.

The country code for the Country of Destination 

was not three digits.

The Country of Destination, {0}, does not exist in 

PHIS.

The country code for the Country of Destination 

was invalid. 

The Country of Final Destination is blank/empty. 

To correct this error, fill out the 

CountryOfFinalDestination element.

An application was uploaded that was missing the 

Country of Final Destination.

The Country of Final Destination length is 

invalid. To correct, update the 

CountryOfFinalDestination element to {0} 

characters.

The country code for the Country of Final 

Destination was not three digits.

The Country of Final Destination, {0}, does not 

exist in PHIS.

The country code for the Country of Final 

Destination was invalid. 

The Export Establishment Number is 

blank/empty. To correct this error, fill out the 

ExportEstablishmentNumber element.

An application in the batch file did not have an

Export Establishment Number.

The Export Establishment Number, {0}, does not 

exist in PHIS.

The Export Establishment Number was invalid.

Application Number, {0}, did not have any 

products submitted with it.

An application in the batch file did not have any 

products (does not apply to Cancel applications).

A Product ID is blank/empty. To correct this 

error, fill out the ProductUID element.

A product for an application did not have a 

Product UID.

The weight of the lot for one of the products is 

negative. To correct this error, change the 

NetWeightOfLot element.

The weight of one or more products was listed as a

negative number.

The weight of the lot for product {0} is negative. 

To correct this error, change the NetWeightOfLot 

element.

The weight of the specified product was negative.

The number of packages in a lot for one of the 

products is negative. To correct this error, change 

the NumberOfPackagesInLot element.

The number of packages for one or more products

was listed as being negative.
Public Health Information System (PHIS) Export Batch User Guide

77

Error Text Triggering Event

The number of packages in a lot for product {0} 

is negative. To correct this error, change the 

NumberOfPackagesInLot element.

The number of packages of the specified product 

was negative.

The ApplicationUid {0} does not exist. To 

correct this error, change the ApplicationUid 

element.

The given Application UID does not exist in the 

system (does not apply to New applications).

The certification statement has not been filled 

out. To correct this, fill out the ICertifyStatement 

element.

The I Certify statement was missing from the 

application.

The application contains products that are not 

meat products. To correct this, edit the 

ICertifyStatement element.

The I Certify statement was in conflict with the 

product species.

The application contains products that are not 

poultry products. To correct this, edit the 

ICertifyStatement element.

The I Certify statement was in conflict with the 

product species.

The application contains products that are not 

meat or poultry products. To correct this, edit the 

ICertifyStatement element.

The I Certify statement was in conflict with the 

product species.

The application contains products that are not 

Siluriformes fish. To correct this, edit the 

ICertifyStatement element.

The I Certify statement was in conflict with the 

product species.

The Shipment type passed is invalid. To correct, 

update the ShipmentType element.

The Shipment Type fell outside of the expected 

enumeration range.

The Application type passed is invalid. To 

correct, update the ApplicationAction element.

The Application Type was an invalid type.

The Destination Country is blank/empty. To 

correct, fill out the CountryOfDestination 

element.

The Country of Destination was missing.

The Country Of Destination length is invalid. To 

correct, update the CountryOfDestination element 

to 3 characters.

The length of the Country of Destination code was

invalid.

The Exporter Country Code is not a valid value. 

To correct this error, edit the ConsignorExporter 

Country element.

The Exporter’s country code was invalid.
Public Health Information System (PHIS) Export Batch User Guide

78

Error Text Triggering Event

The Exporter Country Code {0} does not exist. 

To correct this error, edit the ConsignorExporter 

Country element.

The Exporter’s country code was invalid. 

The Exporter Country Code is not a valid value. 

To correct this error, edit the ConsignorExporter 

Country element.

The Importer’s country code was invalid.

The Exporter Country Code {0} does not exist. 

To correct this error, edit the ConsignorExporter 

Country element.

The Importer’s country code was not recognized.

The HACCP Category is blank/empty. To 

correct, fill out the HaccpCategory element.

The HACCP Code for a product was missing.

The HACCP Category length is invalid. To 

correct, update the HaccpCategory element to 3 

characters.

The HACCP Code for a product was not the 

expected length.

The attachment {0} was not provided. An attachment appears in the application that did

not appear in the zip file.

Batch Processor: The application file was empty. An application file was empty.

Batch Processor: The application file was empty. The zip file did not contain any applications.

The XML file failed validation.{0} The given XML file contained one or more XSD 

violations.

File larger than 5MB in the ZIP archive. A PDF attachment exceeded the maximum 

allowed file size.

The ZIP archive was empty. The zip file was empty. 

There was no XML file in the ZIP archive. The supplied Batch File did not have an XML file 

in it.

Too many XML files in ZIP archive. The zip file contained more than the allowed 

number of XML files.

Unable to save milestone to the database. A problem occurred when PHIS tried to save a 

milestone.
Public Health Information System (PHIS) Export Batch User Guide

79

Appendix C – Batch Defined Values

The fields in this section have values defined in either the schema or the code.

Certification Statement – <ICertifyStatement>

Table 21 Certification Statement

Options

Meat

Poultry

Meat and Poultry

Siluriformes Fish

None of the Above

HACCP Categories - <HaccpCategory>

Table 22 HACCP Categories

Code Description

03B Raw Product – Ground

03C Raw product – Not Ground

03D Thermally Processed – Commercially Sterile

03E Not Heat Treated – Shelf Stable

03F Heat Treated – Shelf Stable

03G Fully Cooked – Not Shelf Stable

03H Heat Treated but Not Fully Cooked – Not Shelf Stable

03I Product with Secondary Inhibitors – Not Shelf Stable

Access Control Type - <Type>

Table 23 Access Control Type

Type Associated Action

Grant Grants the associated permission

Deny Prevent the identified user from accessing an application
Public Health Information System (PHIS) Export Batch User Guide

80

Access Control Permission – Permission

This is an attribute of the <Add> tag. 

Table 24 Access Control Permission

Permission Description

Read Allows view only access to the application

Read Write Allows changes to the application

Read Write Access Allows changes to the application and changes to the access control of the 

application

Replacement Reason - <ReasonForReplacement>

Table 25 Replacement Reason

Value Reason

1 Lost Certificate

2 Incorrect Certificate

3 Importer/Exporter Changed

4 Certificate Missing Required Information

5 Importing Country Border Closure

Package Type - <TypeOfPackagesInLot>

Table 26 Package Type

Code Package Type Name

BG Bag

FX Bag, flexible container

MB Bag. Multi-ply

5M Bag, paper

EC Bag plastic

BI Bin (includes combos, totes)

BX Box

BJ Bucket

CX Can, cylindrical
Public Health Information System (PHIS) Export Batch User Guide

81

Code Package Type Name

CA Can, rectangular (includes pyramidal)

COM Combo Bins

CRTN Carton

CS Case

DR Drum

FT Foodtainer

JR Jar

NA Not available

PK Package

IB Package, display, cardboard

IC Package, display, plastic

PL Pail

PAL Pallet

PX Pallet

PB Pallet, box

AG Pallet, Shrink-wrapped

PO Pouch

SA Sack

SW Shrink-wrapped

TY Tank, Cylindrical

TN Tin

PU Tray or Tray Pack

TB Tub

TU Tube

NE Unpacked or unpackaged

NF Unpacked or unpackaged, single unit
Public Health Information System (PHIS) Export Batch User Guide

82

Code Package Type Name

NG Unpacked or unpackaged, multiple unit

VP Vacuum-packed

VA Vat

Species - <Species>

Table 27 Species

Species

Antelope Beef

Bison Buffalo

Catalo Chicken

Deer Duck

Egg Products Elk

Emu Goat

Goose Guinea

Horse Lamb

Mutton Ostrich

Pheasant Pork

Quail Rabbit

Ratite Reindeer

Rhea Siluriformes Fish

Squab Turkey

Veal Water Buffalo

USDA Export Mark - <UsdaExportMark>

Table 28 USDA Export Mark

Value Description

1 Using the USDA export mark

2 Using a unique identifier
Public Health Information System (PHIS) Export Batch User Guide

83

Attachment Type - <Type>

Table 29 Attachment Type

Value Description

Supplemental Indicates that this attachment is required for approval

Supportive Indicates that this attachment is not required but is useful in evaluating the 

application

Subtype - <Subtype>

Table 30 Attachment Subtype

Value Description

Other Indicates that this supplemental attachment is required for approval

TransitLetterhead Indicates that this supplemental attachment is a TransitLetterhead and may require 

the signature of a PHV
Public Health Information System (PHIS) Export Batch User Guide

84

Shipment Type - <ShipmentType>

Table 31 Shipment Type

Value Description

1 Commercial Sale

2 U.S. Military Installation

3 Personal Consumption

4 Ship’s Stores

5 Samples

6 U.S. Embassy

7 Airlines
Public Health Information System (PHIS)13.0 Export Batch User Guide

85

Appendix D: Sample SOAP Request

This appendix includes two sections. The first section describes the parts of the SOAP request. The second section is a sample of the request. 

Export Batch machine-to-machine request format

SOAP header contains the Username and Password generated for an Export Applicant user. The username and password are found in the Batch Processing > Service Accounts menu then open the 

service account. This username and password along with the IP addresses whitelisted from the NDA/ISA is what authenticates the machine making the connection to the web service. 

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="unt_20">

<wsse:Username><User name></wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"><Password></wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

The SOAP body contains the information and data of the file for transfer to the web service.

The Export Batch DMZ service expects the following <soapenv:Body> for the Upload method. 

(ExportBatchRequest2 instance in public ExportBatchResponse2 Upload(ExportBatchRequest2 request))

As per WSDL, the ExportBatchElement2 has the following schema:

<xs:complexType name="ExportBatchRequest2">

< xs:sequence>

<xs:element type="xs:string" name="BatchId" nillable="true" minOccurs="0"/>

<xs:element type="xs:base64Binary" name="File" nillable="true" minOccurs="0"/>

<xs:element type="xs:string" name="FileName" nillable="true" minOccurs="0"/>

<xs:element type="xs:string" name="FileType" nillable="true" minOccurs="0"/>

</xs:sequence>

</xs:complexType>
Public Health Information System (PHIS) Export Batch User Guide

86

Note: Please make sure that all ExportBatchElement2 elements are specified in required order as below.

<soapenv:Body>

<NS1:Upload xmlns:NS1="http://schemas.fsis.usda.gov/2017/12/Phis/BatchProcessing">

<NS1:request>

<NS1:BatchId><client batch GUID></NS1:BatchId>

<NS1:File><file content as Base64></NS1:File>

<NS1:FileName><file name with extension></NS1:FileName>

<NS1:FileType><file type: zip or xml></NS1:FileType>

</NS1:request>

</NS1:Upload>

</soapenv:Body>

Example of a machine-to-machine request

<?xml version="1.0" encoding="utf-8"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="unt_20">

<wsse:Username>85765342BBFQ8686Z830797865432491K</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">857F85609870NV6A59304643EF32TR74</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<NS1:Upload xmlns:NS1="http://schemas.fsis.usda.gov/2017/12/Phis/BatchProcessing">
Public Health Information System (PHIS) Export Batch User Guide

87

<NS1:request>

<NS1:BatchId>999ZZ999-9999-9Z9Z-9999-999ZZ9ZZ9Z99</NS1:BatchId>

<NS1:File>UEsDBBQACAgIALWAKUwAAAAAAANy54bWztWFuTokYUft9f0TUPW8mD0qCoZHuptNCOZBAsLs7OvjHazlCr4AImMb8+pxEVR52d1NTUJqnlqftc2nP5vtMgYcnvfJGPjVd

gwmR80FE1TO1dozLNlnOdxmny88ng0Q7dZXHC0PeJK0olUuUtPTnXSIp7H06gAV7aM4oX+R7xYxNGyeb/JEv5rscnTpDlNl0Q6NSXsz1WaFXS1WlRyDXdwfkFexh6LXbTwi6jgSw4Rvf+6TosP

Y2rcWM41MmnA/F8QViVZlhQsd1EDyVjCrXLzLhgyNPZcMzQCdEv9as1MFDom8xBFfcYGiH0au16AJsyzBpZBA8t10E99NvlZ2F97dISCId0eQEPTCpj5jjomomNQT+Cw/h0SPxQ6QoX8QMSE

TDamXjBiToDcAaLXnmWEdhB67H20SvMPfk1EbTSi3g0LREY+8yaWwbZpQvnPlIBUhTpaDuIsL5xoyfXbbUPA91R3sLejStQXfasZ7xU12d5PhBJapq5q5kBpM9wYmGqr0R5Q3GAyxo0ehoe2VK

xQde+/cyJGugYYbdy5yfMiTkqF7nwm0lnFwXwAosVFnxPtKZxoUUTTR1G8XBLnJnn8kKTZ1o5nAGuRcHDnQ+cHHvOHaMRo4CPLMZoA5G3lZrMMmLBf2HHCZR0Sho6zCXMAXQJFpmdN

WNm3gxEx4mKjm/TGDSgyQ4f5EL4Q7VLUQ3+fkE7GaV5ECyOdcV3t4rZGpJqElDhws4BnQNkU7H2TSCfCfQS6OPgk3+2Kwan3izgvK+Osl/egmsjdjtKhRLpsQiyDZ8DtzQGSIx4VRDqV72rNub

U8qrVDbftOFDhgnlNSjtrPV9qQXOiK9Rvw1nKeFri2U/RWC8vIR4bH7qCHHhDUNmFUGD3tyE2p+kJD48YGQj/tSQ1kxz1pd9rfaAkNb17Wk3pd/Md4JYoWbGCao90jw0F1BfHX98u40OfRIgfaVj

sSpBCNw4tbHj88FlYyhsBnORzTVmUVNwUtiXTB6MT5Jl6kD1m0FP6yhsG/d9b/YEfCJP665tYMwoShD+kwrCodGAmyGMREOtGTMJ9FW4yNouzLIWEFjI9VAkRFBB3L8tpaLJdLnk1jmI0c4tq

CU5HhUUSBzyhrLvtzKtWIMk9WWm2109Xq3k/tytbtIpDqkZ29xMZZOltPi2+oQXvKMzfZaUdKWwV2PGtDBln6F0/8R76Y+8KO60W2BoScyskwmk5XBqDzQcAStwwiHYuI4EeVcB2JNTEZRc

UagL2xAdDBY5S08AiK8ZhXP3tRTfYAcud2Wocq6gDKKqheMDpxrkMVKV1Fbqpn/WtQrSo3H0fTL9EDz60ELA5ptsD5rAWpSl1y3sQylg0Y9HXhzqIcYwPP/cyc7RtG4FmjEdzuMPD6Y7jibWbA

q8LeeTv2qo24KdtGj2nYoI2O2u82sNzS6tcrHsitnrH3Lq9WMSNWcfKwY9gWYoI+eUlFRbpl9naUXDIj/opPY57rfc7nYFrtiBg7T2vR/wTT4Ix8d21chPl/nQTKW5NAxq8kQVttqU3tVSSAG+OlJGjLd

PhPSfAN3Msd7Qfuj3FvfHfct94c9/Jrca/1tFcO/++N+94P3P/b5n37zV961Ne+9Cid7ivnPVw6L8M9kLRLjRfi3hjChxXyXNtGKGz6TbNJmyB0LYMh10ND63rIvOc4AXNPZUrDgI+IBsaM/U848aw6v

6S/JC8ddv8B/g1QSwcIhiXciB8FAAAOFAAAUEsBAhQAFAAICAgAtYApTIYl3IgfBQAADhQAABQAAAAbAAAAAAAAAAAAAAAAsdjwslnlAKJNLCBAAGEFAAAAAA==</NS1:File>

<NS1:FileName>test.zip</NS1:FileName>

<NS1:FileType>zip</NS1:FileType>

</NS1:request>

</NS1:Upload>

</soapenv:Body>

</soapenv:Envelope>
Public Health Information System (PHIS) Export Batch User Guide

88

Appendix E: Service Calls and Responses

This appendix explains the available methods that can be called using Batch Machine-to-Machine including the parameters in the 

requests and responses. For technical assistance, contact the FSIS Service Desk at 1-800-473-9135, 24 hours a day/7 days a week.

Method Name Action Fields and Format in the 

Request

Fields and Format in the Response Response 

XML

Upload Used to upload a 

new batch file 

that containing 

application 

details.

ExportBatchRequest2: The name of 

the request object being sent to the 

service. It contains the following:

• BatchId: Global unique ID of 

the batch. (Type: String) 

• FileName: The name of the file 

that is being sent to the service. 

(Type: String)

• File: The file being sent to the 

service. (Type: Byte)

• FileType: The type of the file 

being sent to the service. (Type: 

String)

ExportBatchResponse2: The name of the 

response object being sent from the service. It 

contains the following:

• BatchId: Global unique ID of the batch. 

(Type: String)

• Status: The current status of the batch. 

(Type: String)

• ResponseSuccessMessages: The success 

message related to the batch if applicable. 

(Type: mileStoneStatus2)

• ResponseFailureMessages: The failure 

message related to the batch if applicable. 

(Type: mileStoneStatus2)

• LogMessageXml: Empty when calling 

Upload Method. (Type: String)

Upload Output.xml
Public Health Information System (PHIS) Export Batch User Guide

89

Method Name Action Fields and Format in the 

Request

Fields and Format in the Response Response 

XML

GetStatus Retrieves the 

status of a batch 

import based on 

the ID of the 

batch.

ExportBatchRequest2: The name of 

the request object being sent to the 

service. It contains the following:

• BatchId: Global unique ID of 

the batch. (Type: String)

• FileName: The name of the file 

that is being sent to the service. 

(Type: String)

• File: The file(s) being sent to 

the service. (Type: Byte)

• FileType: The type of the file 

being sent to the service. (Type: 

String)

ExportBatchResponse2: The name of the 

response object being sent from the service. It 

contains the following:

• BatchId: Global unique ID of the batch. 

(Type: String)

• Status: The current status of the batch. 

(Type: String)

• ResponseSuccessMessages: The success 

message related to the batch if applicable. 

(Type: mileStoneStatus2)

• ResponseFailureMessages: The failure 

message related to the batch if applicable. 

(Type: mileStoneStatus2)

• LogMessageXml: For GetStatus Method 

this will contain details of the application 

including error and milestone logs in XML 

format. (Type: String)

Get Status 

Output.xml

GetBatchXsd Retrieves the 

XSD file that is 

used to validate 

incoming batch 

XML files.

No details required. Returns a string containing the contents of the 

XSD. The XSD defines what elements and 

attributes may appear in the XML applications. 

It also defines the relationship of the elements 

and what data may be stored in them.

Get Batch XSD 

Output.xml

GetApplicationStatus This is a 

placeholder.

Not Currently Implemented. Not Currently Implemented.
Public Health Information System (PHIS) Export Batch User Guide

90

Method Name Action Fields and Format in the 

Request

Fields and Format in the Response Response 

XML

GetBatchApplications Retrieves a list of 

applications 

associated with 

the given batch 

identifier.

The request being sent contains the 

following parameters: 

• PhisId: The current user’s PHIS 

ID. (Type: String)

• BatchIdentifier: The unique 

identifier of the batch. (Type: 

String)

ApplicationsearchResult2 – The name of the 

response object in the list. It contains the 

following:

• ApplicationIdentifier: The unique identifier 

for the application. This property is set by 

the industry when the application is 

uploaded via batch. (Type: String)

• ApplicationNumber: The PHIS application 

number, used as a human-readable unique 

identifier within the PHIS web. (Type: 

String)

• ApplicationType: The application type, i.e.,

New, Cancel, Consolidate, Replacement, 

Split, Update. (Type: String)

• AttachmentCount: The number of the 

attachments associated with the current 

application. (Type: Int)

• CurrentState: The current status of the 

application i.e., Unsubmitted, Submitted, 

Reviewed by PHV, Signed by First PHV, 

Pending Upload, Approved, Rejected. 

(Type: String)

• DateOfRequest: The date and time of the 

application request. (Type: DateTime)

• LastUpdatedTimestamp: The date and time 

when the application was last 

updated/modified. (Type: DateTime)

• OriginalCertificateNumber: The original, 

approved certificate number for 

replacements, splits and consolidations. 

(Type: String)

• Submitted: Represents whether or not the 

application was sent in as submitted. (Type: 

Bool)

Get Batch 

Applications Output.xml
Public Health Information System (PHIS) Export Batch User Guide

91

Method Name Action Fields and Format in the 

Request

Fields and Format in the Response Response 

XML

GetBatchUploads Retrieves a list of 

batches that were 

sent by the 

current user.

The request being sent contains the 

following parameters: 

• PhisId: The current user’s PHIS 

ID. (Type: String)

BatchSearchResult2 – The name of the response 

object in the list. It contains:

• BatchIdentifier: The unique identifier for 

the current batch. (Type: String)

• Name: The name of the batch file uploaded. 

(Type: String)

• ReceivedOn: The date and time when the 

current batch was received. (Type: 

DateTime)

Get Batch Upload 

Output.xml

GetStatements The method is 

used to get list of 

Statements for a 

specific country 

and list of 

species. If list of 

species is not 

passed, method 

will return all 

statements for 

that country.

The request contains the following 

parameters:

• Int CountryId: ID specific to 

country needs to be passed to 

get statements specific to that 

country.

• String lstSpeciesId: This 

parameter should have comma 

separated list of IDs

corresponding to Species.

Statements: The name of the object returned by 

the function/method GetStatements. It will 

contain the following:

• int StatementID: The statement version 

identifier.

• int StatementVersionID: The statement 

version identifier.

• string Name: The statements name.

• string Code: The statements code.

• decimal SortOrder: The statements sort 

order.

• string CustomPlaceHolderInfo: 

CustomPlaceHolderInfo related to the 

Statement.

XML returned by 

Statements method.xml