{"openapi":"3.0.0","info":{"title":"1health.io Vaccine API","description":"1health.io Vaccine API","contact":{"email":"sglisic@1health.io"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"version":"1.0.0"},"servers":[{"url":"https://virtserver.swaggerhub.com/VitaDevs/Vaccine/1.0.0","description":"SwaggerHub API Auto Mocking"}],"tags":[{"name":"vaccine","description":"Vaccine related calls"},{"name":"patient","description":"Patient related calls"},{"name":"notifications","description":"Notifications related calls"}],"paths":{"/vaccine":{"post":{"tags":["vaccine"],"summary":"Creates vaccine","description":"Creates vaccine  inside 1health.io platform.\n","operationId":"create_vaccine","requestBody":{"description":"Vaccine to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vaccine"}}}},"responses":{"201":{"description":"vaccine created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing vaccine already exists"}}}},"/vaccine/vaccine_type":{"get":{"tags":["vaccine"],"summary":"List Vaccine Types","description":"List Existing Vaccine Types in 1health.io platform.\n","operationId":"get_vaccine_types","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaccineType"}}}}}}},"post":{"tags":["vaccine"],"summary":"Creates vaccine type","description":"Creates vaccine type inside 1health.io platform.\n","operationId":"create_vaccine_type","requestBody":{"description":"Vaccine to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccineType"}}}},"responses":{"201":{"description":"vaccine type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing vaccine type already exists"}}}},"/vaccine/vaccination_event":{"post":{"tags":["vaccine"],"summary":"Creates vaccination event","description":"Creates vaccination event.\n","operationId":"create_vaccination_event","requestBody":{"description":"Vaccination event to add.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccinationEvent"}}}},"responses":{"201":{"description":"vaccination event  id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"400":{"description":"invalid input, object invalid"}}}},"/vaccine/administration_site":{"get":{"tags":["vaccine"],"summary":"List Vaccine Administration Sites","description":"List Existing Vaccine Administration Sites in 1health.io platform.\n","operationId":"get_vaccine_administration_sites","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaccineAddministrationSite"}}}}}}},"post":{"tags":["vaccine"],"summary":"Creates vaccine administration site","description":"Creates vaccine administration site.\n","operationId":"create_vaccine_administration_site","requestBody":{"description":"Vaccine Admisistration Site to add.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccineAddministrationSite"}}}},"responses":{"201":{"description":"vaccine administration id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"400":{"description":"invalid input, object invalid"}}}},"/vaccine/vaccination_event/{vaccination_event_id}":{"get":{"tags":["vaccine"],"summary":"get vaccination event by id","description":"Get Vaccination Event\n","operationId":"get_vaccination_event","parameters":[{"name":"vaccination_event_id","in":"path","description":"Vaccination Event Id","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of patient's vaccination events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccinationEvent"}}}},"400":{"description":"bad input parameter"}}}},"/vaccine/vaccination_event/findByPatient":{"get":{"tags":["vaccine"],"summary":"get vaccination event by patient info","description":"Get Vaccination Event by Patient Info\n","operationId":"get_vaccination_event_by_patient_info","parameters":[{"name":"email","in":"query","description":"Patient's email","required":true,"style":"form","explode":true,"schema":{"type":"string","example":"johndoe@gemail.com"}}],"responses":{"200":{"description":"List of patient's vaccination events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccinationEvent"}}}},"400":{"description":"bad input parameter"}}}},"/patient/{patient_id}/vaccine/vaccination_event":{"get":{"tags":["patient"],"summary":"get vaccination events for patient","description":"Get Vaccination Events for Patient\n","operationId":"get_vaccination_events_patient","parameters":[{"name":"follow_up_if_not_exists","in":"query","description":"Should we follow up and get vaccination info if it is not available in our system?","required":true,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"user_consented","in":"query","description":"User agreed to provide vaccination information.","required":true,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"vaccine_type_id","in":"query","description":"Optionally choose specific vaccine type to get data for.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"patient_id","in":"path","description":"Patient Id","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of patient's vaccination events.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaccinationEvent"}}}}},"400":{"description":"bad input parameter"}}}},"/patient/{patient_id}/vaccine/vaccination_event/webhook":{"post":{"tags":["patient"],"summary":"Post vaccination event webhook","description":"Post vaccination event webhook in case vaccination events are not currently available.\n","operationId":"post_vacciation_event_webhook","parameters":[{"name":"patient_id","in":"path","description":"Patient Id","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Vaccination Event Webhook to add.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccinationEventWebhook"}}}},"responses":{"201":{"description":"vaccination event webhook id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"400":{"description":"invalid input, object invalid"}}}},"/vaccine/vaccination_event/{vaccination_event_id}/report":{"post":{"tags":["vaccine"],"summary":"Creates vaccination IIS report","description":"Creates vaccination IIS report.\n","operationId":"create_vaccination_iis_report","parameters":[{"name":"vaccination_event_id","in":"path","description":"Vaccination Event Id","required":true,"style":"simple","explode":false,"schema":{"type":"integer"}}],"requestBody":{"description":"Vaccination IIS report to add.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaccinationIISReport"}}}},"responses":{"201":{"description":"vaccination iis report created"},"400":{"description":"invalid input, object invalid"}}}},"/vaccine/vaers_report":{"post":{"tags":["vaccine"],"summary":"Submit VAERS Report","description":"Submit VAERS report.\n","operationId":"submit_vaers_report","requestBody":{"description":"Report to submit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VAERSReport"}}}},"responses":{"201":{"description":"vaers report submitted"},"400":{"description":"invalid input, object invalid"}}}},"/notifications":{"post":{"tags":["notifications"],"summary":"Creates Notification","description":"Creates Notification.\n","operationId":"create_notification","requestBody":{"description":"Notification to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}},"responses":{"201":{"description":"notification created"},"400":{"description":"invalid input, object invalid"}}}}},"components":{"schemas":{"Patient":{"required":["address","city","dob","email","ethnicity","name","phone","race","sex","state","surname","zip"],"type":"object","properties":{"name":{"type":"string","example":"John"},"surname":{"type":"string","example":"Doe"},"email":{"type":"string"},"dob":{"type":"string","example":"1970-05-21"},"sex":{"type":"string","example":"female"},"ethnicity":{"type":"array","example":["Hispanic or Latino","Not Hispanic or Latino","Other","Prefer not to answer"],"items":{}},"race":{"type":"array","example":["American Indian and Alaskan Native","Asian","Black or African American","Native Hawaiian and other Pacific Islander","Two or more races","White","Other","Prefer not to answer"],"items":{}},"state":{"type":"string","example":"CA"},"address":{"type":"string","example":"279 Stratford Boulevard"},"city":{"type":"string","example":"San Francisco"},"zip":{"type":"string","example":"44147"},"phone":{"type":"string","example":"4088675309"},"send_notifications":{"type":"array","example":["email","sms"],"items":{}}}},"Vaccine":{"required":["abbreviation","brand","manufacturer_id","name","type","vaccine_id"],"type":"object","properties":{"vaccine_id":{"type":"string","example":"COV-VaCC"},"name":{"type":"string","example":"Covid Vaccine"},"type":{"type":"string","example":"type-0"},"abbreviation":{"type":"string","example":"CV"},"brand":{"type":"string","example":"Flublok"},"manufacturer_id":{"type":"integer","example":89876}}},"VaccineType":{"required":["description","name"],"type":"object","properties":{"name":{"type":"string","example":"Covid Vaccine"},"description":{"type":"string","example":"Covid Vaccine Type"}}},"VaccinationEvent":{"required":["body_site","dose_in_series","lot_number","patient_id","route","use_vaccine_reporting","vaccination_date","vaccine_administration_site_id","vaccine_expiration_date","vaccine_id"],"type":"object","properties":{"vaccine_id":{"type":"integer","example":1123},"patient_id":{"type":"integer","example":3345},"vaccination_date":{"type":"string","format":"date-time","example":"2020-08-29T09:12:33.001Z"},"lot_number":{"type":"string","example":"lot-6868686868689"},"body_site":{"type":"string","example":"LA (left arm)","enum":["LT (left thigh)","LA (left arm)","LD (left deltoid)","LG (left gluteus medius)","LVL (left vastus lateralis)","LLFA (left lower forearm)","RT (right thigh)","RA (right arm)","RD (right deltoid)","RG (right gluteus medius)","RVL (right vastus lateralis)","RLFA (right lower forearm)"]},"route":{"type":"string","example":"Intramuscular","enum":["Intradermal","Intramuscular","Nasal","Intravenous","Oral","Oral","Percutaneous","Subcutaneous","Transdermal"]},"dose_in_series":{"type":"integer","example":2},"vaccine_administering_provider_suffix":{"type":"string","example":"MD"},"sending_organization":{"type":"string","example":"HealtORG"},"use_vaccine_reporting":{"type":"boolean","example":true},"vaccine_administration_site_id":{"type":"integer","example":998887},"vaccine_expiration_date":{"type":"string","format":"date-time","example":"2025-11-30T05:10:11.001Z"},"comorbidity_status":{"type":"boolean","example":true},"recipient_missed_vaccination_appointment":{"type":"boolean","example":false},"serology_results":{"type":"boolean","example":true},"vaccination_refusal":{"type":"boolean","example":false},"notes":{"type":"string","example":"Vaccination notes"},"additional_data":{"type":"object","example":{}}}},"VaccinationEventWebhook":{"required":["callback_url"],"type":"object","properties":{"id":{"type":"integer","description":"Webhook Id","example":23456},"callback_url":{"type":"string","description":"Url to callback","example":"https://third_party_app/webhook_url"}}},"VaccinationIISReport":{"required":["recipient_iis_id","vaccination_event_id","vacination_event_iis_id"],"type":"object","properties":{"vaccination_event_id":{"type":"integer","example":333245},"recipient_iis_id":{"type":"string","example":"I-2346"},"vacination_event_iis_id":{"type":"string","example":"E-2346"}}},"VAERSReport":{"required":["adverese_events_description","adverse_events_outcome","adverse_events_started_date","age_at_administration","all_vaccines_given","recovered_from_adverse_events","report_submitted_by","submit_pii","vaccine_administration_site"],"type":"object","properties":{"adverse_events_started_date":{"type":"string","format":"date-time","example":"2020-08-29T09:12:33.001Z"},"age_at_administration":{"type":"string","description":"Years and months"},"all_vaccines_given":{"type":"array","description":"List of all vaccination events ids","items":{"type":"integer","example":333245}},"adverese_events_description":{"type":"string","example":"High fever and headache."},"adverse_events_outcome":{"type":"array","example":["Doctor or other healthcare professional office/clinic visit","Emergency room/department or urgent care","Prolongation of existing hospitalization (vaccine received during existing hospitalization)","Life threatening illness (immediate risk of death from the event)","Disability or permanent damage","Patient died – Date of death: (mm/dd/yyyy)","Congenital anomaly or birth defect","None of the above"],"items":{}},"adverse_events_hospitalization":{"$ref":"#/components/schemas/Hospitalization"},"pregnant_at_administration":{"type":"boolean","example":false},"allergies":{"type":"string","description":"Allergies to medications, food, or other products","example":"Nuts"},"medications_supp_at_admisnistration":{"type":"string","description":"Prescriptions, over the counter medications, dietary supplements,or herbal remedies being taken at the time of vaccination","example":"Vitamines C and D"},"illness_at_administration":{"type":"string","description":"Other illnesses at the time of vaccination and up to one month prior","example":"Flu"},"chronic_conditions":{"type":"string","description":"Chronic or long-standing health conditions","example":"Asthma"},"report_submitted_by":{"$ref":"#/components/schemas/VAERSReportSubmitter"},"labresults_related_to_adverse_events":{"type":"string","description":"Medical tests and laboratory results related to the adverse event(s): (include dates)","example":"Head MRI, 2020-12-10"},"recovered_from_adverse_events":{"type":"string","description":"Has the patient recovered from the adverse event(s)?","example":"No","enum":["Yes","No","Unknown"]},"submit_pii":{"type":"boolean","example":false}}},"Hospitalization":{"required":["hospital","number_of_days"],"type":"object","properties":{"hospital":{"$ref":"#/components/schemas/Hospital"},"number_of_days":{"type":"string","example":"6 days"}}},"Hospital":{"required":["city","fax","name","state"],"type":"object","properties":{"name":{"type":"string","example":"Central Hospital"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"fax":{"type":"string","example":"1-334-445-7788"}}},"VAERSReportSubmitter":{"required":["email","phone","submitted_by"],"type":"object","properties":{"submitted_by":{"type":"string","description":"Name of person submitting report.","example":"Anna Jenkins"},"relation_to_patient":{"type":"string","description":"Healthcare professional/staff, Patient (yourself), Parent/guardian/caregiver, Other: (free text)","example":"Parent"},"street_address":{"type":"string","example":"123 Sunset Blvd"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":"98777"},"email":{"type":"string","example":"annnjs@gemail.com"},"phone":{"type":"string","example":"1-123-445-5555"},"hcp_contact":{"type":"string","description":"Best doctor/healthcare professional to contact about the adverse event. Name: Phone: Ext:","example":"Dr. Emma Jones, 1-123-445-5555"}}},"VaccineAddministrationSite":{"required":["city","facility_name","facility_type","phone","state","street_address","zip"],"type":"object","properties":{"id":{"type":"integer","example":22333},"facility_name":{"type":"string","example":"Toyota Center - 53rd Street"},"fax":{"type":"string","example":"1-022-279-4477"},"street_address":{"type":"string","example":"12 53rd Street"},"city":{"type":"string","example":"Filadelfia"},"state":{"type":"string","example":"PA"},"zip":{"type":"string","example":"19093"},"phone":{"type":"string","example":"1-022-279-4477"},"facility_type":{"type":"string","description":"One of:","example":"Other: Client's Office","enum":["(Doctor’s office, urgent care, or hospital)","Pharmacy or store","Workplace clinic","Public health clinic","Nursing home or senior living facility","School or student health clinic","Other: (Free Text)","Unknown"]}}},"Notification":{"required":["body","phone","recipient_email_address","recipient_name","sender_email_address","sender_name","subject"],"type":"object","properties":{"recipient_name":{"type":"string","example":"Jenna Trujillo"},"recipient_email_address":{"type":"string","example":"jtruji123@gemail.com"},"sender_name":{"type":"string","example":"John Joseph"},"sender_email_address":{"type":"string","example":"jjoseph@gemail.com"},"subject":{"type":"string","example":"Vaccine Follow up"},"body":{"type":"string","example":"Follow up and recommendations."},"phone":{"type":"string","example":"1-111-335-5491"},"additional_data":{"type":"object","example":{}}}},"ObjectCreatedResponse":{"type":"object","properties":{"id":{"type":"integer","example":234567},"status":{"type":"string","example":"SUCCESS"},"message":{"type":"string","example":"Object successfully created."}}}}}}