STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

8.23 Resource ResearchSubject - Content

Regulated Clinical Research Information Management

Work Group

Maturity Level: 0

Compartments: Patient

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. ResearchStudies involve the gathering of information about human or animal subjects.

Structure

Name	Flags	Card.	Type	Description & Constraints
ResearchSubject			DomainResource	Investigation increase healthcare-related patient-independent knowledge
identifier	Σ	0..1	Identifier	Business Identifer for event
status	?!Σ	1..1	code	candidate \| enrolled \| active \| suspended \| withdrawn \| completed ResearchSubjectStatus (Required)
period	Σ	0..1	Period	Start and end of participation
study	Σ	1..1	Reference(ResearchStudy)	Study subject is part of
individual	Σ	1..1	Reference(Patient)	Who is part of study
assignedArm		0..1	string	What path should be followed
actualArm		0..1	string	What path was followed
consent		0..1	Reference(Consent)	Agreement to participate in study
Documentation for this format

UML Diagram (Legend)

XML Template

<ResearchSubject xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business Identifer for event --></identifier>
 <status value="[code]"/><!-- 1..1 candidate | enrolled | active | suspended | withdrawn | completed -->
 <period><!-- 0..1 Period Start and end of participation --></period>
 <study><!-- 1..1 Reference(ResearchStudy) Study subject is part of --></study>
 <individual><!-- 1..1 Reference(Patient) Who is part of study --></individual>
 <assignedArm value="[string]"/><!-- 0..1 What path should be followed -->
 <actualArm value="[string]"/><!-- 0..1 What path was followed -->
 <consent><!-- 0..1 Reference(Consent) Agreement to participate in study --></consent>
</ResearchSubject>

JSON Template

{
  "resourceType" : "ResearchSubject",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business Identifer for event
  "status" : "<code>", // R!  candidate | enrolled | active | suspended | withdrawn | completed
  "period" : { Period }, // Start and end of participation
  "study" : { Reference(ResearchStudy) }, // R!  Study subject is part of
  "individual" : { Reference(Patient) }, // R!  Who is part of study
  "assignedArm" : "<string>", // What path should be followed
  "actualArm" : "<string>", // What path was followed
  "consent" : { Reference(Consent) } // Agreement to participate in study
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ResearchSubject;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchSubject.identifier [ Identifier ]; # 0..1 Business Identifer for event
  fhir:ResearchSubject.status [ code ]; # 1..1 candidate | enrolled | active | suspended | withdrawn | completed
  fhir:ResearchSubject.period [ Period ]; # 0..1 Start and end of participation
  fhir:ResearchSubject.study [ Reference(ResearchStudy) ]; # 1..1 Study subject is part of
  fhir:ResearchSubject.individual [ Reference(Patient) ]; # 1..1 Who is part of study
  fhir:ResearchSubject.assignedArm [ string ]; # 0..1 What path should be followed
  fhir:ResearchSubject.actualArm [ string ]; # 0..1 What path was followed
  fhir:ResearchSubject.consent [ Reference(Consent) ]; # 0..1 Agreement to participate in study
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

Name	Flags	Card.	Type	Description & Constraints
ResearchSubject			DomainResource	Investigation increase healthcare-related patient-independent knowledge
identifier	Σ	0..1	Identifier	Business Identifer for event
status	?!Σ	1..1	code	candidate \| enrolled \| active \| suspended \| withdrawn \| completed ResearchSubjectStatus (Required)
period	Σ	0..1	Period	Start and end of participation
study	Σ	1..1	Reference(ResearchStudy)	Study subject is part of
individual	Σ	1..1	Reference(Patient)	Who is part of study
assignedArm		0..1	string	What path should be followed
actualArm		0..1	string	What path was followed
consent		0..1	Reference(Consent)	Agreement to participate in study
Documentation for this format

UML Diagram (Legend)

XML Template

<ResearchSubject xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business Identifer for event --></identifier>
 <status value="[code]"/><!-- 1..1 candidate | enrolled | active | suspended | withdrawn | completed -->
 <period><!-- 0..1 Period Start and end of participation --></period>
 <study><!-- 1..1 Reference(ResearchStudy) Study subject is part of --></study>
 <individual><!-- 1..1 Reference(Patient) Who is part of study --></individual>
 <assignedArm value="[string]"/><!-- 0..1 What path should be followed -->
 <actualArm value="[string]"/><!-- 0..1 What path was followed -->
 <consent><!-- 0..1 Reference(Consent) Agreement to participate in study --></consent>
</ResearchSubject>

JSON Template

{
  "resourceType" : "ResearchSubject",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business Identifer for event
  "status" : "<code>", // R!  candidate | enrolled | active | suspended | withdrawn | completed
  "period" : { Period }, // Start and end of participation
  "study" : { Reference(ResearchStudy) }, // R!  Study subject is part of
  "individual" : { Reference(Patient) }, // R!  Who is part of study
  "assignedArm" : "<string>", // What path should be followed
  "actualArm" : "<string>", // What path was followed
  "consent" : { Reference(Consent) } // Agreement to participate in study
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ResearchSubject;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchSubject.identifier [ Identifier ]; # 0..1 Business Identifer for event
  fhir:ResearchSubject.status [ code ]; # 1..1 candidate | enrolled | active | suspended | withdrawn | completed
  fhir:ResearchSubject.period [ Period ]; # 0..1 Start and end of participation
  fhir:ResearchSubject.study [ Reference(ResearchStudy) ]; # 1..1 Study subject is part of
  fhir:ResearchSubject.individual [ Reference(Patient) ]; # 1..1 Who is part of study
  fhir:ResearchSubject.assignedArm [ string ]; # 0..1 What path should be followed
  fhir:ResearchSubject.actualArm [ string ]; # 0..1 What path was followed
  fhir:ResearchSubject.consent [ Reference(Consent) ]; # 0..1 Agreement to participate in study
]

Changes since DSTU2

This resource did not exist in Release 2

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

8.23.1.1 Terminology Bindings

Path	Definition	Type	Reference
ResearchSubject.status	Indicates the progression of a study subject through a study	Required	ResearchSubjectStatus

Path

Definition

Type

Reference

ResearchSubject.status

Indicates the progression of a study subject through a study

Required

ResearchSubjectStatus

8.23.2 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Paths	In Common
date	date	Start and end of participation	ResearchSubject.period
identifier	token	Business Identifer for event	ResearchSubject.identifier
individual	reference	Who is part of study	ResearchSubject.individual (Patient)
patient	reference	Who is part of study	ResearchSubject.individual (Patient)
status	token	candidate \| enrolled \| active \| suspended \| withdrawn \| completed	ResearchSubject.status