Oracle Health Sciences mHealth Connector Cloud Service - Studies, Subjects, and Devices

Register a subject in a study

post

/api/studies/{studyId}/subjects

Registers a subject in an mHealth study.

Request

Path Parameters

studyId: string

Study object id

Supported Media Types

application/json

Subject properties.

Root Schema : schema

Type: object

Show Source

site(optional): string

Optional field. Use this field to indicate the site identifier, such as siteId or a site mnemonic, for the mHealth application.
srcSubjId: string

Required field. A master subject identifer in the target application or a global subject identifier assigned by a customer application. This field must be unique within an mHealth study.

{
    "required":[
        "srcSubjId"
    ],
    "type":"object",
    "properties":{
        "srcSubjId":{
            "type":"string",
            "description":"Required field. A master subject identifer in the target application or a global subject identifier assigned by a customer application. This field must be unique within an mHealth study."
        },
        "site":{
            "type":"string",
            "description":"Optional field.  Use this field to indicate the site identifier, such as siteId or a site mnemonic, for the mHealth application."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : subject

Type: object

Show Source

id: string(uuid)
site(optional): string

The site identifier; for example, siteId or a site mnemonic.
srcSubjId(optional): string

SubjectId in the target application; for example, InForm. This field must be unique within an mHealth study.
studyId: string(uuid)

Study identifier within the mHealth platform. Returned by study endpoint.

{
    "required":[
        "id",
        "studyId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "srcSubjId":{
            "type":"string",
            "description":"SubjectId in the target application; for example, InForm. This field must be unique within an mHealth study."
        },
        "site":{
            "type":"string",
            "description":"The site identifier; for example, siteId or a site mnemonic."
        },
        "studyId":{
            "type":"string",
            "description":"Study identifier within the mHealth platform. Returned by study endpoint.",
            "format":"uuid"
        }
    },
    "xml":{
        "name":"subject"
    }
}

400 Response

Invalid payload.

404 Response

Invalid studyId.