Immunization Controller

Changed on
post/immunizations/createVaccination

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/createVaccination
  • Auth
    none declared

Query parameters

regionUuidstring
districtUuidstring
personUuidstring
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'

Request body

changeDatestring date-time
creationDatestring date-time
inJurisdictionboolean
otherVaccineManufacturerstring
otherVaccineNamestring
pregnant'YES' | 'NO' | 'UNKNOWN'
pseudonymizedboolean
reportDatestring date-time required
trimester'FIRST' | 'SECOND' | 'THIRD' | 'UNKNOWN'
uuidstring
vaccinationDatestring date-time
vaccinationInfoSource'VACCINATION_REGISTRY' | 'VACCINATION_CARD' | 'ORAL_COMMUNICATION' | 'HEALTH_SERVICES' | 'NO_EVIDENCE' | 'UNKNOWN'
vaccineAtcCodestring
vaccineBatchNumberstring
vaccineDosestring
vaccineInnstring
vaccineManufacturer'BIONTECH_PFIZER' | 'PFIZER' | 'BAVARIAN_NORDIC' | 'MODERNA' | 'ASTRA_ZENECA' | 'JOHNSON_JOHNSON' | 'KM_BIOLOGICS' | 'NOVAVAX' | 'SANOFI_GSK' | 'SANOFI_PASTEUR_BIOLOGICS' | 'VALNEVA' | 'MERCK' | 'SANOFI_PASTEUR' | 'TAKEDA' | 'GSK' | 'OXFORD' | 'UNKNOWN' | 'OTHER'
vaccineName'COMIRNATY' | 'MRNA_BIVALENT_BA_1_BIONTECH_PFIZER' | 'MRNA_BIVALENT_BA_4_5_BIONTECH_PFIZER' | 'MRNA_1273' | 'MRNA_BIVALENT_BA_1_MODERNA' | 'MRNA_BIVALENT_BA_4_5_MODERNA' | 'VALNEVA' | 'NVX_COV_2373' | 'NUVAXOVID' | 'OXFORD_ASTRA_ZENECA' | 'AD26_COV2_S' | 'SANOFI_GSK' | 'MENABCWY' | 'ACAM2000' | 'LC_16' | 'PREVENAR_13_PFIZER' | 'VAXNEUVANCE_MERCK' | 'PREVNAR_20_PFIZER' | 'PNEUMOVAX_23_MERCK' | 'MVA_BN' | 'DENGVAXIA' | 'QDENGA' | 'RTS_S_AS01' | 'R21_MATRIX_M' | 'UNKNOWN' | 'OTHER'
vaccineTypestring
vaccineUniiCodestring

Response

default response

Changes

  • a4ef960fde19Revision changes
    • breaking

      removed the enum value DIPHTERIA from the query request parameter disease

    • info

      added the new enum value DIPHTHERIA to the query request parameter disease

  • ae918403a42aRevision changes
    • warning

      added the new HEALTH_SERVICES enum value to the response property for the response status

    • info

      added the new HEALTH_SERVICES enum value to the request property