Introduction
This page provides details of the member database (MDB) file specification to be used when submitting member data to Healthcode.
File Naming
The following filename convention should be used:
MDBYYDDD.csv
Where:
MDB:
Identifies the file type as Member DatabaseYY:
The year of submissionDDD:
The Julian Day of the year
File Format
Membership data will be transferred in CSV format conforming to the following rules:
- The file will be encoded using UTF-8
- Columns will be separated with
,
(x2C) - String values will be delimited with
"
(x22) - Date and Date/Time values will be in ISO 8601 format
- Each row will be terminated with Carriage Return & Linefeed (x0D + x0A) characters
- The first row will contain column headers. The column headers you use in your CSV must match exactly the ‘Column Header’ value below. (Case Sensitive).
- Optional fields that have no value specified should be omitted. (The column header must be included. A comma separator must be included for any omitted fields).
Each data row will contain the following columns:
Column Header | Mandatory | Type | Max. Size/Format | Description |
---|---|---|---|---|
MembershipID | Yes | String | 50 | Insurers unique identifier for this member |
GroupPolicyID | No | String | 50 | Identifier for this member’s policy, where the member is part of a group policy |
FamilyName | Yes | String | 50 | Members family name |
GivenName | Yes | String | 50 | Members given or first name |
OtherInitials | No | String | 50 | Members other initials or names |
BirthSex1 | Yes | String | 1 | Members sex at birth: M – Male, F – Female, O – Other, U – Unknown |
DateofBirth | Yes | Date | YYYY-MM-DD | Members date of birth |
AddressLine1 | Yes | String | 50 | Members Address |
AddressLine2 | Yes | String | 50 | |
AddressLine3 | No | String | 50 | |
AddressLine4 | No | String | 50 | |
Postcode | Yes | String | 10 | Members Postcode |
Country | No | String | 2 | 2 Alpha Country Code, conforming to ISO-3166 |
CoverStartDate | Yes | Date | YYYY-MM-DD | The date on which cover for this member started |
CoverEndDate | Yes | Date | YYYY-MM-DD | The date on which cover for this member ends |
LapsedIndicator | No | String | 1 | Indicates that cover has lapsed (Y or N) |
LapsedDate | No | Date | YYYY-MM-DD | The date on which cover lapsed |
PolicyScheme | No | String | 50 | Policy scheme to which this group/member belongs |
DoNotReject | No | String | 1 | An indicator (Y/N) specifying that bills for this member should never be rejected based on information in this record. |
GenderIdentity2 | No | String | 1 | The gender by which the member prefers to be identified: 1 – Male (including trans man) 2 – Female (including trans woman) 3 – Non-binary 4 – Other Z – Not Stated |
Currency | No | String | 1 | ISO-4217 3 character currency code of the monetary values in this record |
BenefitLimit | No | Decimal | NNNNNNNN.NN | The maximum benefit available to the member on this policy |
BenefitConsumed | No | Decimal | NNNNNNNN.NN | The amount of benefit already used by this member on this policy |
BenefitConsumedAsOf | No | Date/Time | YYYY-MM-DDTHH:MM:SS | The date/time on which the consumed benefit amount was calculated. |
Excess | No | Decimal | NNNNNNNN.NN | The total amount of excess to be paid by the member on this policy |
ExcessApplicableTo | No | String | 1 | The period over which the excess amount is applicable P – Policy Period C – Each Claim/Episode |
ExcessPaid | No | Decimal | NNNNNNNN.NN | The amount of excess already paid by the member on this policy. |
ExcessPaidAsOf | No | Date/Time | YYYY-MM-DDTHH:MM:SS | The date/time on which the paid excess was calculated. |
CoPayment | No | Decimal | NNNNNNNN.NN | The amount to be paid by the member under any policy co-payment arrangement. Assumed to be ‘Per Claim’ |
CoPaymentType | No | String | 1 | M – Monetary Value P – Percentage |
- BirthSex is aligned with the NHS Data Model item PERSON STATED GENDER CODE ↩︎
- GenderIdentity is aligned with the NHS Data Model item GENDER IDENTITY CODE ↩︎