Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

8.24.14 Resource ResearchStudy - Search Parameters

Biomedical Research and Regulation icon Work Group Maturity Level : N/A   Trial Use Security Category : Business Compartments : No 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.15 classifier

Parameter classifier : token

Classification for the study

Resource ResearchStudy
Expression ResearchStudy.classifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-condition

8.24.16 condition

Parameter condition : token

Condition being studied

Resource ResearchStudy
Expression ResearchStudy.condition
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-date

8.24.17 date

Parameter date : date

When the study began and ended

Resource ResearchStudy
Expression ResearchStudy.period
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-description

8.24.18 description

Parameter description : string

Detailed narrative of the study

Resource ResearchStudy
Expression ResearchStudy.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-eligibility

8.24.19 eligibility

Parameter eligibility : reference

Inclusion and exclusion criteria

Resource ResearchStudy
Expression ResearchStudy.recruitment.eligibility
Processing Mode Normal
Target Resources Group , EvidenceVariable
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-focus-code

8.24.20 focus-code

Parameter focus-code : token

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

Resource ResearchStudy
Expression ResearchStudy.focus.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-focus-reference

8.24.21 focus-reference

Parameter focus-reference : reference

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

Resource ResearchStudy
Expression ResearchStudy.focus.reference
Processing Mode Normal
Target Resources MedicinalProductDefinition , EvidenceVariable , SubstanceDefinition , Medication
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-identifier

8.24.22 identifier

Parameter identifier : token

Business Identifier for study

Resource ResearchStudy
Expression ResearchStudy.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-keyword

8.24.23 keyword

Parameter keyword : token

Used to search for the study

Resource ResearchStudy
Expression ResearchStudy.keyword
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-name

8.24.24 name

Parameter name : string

Name for this study

Resource ResearchStudy
Expression ResearchStudy.name
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-objective-description

8.24.25 objective-description

Parameter objective-description : string

Free text description of the objective of the study

Resource ResearchStudy
Expression ResearchStudy.objective.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-objective-type

8.24.26 objective-type

Parameter objective-type : token

The kind of study objective

Resource ResearchStudy
Expression ResearchStudy.objective.type
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-part-of

8.24.27 part-of

Parameter part-of : reference

Part of larger study

Resource ResearchStudy
Expression ResearchStudy.partOf
Processing Mode Normal
Target Resources ResearchStudy
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-phase

8.24.28 phase

Parameter phase : token

The stage in the progression of a study

Resource ResearchStudy
Expression ResearchStudy.phase
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-progress-status-state-actual

8.24.29 progress-status-state-actual

Parameter progress-status-state-actual : composite

Status of study by state and actual

Resource ResearchStudy
Expression ResearchStudy.progressStatus
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components

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

8.24.30 progress-status-state-period

Parameter progress-status-state-period : composite

Status of study by state and period

Resource ResearchStudy
Expression ResearchStudy.progressStatus
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components

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

8.24.31 progress-status-state-period-actual

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

Status of study by state, period and actual

Resource ResearchStudy
Expression ResearchStudy.progressStatus
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components

http://hl7.org/fhir/SearchParameter/ResearchStudy-state state
http://hl7.org/fhir/SearchParameter/ResearchStudy-period period
http://hl7.org/fhir/SearchParameter/ResearchStudy-actual actual
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-protocol

8.24.32 protocol

Parameter protocol : reference

Steps followed in executing study

Resource ResearchStudy
Expression ResearchStudy.protocol
Processing Mode Normal
Target Resources PlanDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-recruitment-actual

8.24.33 recruitment-actual

Parameter recruitment-actual : number

Actual number of participants enrolled in study across all groups

Resource ResearchStudy
Expression ResearchStudy.recruitment.actualNumber
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-recruitment-target

8.24.34 recruitment-target

Parameter recruitment-target : number

Target number of participants enrolled in study across all groups

Resource ResearchStudy
Expression ResearchStudy.recruitment.targetNumber
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-region

8.24.35 region

Parameter region : token

Geographic area for the study

Resource ResearchStudy
Expression ResearchStudy.region
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-site

8.24.36 site

Parameter site : reference

Facility where study activities are conducted

Resource ResearchStudy
Expression ResearchStudy.site
Processing Mode Normal
Target Resources Organization , ResearchStudy , Location
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-status

8.24.37 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

Resource ResearchStudy
Expression ResearchStudy.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-study-design

8.24.38 study-design

Parameter study-design : token

Classifications of the study design characteristics

Resource ResearchStudy
Expression ResearchStudy.studyDesign
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ResearchStudy-title

8.24.39 title

Parameter title : string

The human readable name of the research study

Resource ResearchStudy
Expression ResearchStudy.title
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true