R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.24.13 Resource ResearchStudy - Search Parameters

Biomedical Research and Regulation icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Search parameters for the Resource ResearchStudy - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

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

http://hl7.org/fhir/SearchParameter/ResearchStudy-classifier

8.24.14 classifier

Parameter classifier:token

Classification for the study

ResourceResearchStudy
ExpressionResearchStudy.classifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-condition

8.24.15 condition

Parameter condition:token

Condition being studied

ResourceResearchStudy
ExpressionResearchStudy.condition
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-date

8.24.16 date

Parameter date:date

When the study began and ended

ResourceResearchStudy
ExpressionResearchStudy.period
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-description

8.24.17 description

Parameter description:string

Detailed narrative of the study

ResourceResearchStudy
ExpressionResearchStudy.description
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-eligibility

8.24.18 eligibility

Parameter eligibility:reference

Inclusion and exclusion criteria

ResourceResearchStudy
ExpressionResearchStudy.recruitment.eligibility
Processing ModeNormal
Target ResourcesGroup, EvidenceVariable
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-focus-code

8.24.19 focus-code

Parameter focus-code:token

Drugs, devices, etc. under study, as a code

ResourceResearchStudy
ExpressionResearchStudy.focus.concept
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-focus-reference

8.24.20 focus-reference

Parameter focus-reference:reference

Drugs, devices, etc. under study, as a reference

ResourceResearchStudy
ExpressionResearchStudy.focus.reference
Processing ModeNormal
Target ResourcesMedicinalProductDefinition, EvidenceVariable, SubstanceDefinition, Medication
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-identifier

8.24.21 identifier

Parameter identifier:token

Business Identifier for study

ResourceResearchStudy
ExpressionResearchStudy.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-keyword

8.24.22 keyword

Parameter keyword:token

Used to search for the study

ResourceResearchStudy
ExpressionResearchStudy.keyword
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-name

8.24.23 name

Parameter name:string

Name for this study

ResourceResearchStudy
ExpressionResearchStudy.name
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-objective-description

8.24.24 objective-description

Parameter objective-description:string

Free text description of the objective of the study

ResourceResearchStudy
ExpressionResearchStudy.objective.description
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-objective-type

8.24.25 objective-type

Parameter objective-type:token

The kind of study objective

ResourceResearchStudy
ExpressionResearchStudy.objective.type
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-part-of

8.24.26 part-of

Parameter part-of:reference

Part of larger study

ResourceResearchStudy
ExpressionResearchStudy.partOf
Processing ModeNormal
Target ResourcesResearchStudy
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-phase

8.24.27 phase

Parameter phase:token

The stage in the progression of a study

ResourceResearchStudy
ExpressionResearchStudy.phase
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-progress-status-state-actual

8.24.28 progress-status-state-actual

Parameter progress-status-state-actual:composite

Status of study by state and actual

ResourceResearchStudy
ExpressionResearchStudy.progressStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/ResearchStudy-statestate
http://hl7.org/fhir/SearchParameter/ResearchStudy-actualactual
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-progress-status-state-period

8.24.29 progress-status-state-period

Parameter progress-status-state-period:composite

Status of study by state and period

ResourceResearchStudy
ExpressionResearchStudy.progressStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/ResearchStudy-statestate
http://hl7.org/fhir/SearchParameter/ResearchStudy-periodperiod
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-progress-status-state-period-actual

8.24.30 progress-status-state-period-actual

Parameter progress-status-state-period-actual:composite

Status of study by state, period and actual

ResourceResearchStudy
ExpressionResearchStudy.progressStatus
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/ResearchStudy-statestate
http://hl7.org/fhir/SearchParameter/ResearchStudy-periodperiod
http://hl7.org/fhir/SearchParameter/ResearchStudy-actualactual
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-protocol

8.24.31 protocol

Parameter protocol:reference

Steps followed in executing study

ResourceResearchStudy
ExpressionResearchStudy.protocol
Processing ModeNormal
Target ResourcesPlanDefinition
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-recruitment-actual

8.24.32 recruitment-actual

Parameter recruitment-actual:number

Actual number of participants enrolled in study across all groups

ResourceResearchStudy
ExpressionResearchStudy.recruitment.actualNumber
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-recruitment-target

8.24.33 recruitment-target

Parameter recruitment-target:number

Target number of participants enrolled in study across all groups

ResourceResearchStudy
ExpressionResearchStudy.recruitment.targetNumber
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-region

8.24.34 region

Parameter region:token

Geographic area for the study

ResourceResearchStudy
ExpressionResearchStudy.region
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-site

8.24.35 site

Parameter site:reference

Facility where study activities are conducted

ResourceResearchStudy
ExpressionResearchStudy.site
Processing ModeNormal
Target ResourcesOrganization, ResearchStudy, Location
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-status

8.24.36 status

Parameter status:token

active | active-but-not-recruiting | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | enrolling-by-invitation | in-review | not-yet-recruiting | recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | terminated | withdrawn

ResourceResearchStudy
ExpressionResearchStudy.status
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-study-design

8.24.37 study-design

Parameter study-design:token

Classifications of the study design characteristics

ResourceResearchStudy
ExpressionResearchStudy.studyDesign
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-title

8.24.38 title

Parameter title:string

The human readable name of the research study

ResourceResearchStudy
ExpressionResearchStudy.title
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values