api-study-participant-get.study-participant-get¶
Service to retrieve a study participation data.
This class provides a method to get the ressources StudyParticipant from the system based on a patient’s primary_id and optionally a study primary_id.
- Channel GET
/study/{version}/participant/{subject} GET ``/study/{version}/participant/{subject}?part_of={study_primary_id_valule}
- This class retrieves the study participations with the following steps:
DOING: Get all the StudyParticipant associated with the Patient
TODO: and the optional Study provided.
- Returns:
- HTTP status code:
200: If the study participations exist.
404: If the no study participation found.
- JSON: payload with a list of StudyParticipant object.
StudyParticipants ([StudyParticipant])
Input¶
Name |
Datatype |
Required |
Description |
|---|---|---|---|
subject |
string |
Yes |
patient primary_id value |
part_of |
string |
— |
study primary_id value |
Output¶
Name |
Datatype |
Required |
Description |
|---|---|---|---|
study_participants |
StudyParticipant (list) |
Yes |
— |