Skip to content
Digi.me Developers Portal Home

Immunization (object)

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party

Object details

  • accountentityid  

    Internal index used by digi.me

    • Data Type   string

    • Example   "30_1116029403"

  • baseid  

    Internal index used by digi.me

    • Data Type   string
  • createddate  

    Date expressed as a unix timestamp

    • Data Type   number

    • Example   1532563200000

  • dosequantity  

  • encounter  

  • entityid  

    Internal index used by digi.me

    • Data Type   string

    • Example   "30_1116029403_749fdd15-f06b-4d57-b992-235ae5245b0a"

  • expirationdate  

    • Data Type   string
  • fundingsource  

  • identifier  

  • implicitrules  

    • Data Type   string
  • issubpotent  

    • Data Type   boolean
  • location  

  • lotnumber  

    • Data Type   string
  • manufacturer  

  • note  

  • occurrencedatetime  

    • Data Type   string
  • occurrencestring  

    • Data Type   string
  • patient  

  • primarysource  

    • Data Type   boolean
  • programeligibility  

  • protocolapplied  

  • reasoncode  

  • reasonreference  

  • recorded  

    • Data Type   string
  • referenceentityid  

    Internal index used by digi.me

    • Data Type   string
  • referenceentitytype  

    Internal index used by digi.me

    • Data Type   number
  • reportorigin  

  • route  

  • site  

  • socialnetworkuserentityid  

    Internal index used by digi.me

    • Data Type   string
  • status  

    • Data Type   string
  • statusreason  

  • subpotentreason  

  • updateddate  

    Date expressed as a unix timestamp

    • Data Type   number

    • Example   1556532644000

  • vaccinecode