Skip to content
Digi.me Developers Portal Home
Skip to content

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   1532440620000

  • date  

    • Data Type   number

    • Example   1532440620000

  • encounter  

    Internal object reference

  • entityid  

    Internal index used by digi.me

    • Data Type   string

    • Example   "30_1116029403_682d5d41-407d-48e2-9a2e-748127094f2a"

  • id  

    • Data Type   string

    • Example   "682d5d41-407d-48e2-9a2e-748127094f2a"

  • identifier  

    Internal object reference

  • lotnumber  

    • Data Type   string
  • note  

    Internal object reference

  • notgiven  

    • Data Type   boolean
  • referenceentityid  

    Internal index used by digi.me

    • Data Type   string

  • referenceentitytype  

    Internal index used by digi.me

    • Data Type   number

  • route  

    Internal object reference

  • site  

    Internal object reference

  • socialnetworkuserentityid  

    Internal index used by digi.me

    • Data Type   string

  • status  

    • Data Type   string

    • Example   "Active"

  • updateddate  

    Date expressed as a unix timestamp

    • Data Type   number

  • vaccinationprotocol  

    Internal object reference

  • vaccinecode  

    Internal object reference

    • Data Type   CodeableConcept

    • Example  

      {
          "coding": [
              {
                  "code": "264149014"
              }
          ],
          "text": "2nd rabies vaccination"
      }