Show Source

• esourceName(optional): string
  Representation of the eSource name. Used when a device message gets into the mHealth platform through a cloud-to-cloud (c2c) connector. Leave this field empty for device-to-cloud (d2c) connector.
• id: string(uuid)
  Device instance identifier.
• iotDeviceId: string(uuid)
  DeviceId created for the virtual device in the underlying IoT Cloud.
• srcDeviceName(optional): string
  An arbitrary name set by the caller application when the device instance was created.
• studyId: string
  mHealth study identifier.
• subjectId: string(uuid)
  Subject identifier in the mHealth Connector Cloud. Generated when a subject is registered in an mHealth study.
• surrogateSubjId: string
  Surrogate subject identifier. This could be automatically generated by the mHealth Connector Cloud or set by the customer's subject management system. Device data payload must use this value as KEY_UID field.
• targetSubjIdMap: array targetSubjIdMap
  Subject ID in each target application.

{
    "required":[
        "id",
        "iotDeviceId",
        "studyId",
        "subjectId",
        "surrogateSubjId",
        "targetSubjIdMap"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Device instance identifier.",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject identifier in the mHealth Connector Cloud. Generated when a subject is registered in an mHealth study.",
            "format":"uuid"
        },
        "targetSubjIdMap":{
            "type":"array",
            "description":"Subject ID in each target application.",
            "items":{
                "$ref":"#/components/schemas/TargetSubj"
            }
        },
        "surrogateSubjId":{
            "type":"string",
            "description":"Surrogate subject identifier. This could be automatically generated by the mHealth Connector Cloud or set by the customer's subject management system. Device data payload must use this value as KEY_UID field."
        },
        "srcDeviceName":{
            "type":"string",
            "description":"An arbitrary name set by the caller application when the device instance was created."
        },
        "esourceName":{
            "type":"string",
            "description":"Representation of the eSource name. Used when a device message gets\n  into the mHealth platform through a cloud-to-cloud  (c2c) connector.\n  Leave this field empty for device-to-cloud (d2c) connector. "
        },
        "iotDeviceId":{
            "type":"string",
            "description":"DeviceId created for the virtual device in the underlying IoT Cloud.",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"mHealth study identifier."
        }
    },
    "xml":{
        "name":"device"
    }
}

Show Source

• Array of: object TargetSubj

{
    "type":"array",
    "description":"Subject ID in each target application.",
    "items":{
        "$ref":"#/components/schemas/TargetSubj"
    }
}

Show Source

• subjId: string
  subject ID in the target application.
• type: string
  Target type. Possible values are INFORM, DMW, or DEFAULT. Use DEFAULT type if the same subject Id is to be used across all targets. If DEFAULT and a specific target type exist in a map, the specific target type gets higher precedence over the DEFAULT type.

{
    "required":[
        "subjId",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Target type. Possible values are INFORM, DMW, or DEFAULT. Use DEFAULT type if the same subject Id is to be used across all targets. If DEFAULT and a specific target type exist in a map, the specific target type gets higher precedence over the DEFAULT type."
        },
        "subjId":{
            "type":"string",
            "description":"subject ID in the target application."
        }
    }
}