1.3) Claim Submission
Claim can be submitted online to NHIF by creating a Jason payload. This payload can contain one or more folios (At least one folio) and associated details. So it will always be a collection of folio objects even if only one folio is to be submitted. The sample JSON data to be submitted can be provided by the Fund upon request and the information in the JSON payload is as follows:
(i) Folio
FieldName | Description | Data Type | Example |
---|---|---|---|
FolioID | Primary Key for a folio of visit | GUID | 817d6e75-3bef-4d25-a2e1-a3bc009530ab |
FacilityCode | Unique identification number issued by NHIF to a particular health facility as part of the registration process | Text | 01099 |
ClaimYear | Claim’s calendar year int 2020 ClaimMonth Month of claim Int 12 FolioNo A unique sequential number | Int | 1 |
SerialNo | A Serial number as provided in NHIF 2A&B form | Text | 01099\ 2\2020\00001 |
CardNo | Number of NHIF Beneficiary’s Cards | Text | 109900035308 |
FirstName | Card holder’s First Name | Text | Amour |
LastName | Card holder’s Last Name | Text | Rashid |
Gender | Card Holder’s Gender | Text | Male |
DateOfBirth | Card Holder’s Date Of Birth | Date | 18/03/2020 |
TelephoneNo | Text | 0686155255 | |
PatientFileNo | Patient’s File number as recorded by the Hospital or other health facility | Text | MNH/03/99999 |
PatientFile | A PDF of the patient treatment details serialized as Base 64 string | Text | |
AuthorizationNo | Authorization number issued during member verification | Text | 187870908768 |
AttendanceDate | The date that the patient attended for service | Date | 07/03/2020 |
PatientTypeCode | IN PATIENT or OUTPATIENT | Text | OUT or IN |
DateAdmitted | If patient was admitted then the admission date otherwise null |
Date | 07/03/2020 |
DateDischarged | If patient was admitted then the discharge date otherwise null |
Date | 08/03/2020 |
PractitionerNo | The Registration number of the medical practioner attending the patient as registered by the Medical council of Tanganyika | Text | 2999999 |
CreatedBy | User who Created the Entry in the HMIS | Text | ghaule |
DateCreated | The Date the entry was created | Date | 07/03/2020 |
(ii) FolioDisease
FieldName | Description | Data Type | Example |
---|---|---|---|
FolioDiseaseID | Primary Key for a folio of visit | GUID | e9429e1c-f892-40ae-8c0a-a3bc0095681f |
FolioID | The ID of the folio associated to this diese | GUIN | 817d6e75-3bef-4d25-a2e1-a3bc009530ab |
DiseaseCode | Disease code as identified by WHO(Currently ICD 9) | Text | 084 |
CreatedBy | User who Created the Entry in the HMIS | Text | |
DateCreated | The Date the entry was created | Date | 07/03/ |
(iii) FolioItem
FieldName | Description | Data Type | Example |
---|---|---|---|
FolioItemID | Primary Key for a service or item issued to the patient. This could be a medicine,procedure,s urgery,or consumables | GUID | e9429e1c-f892-40ae-8c0a-a3bc0095681f |
FolioID | The ID of the folio associated to this Item or Service Issued | GUID | 817d6e75-3bef-4d25-a2e1-a3bc009530abItemCode |
ItemCode | used to identify each Item or Service in NHIF Database | Text | 5036 |
ItemQuantity | Number of Items Claimed | Int | 10 |
UnitPrice | Price for each Item | Decimal | 1500. |
AmountClaimed | Sub Total (ItemQuantity*UnitPrice)\ | Decimal | 15000. |
ApprovalRefNo | If the service requires Appeoval then supply the Aproval reference number issued to the patient to get this ervice. | Text NHIF/REF/ | 1000024 |
CreatedBy | User who Created the Entry in the HMIS | Text | ghaule |
DateCreated | The Date the entry was created | Date | 07/03/2017 |
The method that accepts json array that will contain one or more folios and uses POST method which can be access via the following url:
https://verification.nhif.or.tz/claimsserver/api/v1/Claims/SubmitFolios
The authentication used is a Token Authentication (Bearer Token). An Example is given in Java on how to call a method from the API. You will be give username and password for each facility that will be integrated with NHIF. This will help NHIF Systems to identify and authorize any API call before giving it access.
SAMPLE CODE FOR CALLING AN API USING JAVA
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
|
Using EntityBuilder
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
|
For a particular programming Language such as PHP, JavaScript, C# etc, Please send use a request to it@nhif.or.tz and we will send you the sample code.
SUBMITTING DOCUMENTS:
The field in the Folio Object in the JSON Schema with a name "PatientFile"
is supposed to contain the PDF Document that contain all details about the patient treatment for that particular folio. The document need to be submitted as Base 64 String. At the end, all the contents of the JSON document should be submitted as a single Complex object as given in sample document below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
|
The screenshot below shows the layout of the sample JSON document that can be posted on an NHIF API.
CLAIMS RECONCILIATION
You can call the API below to retrieve list of claims that have been successful received by NHIF for reconciliation purpose
1 2 |
|