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

Encounter (object)

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient

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

  • class  

    Internal object reference

  • createddate  

    Date expressed as a unix timestamp

    • Data Type   number

    • Example   1532563200000

  • entityid  

    Internal index used by digi.me

    • Data Type   string

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

  • id  

    • Data Type   string

    • Example   "749fdd15-f06b-4d57-b992-235ae5245b0a"

  • identifier  

    Internal object reference

  • location  

    Internal object reference

    • Data Type   EncounterLocation[]

    • Example  

      [
          {
              "location": {
                  "name": "Branch Location"
              }
          }
      ]
      
  • participant  

    Internal object reference

    • Data Type   Participant[]

    • Example  

      [
          {
              "individual": {
                  "practitioner": {
                      "name": [
                          {
                              "text": "DIGIME, Test (Dr)"
                          }
                      ]
                  }
              }
          }
      ]
      
  • period  

    Internal object reference

    • Data Type   Period

    • Example  

      {
          "start": 1532563200000
      }
      
  • priority  

    Internal object reference

  • referenceentityid  

    Internal index used by digi.me

    • Data Type   string

  • referenceentitytype  

    Internal index used by digi.me

    • Data Type   number

  • serviceprovider  

    Internal object reference

  • socialnetworkuserentityid  

    Internal index used by digi.me

    • Data Type   string

  • status  

    • Data Type   string

    • Example   "Active"

  • type  

    Internal object reference

  • updateddate  

    Date expressed as a unix timestamp

    • Data Type   number