API Documentation
The Web API accepts a POST request to http://api.immunicalc.tempsite.nz with a JSON object in the POST request body. The result is returned as a JSON object. All dates are formatted in yyyy-mm-dd format.
GET /v1/Antigens
Response object
| antigens | List of available antigens | Array of AntigenRecord |
AntigenRecord
| code |
Antigen code (e.g. "Hib") |
string |
| name |
Antigen name (e.g. "Haemophilus influenzae type b") |
string |
| components |
Optional components to the antigen. Requests may be delivered using the parent object (e.g. MMR) or individual components (e.g. Measles) |
Array of AntigenRecord |
POST /v1/Calculate
Request object
| dob |
Date of Birth |
date |
Y |
| presentation_date |
Date at Presentation, defaults to current date |
date |
N |
| name |
Patient’s name |
string |
Y |
| immunisations |
List of previous immunisations |
Array of ImmunisationRecord |
Y |
ImmunisationRecord
| date |
Date of Immunisation |
date |
Y |
| antigens |
List of antigens administered |
Array of string |
Y |
Response object
| schedule |
List of required immunisations |
Array of ScheduleRecord |
| notes |
Any explanatory notes |
Array of string |
ScheduleRecord
| interval |
Interval from current start date for immunisation to be administered. ISO 8601 formatted |
string |
| date |
Date for immunisation if vaccination started at start date |
date |
| antigens |
List of required antigens |
Array of ScheduleAntigen |
ScheduleAntigen
| antigen |
The antigen to administer (e.g. "HepB") |
string |
| enter_as |
The entry to record (e.g. "15 Months") |
string |