Spreadsheet: 627facb1-343f-483e-8091-acd1f0568473
Sheet: Sheet1

Modified to include changes effective with July 1, 2011 ENCOUNTER DATES | Unnamed: 1 | Unnamed: 2 | Unnamed: 3 | Unnamed: 4 | Unnamed: 5 | Unnamed: 6 | Unnamed: 7
XML Element | Attributes | Description | Data Element | Valid Values | Data Type | Field Size | Data  Required
A header is required at the beginning of each XML file as follows: <?xml version="1.0" encoding="UTF-8" ?>
<submission> | Opening tag is required.
 | type | Describes the setting for which data is being submitted. |  | OUTPATIENT | Character | 20 | Yes
 | data | Describes the type of data being submitted. |  | CLINICAL | Character | 20 | Yes
 | version | The version of the file layout. |  | 1 | Character | 20 | Yes
 | action-code | Describes the intended action of the file being submitted |  | DELETE, ADD | Character | 20 | Yes
<file-audit-data> Sub-element of the submission data element | Opening tag for file audit data | Note:  This tag and the entire <file-audit-data> section are optional in the XML document.  If submitted, this tag contains no data.  Required if sub-elements are included.
<create-date> Sub-element of the file audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                                                                   Example with data:                                                                                                                                                                                                                                                                                                                                             <create-date>05-10-2007</create-date>
 |  | The month, day, and year the file was created |  | MM-DD-YYYY                                            (Must be a valid date) | Date | 10 | No
<create-time> Sub-element of the file audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                                                                   Example with data:                                                                                                                                                                                                                                                                                                                                             <create-time>23:01</create-time>
 |  | The hour and minutes representing the time the file was created. |  | HH:[NAME] (Military format with or without colon) | Time | 5 | No
<create-by>                 Sub-element of the file audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                              <create-by>VendorA</create-by>
 |  | The entity who created the file |  |  | Character | 50 | No
<version>                      Sub-element of the file audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                              <version>1.0</version>
 |  | The version of the file being submitted |  |  | Character | 20 | No
<create-by-tool>              Sub-element of the file audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                               <create-by-tool>OPPS 1.3</create-by-tool>
 |  | Tool used to create the XML file |  |  | Character | 50 | No
</file-audit-data> | Closing tag for file audit data | Note: This tag and the entire <file-audit-data> section are optional in the XML document, but if the opening tag of <file-audit-data> is provided, then this closing tag is required as well.
<abstraction-audit-data> Sub-element of the submission data element | Opening tag for abstraction audit data | Note:  This tag and the entire <abstraction-audit-data> section are optional in the XML document.  If submitted, this tag contains no data.   Required if sub-elements are included.
<abstraction-date> Sub-element of the abstraction audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                                                                   Example with data:                                                                                                                                                                                                                                                                                                                                             <abstraction-date>05-10-2007</abstraction-date>
 |  | The month, day, and year the XML file was abstracted |  | MM-DD-YYYY                                            (Must be a valid date) | Date | 10 | No
<abstractor-id> Sub-element of the abstraction audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                                                                   Example with data:                                                                                                                                                                                                                                                                                                                                             <abstractor-id>JSMITH</abstractor-id>
 |  | User id of who abstracted this encounter. |  |  | Character | 20 | No
<total-abstraction-time>                 Sub-element of the abstraction audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                              <total-abstraction-time>1125</total-abstraction-time>
 |  | Total time it took for the encounter to be abstracted. |  | Time in seconds | Number | 22 | No
<comment>                      Sub-element of the abstraction audit data element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                              <comment>Information about the abstraction</comment>
 |  | Comments about the abstraction. |  | Text | Character | 4000 | No
</abstraction-audit-data> | Closing tag for abstraction audit data | Note:  This tag and the entire <abstraction-audit-data> section are optional in the XML document, but if the opening tag of <abstraction-audit-data> is provided, then this closing tag is required as well.
<provider> Sub-element of the submission data element | Opening tag for provider | Note:  This tag is required in the XML document, however, it contains no data.
<provider-id>                                         Sub-element of the provider element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                               <provider-id>125789</provider-id>
 |  | Used to identify the provider | CMS Certification Number | Valid 6 digit CMS Certification Number | Character | 6 | Yes
<npi>                               Sub-element of the provider element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                  Example with data:                                                                                                                                                                                                                                                              <npi>[PHONE]</npi>
 |  | National Provider Identifier as assigned by CMS | National Provider Identifier (NPI) | Valid 10 digit NPI Number | Character | 10 | No
<patient> Sub-element of the provider data element | Opening tag for patient | Note:  This tag is required in the XML document, however, it contains no data.
<first-name> Sub-element of the patient element | Each element must have a closing tag that is the same as the opening tag but with a forward slash. Example with data: <first-name>Ann</first-name>
 |  | The patient’s first name | First Name | Patient's First Name | Character | 30 | No
<last-name> Sub-element of the patient  element | Each element must have a closing tag that is the same as the opening tag but with a forward slash. Example with data: <last-name>Smith</last-name>
 |  | The patient’s last name | Last Name | Patient's Last Name | Character | 60 | No
<birthdate>                                                                               Sub-element of the patient  element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                        Example with data:                                                                                                                                                                                                                                                                                                                          <[NAME]1964</birthdate>
 |  | The month, day, and year the patient was born | Birthdate | MM-DD-YYYY                                            (Must be a valid birthdate and cannot equal UTD) | Date | 10 | Yes
<sex>                                                  Sub-element of the patient element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                            Example with data:                                                                                                                                                                                                                                                                      <sex>M</sex>
 |  | The patient's sex | Sex | M,F,U | Character | 1 | Yes
<race>                                                               Sub-element of the patient element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                           Example with data:                                                                                                                                                                                                                                                                      <race>2</race>
 |  | Documentation of the patient’s race. | Race | 1,2,3,4,5,7 | Number | 1 | Yes
<ethnic>                           Sub-element of the patient element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                    Example with data:                                                                                                                                                                                                                                                              <ethnic>Y</ethnic>
 |  | Documentation that the patient is of Hispanic or Latino ethnicity | Hispanic Ethnicity | Y,N | Character | 1 | Yes
<postal-code>                      Sub-element of the patient element | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                             Example with data:                                                                                                                                                                                                                                                                                       <postal-code>50266</postal-code>
 |  | The postal code of the patient's residence. For the United States zip codes the hyphen is implied. If the patient is determined to not have a permanent residence, then the patient is considered homeless. | Postal Code | (5 or 9 digit without hyphen, "homeless", or "Non-US") | Character | 9 | Yes
<encounter> Sub-element of the patient element | Opening tag for outpatient measure set | Example with data:  <encounter measure-set="HOP-SURGERY">
 | measure-set | The code for the outpatient measure set submitted. | Outpatient Measure Set | HOP-AMI HOP-CHEST PAIN HOP-SURGERY | Character | 22 | Yes
<encounter-date> Sub-element of the encounter | Each element must have a closing tag that is the same as the opening tag but with a forward slash. Example: <encounter-date>04-02-2008</encounter-date>
 |  | The month, day, and year the patient was seen in the hospital outpatient department. | Outpatient [NAME] | MM-DD-YYYY (Must be a valid date and cannot equal UTD) | Date | 10 | Yes
<arrival-time> Sub-element of the encounter | Each element must have a closing tag that is the same as the opening tag but with a forward slash. Example: <arrival-time>15:14</arrival-time>
 |  | The earliest documented time (military time) the patient arrived at the outpatient or emergency department. | [NAME] | HH:[NAME] (Military format with or without colon or can equal UTD) | Time | 5 | Yes
<pthic>                                                                      Sub-element of the encounter | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                                                         Example with data:                                                                                                                                                                                                                                                                     <pthic>123456789A</pthic>
 |  | HIC # of the patient | Patient HIC# | ·  No embedded dashes or spaces or special characters ·  Must have both alpha and numeric characters ·  [NAME] characters must be upper case ·  [NAME] cannot be more than 12 or less than 7 characters ·  For alphanumeric, do not allow all Numeric values to be 9’s. For example do not allow 1 alpha + 999999999, etc. | Character | 7-12 | No
<patient-id> Sub-element of the encounter | Each element must have a closing tag that is the same as the opening tag but with a forward slash.                                                                                                                                                                       Example with data:                                                                                                                                                                                                                                                                                                                               <patient-id>74185296374185296385</patient-id>
 |  | Identifer used to identify the patient at the hospital | Patient Identifier | Up to 40 characters. | Character | Up to 40 | Yes
<detail>                              Sub-element of the encounter | Since this is the opening element, the closing tag for this element will be at the end of the record. Attributes describe the element and are included within the opening and closing <> Example of Yes/No question (refer to Table A for valid answer codes): For discharges 4/1/2008 and forward: <detail answer-code="Y" row-number="0" question-cd="CXRAY"> Example of multiple choice question (refer to Table A for valid answer codes): <detail answer-code="3" row-number="0" question-cd="CTRACEI"> Example of a user-entered code:  <detail answer-code="001.9" row-number="0" question-cd="OTHRDX#">
 | answer-code | ID number of the answer | Not a data element itself; each possible answer has its own unique ID | Refer to Table A for valid values | Character | See specific element for field size limits | Yes
 | question-cd | The field name of the question | Not a data element itself; each data element is a question code | Refer to Table A for valid values | Character | 20 | Yes
 | row-number | Used to group answers together for multi-row, multi-column answers | Not a data element; used for grouping answers only | 0-20 Depending on the number of rows allowed per question.  i.e. Surgery Antibiotic Name would have row-number 0 for the first antibiotic, 1 for the second antibiotic, and so on. | [NAME] | 2 | Yes  Default to 0. For mulitiple answer options, add 1 to the row number for each additional answer
<answer-value> Sub-element of detail | The answer value             Example: <answer-value>No</answer-value> | The description of the answer-code | Not a data element itself; each answer has a value | Place the answer text here. Examples: Yes No Male Female 04-01-2008  23:00 Note: All Dates & Times in this field should be formatted as MM-DD-YYYY  and military format with or without colon for HH:MM. | Character | 2000 | No
</detail> | Closing tag for detail | Note:  This tag is required in the XML document, however, it contains no data.
</encounter> | Closing tag for encounter | Note:  This tag is required in the XML document, however, it contains no data.
</patient> | Closing tag for patient | Note:  This tag is required in the XML document, however, it contains no data.
</provider> | Closing tag for provider | Note:  This tag is required in the XML document, however, it contains no data.
</submission> | Closing tag for submission | Note:  This tag is required in the XML document, however, it contains no data.