Get Immunization

GET {{baseUrl}}/api/v2/ReferenceData?searchString=anthrax&resourceType=immunization

Overview:

This API takes an input parameter resourceType that has value 'immunization', and returns immunization-related data from systems like CVX. Based on the input, the API provides a paginated response containing details of vaccines, including their names, codes, and manufacturers.

Example Response:

• CVX: Returns vaccine information, including the vaccine name (e.g., anthrax vaccine), CVX code, type (TTY), and manufacturer details (e.g., Emergent BioSolutions).

Use Cases:

• Populating Immunization Resources: This API can be used to retrieve relevant vaccine information, such as CVX codes and manufacturer details, for creating or updating Immunization resources in healthcare systems.

• Standardizing Vaccine Data: The API helps standardize immunization records by using CVX codes, ensuring consistent and accurate vaccine data across healthcare systems.

• Supporting Immunization Tracking: Healthcare providers and systems can utilize this API to track, record, and manage immunization details for patients, ensuring that the correct vaccine information is captured and shared.

Request Params

HEADERS

RESPONSES

status: OK

{"context":{"system":"\u003cstring\u003e","category":"\u003cstring\u003e"},"data":{"pagination":{"count":"\u003cinteger\u003e"},"result":[{"STR":"\u003cstring\u003e","CODE":"\u003cstring\u003e","TTY":"\u003cstring\u003e","MANUFACTURER":"\u003cstring\u003e"},{"STR":"\u003cstring\u003e","CODE":"\u003cstring\u003e","TTY":"\u003cstring\u003e","MANUFACTURER":"\u003cstring\u003e"}]}}