Get Immunizations

Developer Tools

GET api/v1/{EMRSystem}/Immunizations

Returns both pending and completed immunizations for a given patient.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

Released

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

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

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collectionof Immunizations View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

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.

CodedObjectViewModel

None.

PatientClass

Gets or sets the patient class.

CodedObjectViewModel

None.

ImmunizationDateTime

Gets or sets the immunization date time.

date

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.

CodedObjectViewModel

None.

OrderedBy

Gets or sets the ordered by.

CodedObjectViewModel

None.

ExpirationDateTime

Gets or sets the expiration date time.

date

None.

Comment

Gets or sets the comment.

string

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.ImmunizationsResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
[
  {
    "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": "2018-02-14T14:29:43.5756249Z",
    "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"
    },
    "ExpirationDateTime": "2018-02-14T14:29:43.5756249Z",
    "Comment": "sample string 12"
  },
  {
    "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": "2018-02-14T14:29:43.5756249Z",
    "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"
    },
    "ExpirationDateTime": "2018-02-14T14:29:43.5756249Z",
    "Comment": "sample string 12"
  }
]
Sample Message
<ArrayOfImmunizationViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <ImmunizationViewModel>
    <BodySite>sample string 6</BodySite>
    <Comment>sample string 12</Comment>
    <Dose>sample string 8</Dose>
    <DoseUnit>sample string 9</DoseUnit>
    <EncounterId>sample string 3</EncounterId>
    <EncounterType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </EncounterType>
    <ExpirationDateTime>2018-02-14T08:29:43.5756249-06:00</ExpirationDateTime>
    <GivenBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </GivenBy>
    <ImmunizationDateTime>2018-02-14T08:29:43.5756249-06:00</ImmunizationDateTime>
    <ImmunizationId>sample string 1</ImmunizationId>
    <ImmunizationName>sample string 4</ImmunizationName>
    <Lot>sample string 11</Lot>
    <OrderedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </OrderedBy>
    <PatientClass>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PatientClass>
    <PatientId>sample string 2</PatientId>
    <Route>sample string 7</Route>
    <Status>sample string 5</Status>
    <VaccineManufacturer>sample string 10</VaccineManufacturer>
  </ImmunizationViewModel>
  <ImmunizationViewModel>
    <BodySite>sample string 6</BodySite>
    <Comment>sample string 12</Comment>
    <Dose>sample string 8</Dose>
    <DoseUnit>sample string 9</DoseUnit>
    <EncounterId>sample string 3</EncounterId>
    <EncounterType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </EncounterType>
    <ExpirationDateTime>2018-02-14T08:29:43.5756249-06:00</ExpirationDateTime>
    <GivenBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </GivenBy>
    <ImmunizationDateTime>2018-02-14T08:29:43.5756249-06:00</ImmunizationDateTime>
    <ImmunizationId>sample string 1</ImmunizationId>
    <ImmunizationName>sample string 4</ImmunizationName>
    <Lot>sample string 11</Lot>
    <OrderedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </OrderedBy>
    <PatientClass>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </PatientClass>
    <PatientId>sample string 2</PatientId>
    <Route>sample string 7</Route>
    <Status>sample string 5</Status>
    <VaccineManufacturer>sample string 10</VaccineManufacturer>
  </ImmunizationViewModel>
</ArrayOfImmunizationViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?