ResearchSubject

Trial Use 1 Specialized — Public Health & Research

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

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/ResearchSubject

Interaction	Method	Path
Read	GET	/fhir/R4/ResearchSubject/[id]
Vread	GET	/fhir/R4/ResearchSubject/[id]/_history/[vid]
Update	PUT	/fhir/R4/ResearchSubject/[id]
Patch	PATCH	/fhir/R4/ResearchSubject/[id]
Delete	DELETE	/fhir/R4/ResearchSubject/[id]
Create	POST	/fhir/R4/ResearchSubject
Search	GET	/fhir/R4/ResearchSubject
History	GET	/fhir/R4/ResearchSubject/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Business Identifier for research subject in a study
status	code	1..1	candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn modifier
period	Period	0..1	Start and end of participation
study	Reference	1..1	Study subject is part of
individual	Reference	1..1	Who is part of study
assignedArm	string	0..1	What path should be followed
actualArm	string	0..1	What path was followed
consent	Reference	0..1	Agreement to participate in study

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
date	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-date
identifier	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-identifier
individual	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-individual
patient	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-patient
status	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-status
study	string	http://hl7.org/fhir/SearchParameter/ResearchSubject-study

Reference

• Official FHIR R4 spec: ResearchSubject
• Maturity: Trial Use 1 (FMM 1).