Get Immunization
GET {{baseUrl}}/api/v2/Immunization?patient=<integer>&departmentId=<integer>
Overview
Retrieves detailed information on patient immunizations, enabling healthcare developers to access and display real-time data regarding vaccination records for streamlined tracking and analysis within clinical workflows.
Use Cases:
Retrieve Immunization Record: Obtain patient vaccination details
Access Vaccine History: Retrieve vaccination records
Query Immunization Dates: Obtain specific vaccination dates
Review Vaccine Types: Access information on vaccine types
Examine Dose Details: Retrieve details on vaccine doses
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the immunization record. | |
departmentId | string | (Required) The department identifier |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"performer":[{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}},{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}}],"manufacturer":{"identifier":{"value":"\u003cstring\u003e"}},"status":"\u003cstring\u003e","occurrenceDateTime":"\u003cdateTime\u003e","statusReason":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"education":[{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"}],"route":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},"site":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","unit":"\u003cstring\u003e"},"recorded":"\u003cdateTime\u003e","expirationDate":"\u003cdate\u003e","lotNumber":"\u003cstring\u003e","primarySource":"\u003cboolean\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"performer":[{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}},{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}}],"manufacturer":{"identifier":{"value":"\u003cstring\u003e"}},"status":"\u003cstring\u003e","occurrenceDateTime":"\u003cdateTime\u003e","statusReason":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"education":[{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"}],"route":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},"site":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","unit":"\u003cstring\u003e"},"recorded":"\u003cdateTime\u003e","expirationDate":"\u003cdate\u003e","lotNumber":"\u003cstring\u003e","primarySource":"\u003cboolean\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"}]}}],"meta":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"performer":[{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}},{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}}],"manufacturer":{"identifier":{"value":"\u003cstring\u003e"}},"status":"\u003cstring\u003e","occurrenceDateTime":"\u003cdateTime\u003e","statusReason":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"education":[{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"}],"route":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},"site":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","unit":"\u003cstring\u003e"},"recorded":"\u003cdateTime\u003e","expirationDate":"\u003cdate\u003e","lotNumber":"\u003cstring\u003e","primarySource":"\u003cboolean\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","vaccineCode":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"patient":{"reference":"\u003cstring\u003e"},"performer":[{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}},{"actor":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e"},"function":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}],"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]}}],"manufacturer":{"identifier":{"value":"\u003cstring\u003e"}},"status":"\u003cstring\u003e","occurrenceDateTime":"\u003cdateTime\u003e","statusReason":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"education":[{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","presentationDate":"\u003cdate\u003e"}],"route":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},"site":{"coding":[{"display":"\u003cstring\u003e"},{"display":"\u003cstring\u003e"}]},"doseQuantity":{"value":"\u003cnumber\u003e","unit":"\u003cstring\u003e"},"recorded":"\u003cdateTime\u003e","expirationDate":"\u003cdate\u003e","lotNumber":"\u003cstring\u003e","primarySource":"\u003cboolean\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDateTime":"\u003cdateTime\u003e"}]}}],"meta":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}}]