Skip to main content

ResearchSubject

ResourceSpecialized · Public Health & ResearchTrial useMaturity 1

A physical entity which is the primary unit of operational and/or administrative interest in a study.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
6 of 6 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierBusiness Identifier for research subject in a study
statusRequired?!Σ
1..1codecandidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawnBinding (required): research-subject-status
periodΣ
0..1PeriodStart and end of participation
studyRequiredΣ
1..1Reference(ResearchStudy)Study subject is part of
individualRequiredΣ
1..1Reference(Patient)Who is part of study
assignedArm
0..1stringWhat path should be followed
actualArm
0..1stringWhat path was followed
consent
0..1Reference(Consent)Agreement to participate in study

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/ResearchSubject?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
datedate

Start and end of participation

ResearchSubject.period
identifiertoken

Business Identifier for research subject in a study

ResearchSubject.identifier
individualreference

Who is part of study

ResearchSubject.individual
patientreference

Who is part of study

ResearchSubject.individual
statustoken

candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn

ResearchSubject.status
studyreference

Study subject is part of

ResearchSubject.study

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition