POST api/v1/{EMRSystem}/MedicationAdministrations/Immunization

Creates an Immunization Administration.

Status: Beta

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.

Body Parameters

UdmImmunizationAdministrationCreateRequest
NameDescriptionTypeAdditional information
UserId

The identifier of the user creating the medication administration.

string

Required
PatientId

The identifier of the patient.

string

Required
PatientIdType

The identifier of the patient type.

string

None.
OrderId

The identifier of the order.

string

Required
ScheduledAdministrationId

The identifier of the scheduled administration.

string

Required if EMRSystem = Cerner
IsPatientBandScanned

The flag stating the patient band barcode was scanned.

boolean

Required
PatientNotScannedReason

The reason the patient band was not scanned.

string

None.
IsMedicationScanned

The flag stating the medication barcode was scanned.

boolean

Required
MedicationNotScannedReason

The reason the medication barcode was not scanned.

string

None.
AdministrationActionId

The identifier of the administration action.

string

None.
AdministrationClinicianId

The identifier of the administration clinician.

string

None.
AdministrationDateTime

The date and time of the medication administration.

string

None.
AdministrationRouteId

The identifier of administration route.

string

None.
AdministrationSiteId

The identifier of the administration site.

string

None.
Comments

The administration comments.

string

None.
DocumentedDateTime

The date and time the administration was documented.

string

None.
Dose

The dose of the administration.

string

None.
DoseUnitId

The identifier of the dose unit.

string

None.
Duration

The duration of the administration.

string

None.
DurationUnitId

The identifier of the duration unit.

string

None.
IsNotGiven

The flag setting the administration to not given.

boolean

None.
ReasonNotGivenId

The identifier of the reason the medication was not given.

string

None.
Rate

The rate of the administration.

string

None.
RateUnitId

The identifier of the rate unit.

string

None.
Volume

The volume of the administration.

string

None.
VolumeUnitId

The identifier of the volume unit.

string

None.
WitnessId

The Id of the Witness of the Administration

string

None.
SystemId

The Id of the System

string

None.
ReferenceNumber

The Unique Reference number

string

None.
MedicationBarcode

The NDC or DispenseId of the drug being admininstered

string

None.
EarlyLateReason

The early or late reason for admin that can be passed in as an ID or free text

string

None.
EnforceMedicationInterval

The flag to enforce the medication administration interval.

boolean

None.
LotNumber

The Lot Number of the Immunization

string

None.
ManufacturerId

The Manufacturer of the Immunization

string

None.
ExpirationDate

The expiration date of the immunization

string

None.
VaccineForChildrenId

The Vaccines for Children entry

string

None.
VaccineInformationStatementsId

The Vaccine Information Sheets

string

None.
InformationGivenOnDate

The Date the Vaccine Information Sheets were givin

string

None.
FundingSourceId

The Funding Source of the Vaccine

string

None.
MedAdminObservations

The List of Observations to be charted with Med Administration

MedAdminObservationCreate

None.

Header Parameters

NameDescriptionTypeAdditional 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.

Request Formats

application/json

{
  "UserId": "sample string 1",
  "PatientId": "sample string 2",
  "PatientIdType": "sample string 3",
  "OrderId": "sample string 4",
  "ScheduledAdministrationId": "sample string 5",
  "IsPatientBandScanned": true,
  "PatientNotScannedReason": "sample string 7",
  "IsMedicationScanned": true,
  "MedicationNotScannedReason": "sample string 9",
  "AdministrationActionId": "sample string 10",
  "AdministrationClinicianId": "sample string 11",
  "AdministrationDateTime": "2025-12-12",
  "AdministrationRouteId": "sample string 12",
  "AdministrationSiteId": "sample string 13",
  "Comments": "sample string 14",
  "DocumentedDateTime": "2025-12-12",
  "Dose": "sample string 15",
  "DoseUnitId": "sample string 16",
  "Duration": "sample string 17",
  "DurationUnitId": "sample string 18",
  "IsNotGiven": true,
  "ReasonNotGivenId": "sample string 20",
  "Rate": "sample string 21",
  "RateUnitId": "sample string 22",
  "Volume": "sample string 23",
  "VolumeUnitId": "sample string 24",
  "WitnessId": "sample string 25",
  "SystemId": "sample string 26",
  "ReferenceNumber": "sample string 27",
  "MedicationBarcode": "sample string 28",
  "EarlyLateReason": "sample string 29",
  "EnforceMedicationInterval": true,
  "LotNumber": "sample string 31",
  "ManufacturerId": "sample string 32",
  "ExpirationDate": "2025-12-12",
  "VaccineForChildrenId": "sample string 33",
  "VaccineInformationStatementsId": "sample string 34",
  "InformationGivenOnDate": "2025-12-12",
  "FundingSourceId": "sample string 35",
  "MedAdminObservations": {
    "ObservationComponents": [
      {
        "ObservationId": "sample string 1",
        "ComponentId": "sample string 2",
        "Value": "sample string 3",
        "Comment": "sample string 4",
        "ValueCodes": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "ObservationId": "sample string 1",
        "ComponentId": "sample string 2",
        "Value": "sample string 3",
        "Comment": "sample string 4",
        "ValueCodes": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  "LoginId": "sample string 37",
  "Password": "sample string 38",
  "EmrInstance": "sample string 39",
  "ApplicationName": "sample string 40",
  "ApplicationKey": null,
  "AuthorizationToken": "sample string 42",
  "RequestVerboseLogging": true,
  "EMRSystem": 0
}

Response Information

UdmImmunizationAdministrationCreateResponse
NameDescriptionTypeAdditional information
AdministrationId

The identifier of the administration that was created.

string

None.
Observations

Gets or sets the List of observation identifier.

Collection of BasicObservationId

None.

Response Codes

Http Status Code 201 - 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

{
  "AdministrationId": "sample string 1",
  "Observations": [
    {
      "ObservationId": "sample string 1",
      "Component": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "ObservationId": "sample string 1",
      "Component": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ]
}

'

POST api/v1/{EMRSystem}/MedicationAdministrations/Immunization

Creates an Immunization Administration.

Status: Beta

URI Parameters


Body Parameters

Required
Required
Required
Required if EMRSystem = Cerner
;

Header Parameters

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Required if using application keys
Data type: Password , Required if using application keys

Request: {{ method }} {{ url }}

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}


API Runner under construction for POST, PUT, and PATCH requests. Please use Swagger UI