From FreemedDeveloperWiki, the FreeMED developers' Wiki.
Version
This document describes version 0.2 of the REMITT XML specification.
Structure
<?xml version="1.0">
<remitt doctype="request">
<global> ... </global>
<billingcontact> ... </billingcontact>
<billingservice> ... </billingservice>
<clearinghouse> ... </clearinghouse>
<procedure id="id">
.
.
.
</procedure>
<patient id="id">
.
.
.
</patient>
<provider id="id">
.
.
.
</provider>
<insured id="id">
.
.
.
</insured>
<payer id="id">
.
.
.
</payer>
<practice id="id">
.
.
.
</practice>
<diagnosis id="id">
.
.
.
</diagnosis>
</remitt>
Primitives
address
| Field | Type | Description
|
| streetaddress | string (50) | Full street address
|
| city | string (50) | Full name of city
|
| state | string (3) | Abbreviation for state
|
| zipcode | string (9) | Postal code (zip or zip+4)
|
boolean
The boolean primitive contains either a 1 or a 0.
date
| Field | Type | Description
|
| year | string (4) |
|
| month | string (2) |
|
| day | string (2) |
|
monetary
The monetary type contains a number in the format XXXXXXXN.NN, where N represents a required digit and X represents an optional digit. It is used to represent monetary values.
name
| Field | Type | Description
|
| first | string
|
| middle | string
|
| last | string
|
object id
The object id primitive is the id attribute of the corresponding object in the flat XML file. It allows objects to directly reference other objects.
phone
| Field | Type | Description
|
| country | string (2) | Country code of phone number. In the United States, this is 1.
|
| area | string (3) | Area code of phone number
|
| number | string (7) | Phone number. This should be a numeric sequence of 7 numbers in the United States and Canada.
|
| extension | string (5) | Phone number extension. This is an optional field of up to five numbers.
|
string
The string primitive is a series of XML-valid alphanumeric characters. If non-alphanumeric characters are used, their valid XML numeric identities should be used, with the exception of &.
Objects
billingcontact
billingservice
clearinghouse
diagnosis
| Field | Type | Description
|
| icd9code
|
| icd10code
|
| relatedtohcfa
|
| isrelatedtoautoaccident | boolean
|
| autoaccidentstate
|
| isrelatedtoemployment | boolean
|
| dateofonset | date object
|
| dateoffirstappearance | date object
|
global
| Field | Type | Description
|
| generator | program and version fields
|
| currentdate | date object
|
| currenttime | time object
|
insured
| Field | Type | Description
|
| relationship | string (2) | Relationship to patient of insured person (see table)
|
| name | name object | Name of insured person
|
| address | address object | Address of insured person
|
| phone | phone object | Contact phone for insured person
|
| dateofbirth | date object | Date of birth of insured person
|
| sex | string (1) | Gender of insured person (m or f)
|
patient
| Field | Type | Description
|
| name | name object | Name of patient
|
| address | address object | Address of patient
|
| phone | phone object | Contact phone of patient
|
| sex | string (1) | Gender of patient (m or f)
|
| socialsecuritynumber | string (9) | Social security number of patient (all numbers)
|
| isdead | boolean | Is patient deceased?
|
| dateofbirth | date object | Death date for patient
|
| dateofdeath | date object | Birth date for patient
|
| ispregnant | boolean | Is patient pregnant?
|
| issingle | boolean | Is patient single?
|
| ismarried | boolean | Is patient married?
|
| ismarriedotherhcfa | boolean | Is patient not single or married according to HCFA form?
|
| isparttimestudent | boolean | Is patient a part-time student?
|
| isfulltimestudent | boolean | Is patient a full-time student?
|
| referringprovider | object id | Referring provider
|
| account | string | Patient account number in system
|
payer
| Field | Type | Description
|
| name | name object
|
| address | address object
|
| phone | phone object
|
| x12claimtype
|
| ismedicare | boolean
|
| ismedicaid | boolean
|
| ischampus | boolean
|
| ischampusva | boolean
|
| isbcbs | boolean
|
| isfeca | boolean
|
| isotherhcfa | boolean
|
practice
| Field | Type | Description
|
| id | id element
|
| groupid | groupid element
|
| name | string (50) | Practice name
|
| address | address object | Address of practice
|
| phone | phone object | Contact phone number
|
| x12id | string
|
| x12idtype | string
|
| ein | string (9) | Employer Identification Number
|
procedure
| Field | Type | Description
|
| cpt4code
|
| cpt5code
|
| cptcob
|
| cptcharges
|
| cptcount
|
| cptemergency
|
| cptepsdt
|
| cptmodifier | string |
|
| cptunits
|
| weightgrams | integer |
|
| patientkey | object id |
|
| insuredkey | object id |
|
| payerkey | object id |
|
| secondinsuredkey | object id |
|
| otherinsuredkey | object id |
|
| medicaidresubmissioncode
|
| medicaidoriginalreference
|
| hcfalocaluse19
|
| hcfalocaluse10d
|
| amountpaid
|
| providerkey | object id |
|
| facilitykey | object id |
|
| practicekey | object id |
|
| typeofservice
|
| priorauth
|
| isoutsidelab | boolean
|
| outsidelabcharges | monetary
|
| dateofservicestart | date object
|
| dateofserviceend | date object
|
| ishospitalized | boolean
|
| dateofhospitalstart | date object
|
| dateofhospitalend | date object
|
Tables
Relationship
| Value | Description
|
| S | Self
|
| C | Child
|
| H | Husband
|
| W | Wife
|
| D | Child, not Fin
|
| SC | Step-child
|
| FC | Foster-child
|
| WC | Ward of court
|
| HD | HC Dependent
|
| SD | Sponsored Dependent
|
| LR | Medicare Legal Representative
|
| O | Other
|
REMITT stands for "REMITT Electronic Medical Record Translation and Transmission", and is a recursive acronym. It is build primarily in Perl, but uses XSLT for all formatting and processing logic. The engine could theoretically be coded in any language, but Perl was chosen for speed of implementation.
Links
