Skip to content

Endpoint: /Patient/UpdateImmunization ​

This endpoint provides a method for consumers to update a patient's immunization records. When patient immunization records are received their CVX values are checked against values present in the GEHRIMED immunization database. If a record is rejected the import fails out with a warning message listing the offending CVX code(s).  Only immunizations with CVX codes that match CVX values already present in GEHRIMED will be accepted. If there is one bad CVX code the entire import will fail and return the problematic codes.

Request: JSON

{
    "PatientID": int,
    "Immunizations": [
        {
            "PatientID": string,
            "Cvx": string,
            "ImmunizationDate": DateTime,
            "AdministeredAmount": string,
            "AdministeredUnits": string,
            "VaccineLotNumber": string,
            "ManufacturerName": string,
            "ManufacturerCode": string,
            "Notes": string,
            "AdministeredSite": string,
            "AdministeredRoute": string,
            "IISCode": string,
            "RefusalReason": long,
            "AdministeredByName": string,
            "CompletionStatus": string,
            "ActionCode": string
        }
    ]
}

Response: JSON

{
	"Metadata": {
        "ApiSender": string,
        "ApiConsumer": string,
        "MessageDateTime": DateTime
	},
    "Data": {
        "Success": bool,
        "Message": string
	}
}

Last updated:

Access to this API requires prior authorization.