Immunization Controller

Create or update one or multiple entities.

Changed on

A uuid will be generated for any entity that doesn't have one yet. Posting entities without uuid multiple times will also create them multiple times.

post/immunizations/push

Request

  • Base URL
    /sormas-rest (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /sormas-rest/immunizations/push
  • Auth
    none declared

Request body

additionalDetailsstring
archivedboolean
changeDatestring date-time
creationDatestring date-time
deletedboolean
deletionReason'GDPR' | 'DELETION_REQUEST' | 'CREATED_WITH_NO_LEGAL_REASON' | 'TRANSFERRED_RESPONSIBILITY' | 'DUPLICATE_ENTRIES' | 'OTHER_REASON'
disease'AFP' | 'CHOLERA' | 'CONGENITAL_RUBELLA' | 'CSM' | 'DENGUE' | 'EVD' | 'GUINEA_WORM' | 'LASSA' | 'MEASLES' | 'MONKEYPOX' | 'NEW_INFLUENZA' | 'PLAGUE' | 'POLIO' | 'UNSPECIFIED_VHF' | 'WEST_NILE_FEVER' | 'YELLOW_FEVER' | 'RABIES' | 'ANTHRAX' | 'CORONAVIRUS' | 'PNEUMONIA' | 'MALARIA' | 'TYPHOID_FEVER' | 'ACUTE_VIRAL_HEPATITIS' | 'NON_NEONATAL_TETANUS' | 'HIV' | 'SCHISTOSOMIASIS' | 'SOIL_TRANSMITTED_HELMINTHS' | 'TRYPANOSOMIASIS' | 'DIARRHEA_DEHYDRATION' | 'DIARRHEA_BLOOD' | 'SNAKE_BITE' | 'RUBELLA' | 'TUBERCULOSIS' | 'LATENT_TUBERCULOSIS' | 'LEPROSY' | 'LYMPHATIC_FILARIASIS' | 'BURULI_ULCER' | 'PERTUSSIS' | 'NEONATAL_TETANUS' | 'ONCHOCERCIASIS' | 'DIPHTHERIA' | 'TRACHOMA' | 'YAWS_ENDEMIC_SYPHILIS' | 'MATERNAL_DEATHS' | 'PERINATAL_DEATHS' | 'INFLUENZA' | 'INFLUENZA_A' | 'INFLUENZA_B' | 'H_METAPNEUMOVIRUS' | 'RESPIRATORY_SYNCYTIAL_VIRUS' | 'PARAINFLUENZA_1_4' | 'ADENOVIRUS' | 'RHINOVIRUS' | 'ENTEROVIRUS' | 'M_PNEUMONIAE' | 'C_PNEUMONIAE' | 'ARI' | 'CHIKUNGUNYA' | 'POST_IMMUNIZATION_ADVERSE_EVENTS_MILD' | 'POST_IMMUNIZATION_ADVERSE_EVENTS_SEVERE' | 'FHA' | 'INVASIVE_PNEUMOCOCCAL_INFECTION' | 'INVASIVE_MENINGOCOCCAL_INFECTION' | 'GIARDIASIS' | 'CRYPTOSPORIDIOSIS' | 'SHIGELLOSIS' | 'SALMONELLOSIS' | 'SYPHILIS' | 'YERSINIOSIS' | 'MUMPS' | 'GONOCOCCAL_INFECTION' | 'OTHER' | 'UNDEFINED' required
diseaseDetailsstring
endDatestring date-time
externalIdstring
facilityType'ASSOCIATION' | 'BUSINESS' | 'BAR' | 'CAMPSITE' | 'CANTINE' | 'CHILDRENS_DAY_CARE' | 'CHILDRENS_HOME' | 'CORRECTIONAL_FACILITY' | 'CRUISE_SHIP' | 'ELDERLY_DAY_CARE' | 'EVENT_VENUE' | 'FOOD_STALL' | 'HOLIDAY_CAMP' | 'HOMELESS_SHELTER' | 'HOSPITAL' | 'HOSTEL' | 'HOTEL' | 'KINDERGARTEN' | 'LABORATORY' | 'MASS_ACCOMMODATION' | 'MILITARY_BARRACKS' | 'MOBILE_NURSING_SERVICE' | 'NIGHT_CLUB' | 'OTHER_ACCOMMODATION' | 'OTHER_CARE_FACILITY' | 'OTHER_CATERING_OUTLET' | 'OTHER_EDUCATIONAL_FACILITY' | 'OTHER_LEISURE_FACILITY' | 'OTHER_MEDICAL_FACILITY' | 'OTHER_RESIDENCE' | 'OTHER_WORKING_PLACE' | 'OTHER_COMMERCE' | 'OUTPATIENT_TREATMENT_FACILITY' | 'PLACE_OF_WORSHIP' | 'PUBLIC_PLACE' | 'REFUGEE_ACCOMMODATION' | 'REHAB_FACILITY' | 'RESTAURANT' | 'RETIREMENT_HOME' | 'RETAIL' | 'WHOLESALE' | 'SCHOOL' | 'SWIMMING_POOL' | 'THEATER' | 'UNIVERSITY' | 'ZOO' | 'AMBULATORY_SURGERY_FACILITY' | 'DIALYSIS_FACILITY' | 'DAY_HOSPITAL' | 'MATERNITY_FACILITY' | 'MEDICAL_PRACTICE' | 'DENTAL_PRACTICE' | 'OTHER_MEDICAL_PRACTICE' | 'DIAGNOSTIC_PREVENTATIVE_THERAPEUTIC_FACILITY' | 'EMERGENCY_MEDICAL_SERVICES' | 'ELDERLY_CARE_FACILITY' | 'DISABLED_PERSON_HABITATION' | 'CARE_RECIPIENT_HABITATION' | 'VISITING_AMBULATORY_AID' | 'AFTER_SCHOOL'
healthFacilityDetailsstring
immunizationManagementStatus'SCHEDULED' | 'ONGOING' | 'COMPLETED' | 'CANCELED'
immunizationStatus'PENDING' | 'ACQUIRED' | 'NOT_ACQUIRED' | 'EXPIRED'
inJurisdictionboolean
injectionFacility'MATERNITY_WARD' | 'PAEDIATRIC_PRACTICE' | 'HOSPITAL'
lastInfectionDatestring date-time
meansOfImmunization'VACCINATION' | 'RECOVERY' | 'VACCINATION_RECOVERY' | 'MATERNAL_VACCINATION' | 'MONOCLONAL_ANTIBODY' | 'OTHER' | 'NOT_IMMUNIZED' required
meansOfImmunizationDetailsstring
numberOfDosesinteger
numberOfDosesDetailsstring
otherDeletionReasonstring
ownershipHandedOverboolean
positiveTestResultDatestring date-time
previousInfection'YES' | 'NO' | 'UNKNOWN'
pseudonymizedboolean
recoveryDatestring date-time
reportDatestring date-time required
startDatestring date-time
uuidstring
vaccinationInfoSource'VACCINATION_REGISTRY' | 'VACCINATION_CARD' | 'ORAL_COMMUNICATION' | 'HEALTH_SERVICES' | 'NO_EVIDENCE' | 'UNKNOWN'
validFromstring date-time
validUntilstring date-time

Response

Array of responses, matching the posted array of entities. Provides an HTML status code for every entity and an optional body (e.g. a string with an error message).

bodyobject
statusCodeinteger

Changes

  • a4ef960fde19Revision changes
    • breaking

      removed the enum value DIPHTERIA of the request property /

    • info

      added the new DIPHTHERIA enum value to the request property /

  • ae918403a42aRevision changes
    • info

      added the new HEALTH_SERVICES enum value to the request property /

    • info

      added the new HEALTH_SERVICES enum value to the request property ///