FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.25.13 Resource ResearchStudy - Search Parameters

Biomedical Research and Regulation icon Work GroupMaturity Level: N/A  Trial UseSecurity 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

Generated Narrative: SearchParameter ResearchStudy-classifier

8.25.14 classifier

Parameter classifier:token

Classification for the study

ResourceResearchStudy
Expression ResearchStudy.classifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-condition

8.25.15 condition

Parameter condition:token

Condition being studied

ResourceResearchStudy
Expression ResearchStudy.condition
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-date

8.25.16 date

Parameter date:date

When the study began and ended

ResourceResearchStudy
Expression ResearchStudy.period
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-description

8.25.17 description

Parameter description:string

Detailed narrative of the study

ResourceResearchStudy
Expression ResearchStudy.description
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-eligibility

8.25.18 eligibility

Parameter eligibility:reference

Inclusion and exclusion criteria

ResourceResearchStudy
Expression ResearchStudy.recruitment.eligibility
Processing Mode Normal
Target Resources Group
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-focus-code

8.25.19 focus-code

Parameter focus-code:token

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

ResourceResearchStudy
Expression ResearchStudy.focus.concept
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-focus-reference

8.25.20 focus-reference

Parameter focus-reference:reference

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

ResourceResearchStudy
Expression ResearchStudy.focus.reference
Processing Mode Normal
Target Resources MedicinalProductDefinition, EvidenceVariable, SubstanceDefinition, Medication
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-identifier

8.25.21 identifier

Parameter identifier:token

Business Identifier for study

ResourceResearchStudy
Expression ResearchStudy.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-keyword

8.25.22 keyword

Parameter keyword:token

Used to search for the study

ResourceResearchStudy
Expression ResearchStudy.keyword
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-name

8.25.23 name

Parameter name:string

Name for this study

ResourceResearchStudy
Expression ResearchStudy.name
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-objective-description

8.25.24 objective-description

Parameter objective-description:string

Free text description of the objective of the study

ResourceResearchStudy
Expression ResearchStudy.objective.description
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-objective-type

8.25.25 objective-type

Parameter objective-type:token

The kind of study objective

ResourceResearchStudy
Expression ResearchStudy.objective.type
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-part-of

8.25.26 part-of

Parameter part-of:reference

Part of larger study

ResourceResearchStudy
Expression ResearchStudy.partOf
Processing Mode Normal
Target Resources ResearchStudy
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-phase

8.25.27 phase

Parameter phase:token

The stage in the progression of a study

ResourceResearchStudy
Expression ResearchStudy.phase
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-progress-status-state-actual

8.25.28 progress-status-state-actual

Parameter progress-status-state-actual:composite

Status of study by state and actual

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

Comparators

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

Generated Narrative: SearchParameter ResearchStudy-progress-status-state-period

8.25.29 progress-status-state-period

Parameter progress-status-state-period:composite

Status of study by state and period

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

Comparators

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

Generated Narrative: SearchParameter ResearchStudy-progress-status-state-period-actual

8.25.30 progress-status-state-period-actual

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

Status of study by state, period and actual

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

Comparators

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

Generated Narrative: SearchParameter ResearchStudy-protocol

8.25.31 protocol

Parameter protocol:reference

Steps followed in executing study

ResourceResearchStudy
Expression ResearchStudy.protocol
Processing Mode Normal
Target Resources PlanDefinition
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-recruitment-actual

8.25.32 recruitment-actual

Parameter recruitment-actual:number

Actual number of participants enrolled in study across all groups

ResourceResearchStudy
Expression ResearchStudy.recruitment.actualNumber
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-recruitment-target

8.25.33 recruitment-target

Parameter recruitment-target:number

Target number of participants enrolled in study across all groups

ResourceResearchStudy
Expression ResearchStudy.recruitment.targetNumber
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-region

8.25.34 region

Parameter region:token

Geographic area for the study

ResourceResearchStudy
Expression ResearchStudy.region
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-site

8.25.35 site

Parameter site:reference

Facility where study activities are conducted

ResourceResearchStudy
Expression ResearchStudy.site
Processing Mode Normal
Target Resources Organization, ResearchStudy, Location
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-status

8.25.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
Expression ResearchStudy.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-study-design

8.25.37 study-design

Parameter study-design:token

Classifications of the study design characteristics

ResourceResearchStudy
Expression ResearchStudy.studyDesign
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter ResearchStudy-title

8.25.38 title

Parameter title:string

The human readable name of the research study

ResourceResearchStudy
Expression ResearchStudy.title
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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