GET api/v1/{EMRSystem}/Immunizations
Returns both pending and completed Immunizations for a given patient. FHIR connectors use the following resources for R4: Immunization.Search, Patient.Read, Practitioner.Read, and Encounter.Read.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| UserType |
Gets or sets the type of the user. |
UserType |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of Immunization| Name | Description | Type | Additional information |
|---|---|---|---|
| ImmunizationId |
Gets or sets the immunization identifier. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| EncounterType |
Gets or sets the encounter type. |
CodedObject |
None. |
| PatientClass |
Gets or sets the patient class. |
CodedObject |
None. |
| ImmunizationDateTime |
Gets or sets the immunization date time. |
datetime |
None. |
| ImmunizationName |
Gets or sets the name of the immunization. |
string |
None. |
| Status |
Gets or sets the status. |
string |
None. |
| BodySite |
Gets or sets the body site. |
string |
None. |
| Route |
Gets or sets the route. |
string |
None. |
| Dose |
Gets or sets the dose. |
string |
None. |
| DoseUnit |
Gets or sets the dose unit. |
string |
None. |
| VaccineManufacturer |
Gets or sets the vaccine manufacturer. |
string |
None. |
| Lot |
Gets or sets the lot. |
string |
None. |
| GivenBy |
Gets or sets the given by. |
CodedObject |
None. |
| OrderedBy |
Gets or sets the ordered by. |
CodedObject |
None. |
| OrderId |
Gets or sets the order id. |
string |
None. |
| ExpirationDateTime |
Gets or sets the expiration date time. |
datetime |
None. |
| Comment |
Gets or sets the comment. |
string |
None. |
| VaccineInformationSheet |
Gets or sets the Vaccine Information Sheet |
CodedObject |
None. |
| VaccineInformationSheetGivenDate |
Gets or sets the date Vaccine Information Sheet was given |
datetime |
None. |
| VaccineInformationSheetPublicationDate |
Gets or sets the date Vaccine Information Sheet was published |
datetime |
None. |
| VaccineForChildren |
Gets or sets the Vaccine For Children |
CodedObject |
None. |
| IsPrimarySource |
Gets or sets the IsPrimarySource flag. |
boolean |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"ImmunizationId": "sample string 1",
"PatientId": "sample string 2",
"EncounterId": "sample string 3",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ImmunizationDateTime": "2025-12-12T20:52:24.403833+00:00",
"ImmunizationName": "sample string 4",
"Status": "sample string 5",
"BodySite": "sample string 6",
"Route": "sample string 7",
"Dose": "sample string 8",
"DoseUnit": "sample string 9",
"VaccineManufacturer": "sample string 10",
"Lot": "sample string 11",
"GivenBy": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderedBy": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderId": "sample string 12",
"ExpirationDateTime": "2025-12-12T20:52:24.4043203+00:00",
"Comment": "sample string 13",
"VaccineInformationSheet": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"VaccineInformationSheetGivenDate": "2025-12-12T20:52:24.4044935+00:00",
"VaccineInformationSheetPublicationDate": "2025-12-12T20:52:24.4045433+00:00",
"VaccineForChildren": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"IsPrimarySource": true
},
{
"ImmunizationId": "sample string 1",
"PatientId": "sample string 2",
"EncounterId": "sample string 3",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ImmunizationDateTime": "2025-12-12T20:52:24.403833+00:00",
"ImmunizationName": "sample string 4",
"Status": "sample string 5",
"BodySite": "sample string 6",
"Route": "sample string 7",
"Dose": "sample string 8",
"DoseUnit": "sample string 9",
"VaccineManufacturer": "sample string 10",
"Lot": "sample string 11",
"GivenBy": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderedBy": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderId": "sample string 12",
"ExpirationDateTime": "2025-12-12T20:52:24.4043203+00:00",
"Comment": "sample string 13",
"VaccineInformationSheet": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"VaccineInformationSheetGivenDate": "2025-12-12T20:52:24.4044935+00:00",
"VaccineInformationSheetPublicationDate": "2025-12-12T20:52:24.4045433+00:00",
"VaccineForChildren": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"IsPrimarySource": true
}
]