Healthy Route Implementation Guide
0.1.0 - ci-build
Healthy Route Implementation Guide, published by Savannah Informatics. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/healthy-route-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-research-study | Version: 0.1.0 | |||
| Draft as of 2026-09-04 | Computable Name: HRResearchStudy | |||
A country's approved protocol, and the parties, sites and targets it names.
Carries the variation between participating countries as instance data. A consumer reading this resource can establish which protocol version a participant was enrolled under, who sponsored it, which sites recruited for it and what it set out to measure, without holding a copy of the protocol document.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Protocol number |
![]() ![]() |
S | 1..1 | string | Protocol version |
![]() ![]() |
SΣ | 1..1 | string | Human readable name of the study |
![]() ![]() |
SΣ | 0..* | Reference(PlanDefinition) | Steps followed in executing study |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes that convey the current publication status of the research study resource. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (preferred): Codes for the main intent of the study. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Classifications of the study design characteristics Binding: StudyDesign (preferred): This is a set of terms for study design characteristics. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Country the protocol was approved for Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study |
![]() ![]() |
SΣ | 0..1 | Period | Recruitment period |
![]() ![]() |
SΣ | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted |
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair Binding: ResearchStudyPartyRole (extensible): desc. |
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) |
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | CodeableConcept | Label for status or state (e.g. recruitment status) Binding: ResearchStudyStatus (extensible): defn. | |
![]() ![]() |
SΣ | 1..1 | BackboneElement | Target or actual group of participants enrolled in study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled |
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study |
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | preferred | Research Study Primary Purpose Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.studyDesign | Base | preferred | Study Design | 📍5.0.0 | FHIR Std. |
| ResearchStudy.region | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.role | Base | extensible | Research Study Party Role | 📍5.0.0 | FHIR Std. |
| ResearchStudy.progressStatus.state | Base | extensible | Research Study Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ResearchStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
S | 1..* | Identifier | Protocol number |
![]() ![]() |
S | 1..1 | string | Protocol version |
![]() ![]() |
S | 1..1 | string | Human readable name of the study |
![]() ![]() |
S | 0..* | Reference(PlanDefinition) | Steps followed in executing study |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() |
S | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility |
![]() ![]() |
S | 0..* | CodeableConcept | Classifications of the study design characteristics |
![]() ![]() |
S | 1..* | CodeableConcept | Country the protocol was approved for |
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study |
![]() ![]() |
S | 0..1 | Period | Recruitment period |
![]() ![]() |
S | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted |
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair |
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) |
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open |
![]() ![]() |
S | 1..1 | BackboneElement | Target or actual group of participants enrolled in study |
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled |
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study |
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study |
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..1 | uri | Canonical identifier for this study resource | |||||
![]() ![]() |
SΣ | 1..* | Identifier | Protocol number | ||||
![]() ![]() |
S | 1..1 | string | Protocol version | ||||
![]() ![]() |
0..1 | string | Name for this study (computer friendly) | |||||
![]() ![]() |
SΣ | 1..1 | string | Human readable name of the study | ||||
![]() ![]() |
0..* | BackboneElement | Additional names for the study | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid Binding: TitleType (extensible): desc. | |||||
![]() ![]() ![]() |
0..1 | string | The name | |||||
![]() ![]() |
SΣ | 0..* | Reference(PlanDefinition) | Steps followed in executing study | ||||
![]() ![]() |
Σ | 0..* | Reference(ResearchStudy) | Part of larger study | ||||
![]() ![]() |
0..* | RelatedArtifact | References, URLs, and attachments | |||||
![]() ![]() |
0..1 | dateTime | Date the resource last changed | |||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes that convey the current publication status of the research study resource. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (preferred): Codes for the main intent of the study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 Binding: ResearchStudyPhase (example): Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Classifications of the study design characteristics Binding: StudyDesign (preferred): This is a set of terms for study design characteristics. | ||||
![]() ![]() |
0..* | CodeableReference(Medication | MedicinalProductDefinition | SubstanceDefinition | EvidenceVariable) | Drugs, devices, etc. under study Binding: ResearchStudyFocusType (example): Common codes of research study focus | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Condition being studied Binding: ConditionProblemDiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Used to search for the study Binding Description: (example): Words associated with the study that may be useful in discovery. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Country the protocol was approved for Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Brief text explaining the study | |||||
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study | ||||
![]() ![]() |
SΣ | 0..1 | Period | Recruitment period | ||||
![]() ![]() |
SΣ | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted | ||||
![]() ![]() |
0..* | Annotation | Comments made about the study | |||||
![]() ![]() |
0..* | CodeableConcept | Classification for the study Binding: ResearchStudyClassifiers (example): desc. | |||||
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of associated party | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair Binding: ResearchStudyPartyRole (extensible): desc. | ||||
![]() ![]() ![]() |
0..* | Period | When active in the role | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | nih | fda | government | nonprofit | academic | industry Binding: ResearchStudyPartyOrgType (example): A characterization or type of the entity. | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Label for status or state (e.g. recruitment status) Binding: ResearchStudyStatus (extensible): defn. | |||||
![]() ![]() ![]() |
0..1 | boolean | Actual if true else anticipated | |||||
![]() ![]() ![]() |
0..1 | Period | Date range | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design Binding: ResearchStudyReasonStopped (example): Codes for why the study ended prematurely. | ||||
![]() ![]() |
SΣ | 1..1 | BackboneElement | Target or actual group of participants enrolled in study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled | ||||
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study | ||||
![]() ![]() ![]() |
0..1 | Reference(Group | EvidenceVariable) | Inclusion and exclusion criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group) | Group of participants who were enrolled in study | ||||
![]() ![]() |
0..* | BackboneElement | Defined path through the study for a subject | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | id | Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily | |||||
![]() ![]() ![]() |
1..1 | string | Label for study comparisonGroup | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Categorization of study comparisonGroup Binding: ResearchStudyArmType (extensible): desc. | |||||
![]() ![]() ![]() |
0..1 | markdown | Short explanation of study path | |||||
![]() ![]() ![]() |
0..* | Reference(EvidenceVariable) | Interventions or exposures in this comparisonGroup or cohort | |||||
![]() ![]() ![]() |
0..1 | Reference(Group) | Group of participants who were enrolled in study comparisonGroup | |||||
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Label for the objective | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective. | |||||
![]() ![]() ![]() |
0..1 | markdown | Description of the objective | |||||
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Label for the outcome | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): defn. | |||||
![]() ![]() ![]() |
0..1 | markdown | Description of the outcome | |||||
![]() ![]() ![]() |
0..1 | Reference(EvidenceVariable) | Structured outcome definition | |||||
![]() ![]() |
Σ | 0..* | Reference(EvidenceReport | Citation | DiagnosticReport) | Link to results generated during the study | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ResearchStudy.label.type | Base | extensible | Title Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | preferred | Research Study Primary Purpose Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.phase | Base | example | Research Study Phase | 📍5.0.0 | FHIR Std. |
| ResearchStudy.studyDesign | Base | preferred | Study Design | 📍5.0.0 | FHIR Std. |
| ResearchStudy.focus | Base | example | Research Study Focus Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std. |
| ResearchStudy.keyword | Base | example | Not State | Unknown | |
| ResearchStudy.region | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ResearchStudy.classifier | Base | example | Research Study Classifiers | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.role | Base | extensible | Research Study Party Role | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.classifier | Base | example | Research Study Party Organization Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.progressStatus.state | Base | extensible | Research Study Status | 📍5.0.0 | FHIR Std. |
| ResearchStudy.whyStopped | Base | example | Research Study Reason Stopped | 📍5.0.0 | FHIR Std. |
| ResearchStudy.comparisonGroup.type | Base | extensible | Research Study Arm Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.objective.type | Base | preferred | Research Study Objective Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.outcomeMeasure.type | Base | preferred | Research Study Objective Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ResearchStudy
Summary
Mandatory: 8 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Protocol number |
![]() ![]() |
S | 1..1 | string | Protocol version |
![]() ![]() |
SΣ | 1..1 | string | Human readable name of the study |
![]() ![]() |
SΣ | 0..* | Reference(PlanDefinition) | Steps followed in executing study |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes that convey the current publication status of the research study resource. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (preferred): Codes for the main intent of the study. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | Classifications of the study design characteristics Binding: StudyDesign (preferred): This is a set of terms for study design characteristics. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Country the protocol was approved for Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study |
![]() ![]() |
SΣ | 0..1 | Period | Recruitment period |
![]() ![]() |
SΣ | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted |
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair Binding: ResearchStudyPartyRole (extensible): desc. |
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) |
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | CodeableConcept | Label for status or state (e.g. recruitment status) Binding: ResearchStudyStatus (extensible): defn. | |
![]() ![]() |
SΣ | 1..1 | BackboneElement | Target or actual group of participants enrolled in study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled |
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study |
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | preferred | Research Study Primary Purpose Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.studyDesign | Base | preferred | Study Design | 📍5.0.0 | FHIR Std. |
| ResearchStudy.region | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.role | Base | extensible | Research Study Party Role | 📍5.0.0 | FHIR Std. |
| ResearchStudy.progressStatus.state | Base | extensible | Research Study Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from ResearchStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
S | 1..* | Identifier | Protocol number |
![]() ![]() |
S | 1..1 | string | Protocol version |
![]() ![]() |
S | 1..1 | string | Human readable name of the study |
![]() ![]() |
S | 0..* | Reference(PlanDefinition) | Steps followed in executing study |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown |
![]() ![]() |
S | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility |
![]() ![]() |
S | 0..* | CodeableConcept | Classifications of the study design characteristics |
![]() ![]() |
S | 1..* | CodeableConcept | Country the protocol was approved for |
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study |
![]() ![]() |
S | 0..1 | Period | Recruitment period |
![]() ![]() |
S | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted |
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair |
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) |
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open |
![]() ![]() |
S | 1..1 | BackboneElement | Target or actual group of participants enrolled in study |
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled |
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study |
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study |
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchStudy | Investigation to increase healthcare-related patient-independent knowledge | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..1 | uri | Canonical identifier for this study resource | |||||
![]() ![]() |
SΣ | 1..* | Identifier | Protocol number | ||||
![]() ![]() |
S | 1..1 | string | Protocol version | ||||
![]() ![]() |
0..1 | string | Name for this study (computer friendly) | |||||
![]() ![]() |
SΣ | 1..1 | string | Human readable name of the study | ||||
![]() ![]() |
0..* | BackboneElement | Additional names for the study | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid Binding: TitleType (extensible): desc. | |||||
![]() ![]() ![]() |
0..1 | string | The name | |||||
![]() ![]() |
SΣ | 0..* | Reference(PlanDefinition) | Steps followed in executing study | ||||
![]() ![]() |
Σ | 0..* | Reference(ResearchStudy) | Part of larger study | ||||
![]() ![]() |
0..* | RelatedArtifact | References, URLs, and attachments | |||||
![]() ![]() |
0..1 | dateTime | Date the resource last changed | |||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes that convey the current publication status of the research study resource. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (preferred): Codes for the main intent of the study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 Binding: ResearchStudyPhase (example): Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Classifications of the study design characteristics Binding: StudyDesign (preferred): This is a set of terms for study design characteristics. | ||||
![]() ![]() |
0..* | CodeableReference(Medication | MedicinalProductDefinition | SubstanceDefinition | EvidenceVariable) | Drugs, devices, etc. under study Binding: ResearchStudyFocusType (example): Common codes of research study focus | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Condition being studied Binding: ConditionProblemDiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Used to search for the study Binding Description: (example): Words associated with the study that may be useful in discovery. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Country the protocol was approved for Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Brief text explaining the study | |||||
![]() ![]() |
S | 0..1 | markdown | Detailed narrative of the study | ||||
![]() ![]() |
SΣ | 0..1 | Period | Recruitment period | ||||
![]() ![]() |
SΣ | 1..* | Reference(Healthy Route Organization | Healthy Route Location) | Facility where study activities are conducted | ||||
![]() ![]() |
0..* | Annotation | Comments made about the study | |||||
![]() ![]() |
0..* | CodeableConcept | Classification for the study Binding: ResearchStudyClassifiers (example): desc. | |||||
![]() ![]() |
S | 1..* | BackboneElement | Sponsors, collaborators, and other parties | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of associated party | |||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair Binding: ResearchStudyPartyRole (extensible): desc. | ||||
![]() ![]() ![]() |
0..* | Period | When active in the role | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | nih | fda | government | nonprofit | academic | industry Binding: ResearchStudyPartyOrgType (example): A characterization or type of the entity. | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(Healthy Route Practitioner | Healthy Route Organization) | Individual or organization associated with study (use practitionerRole to specify their organisation) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Whether recruitment is open | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Label for status or state (e.g. recruitment status) Binding: ResearchStudyStatus (extensible): defn. | |||||
![]() ![]() ![]() |
0..1 | boolean | Actual if true else anticipated | |||||
![]() ![]() ![]() |
0..1 | Period | Date range | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design Binding: ResearchStudyReasonStopped (example): Codes for why the study ended prematurely. | ||||
![]() ![]() |
SΣ | 1..1 | BackboneElement | Target or actual group of participants enrolled in study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | unsignedInt | Estimated total number of participants to be enrolled | ||||
![]() ![]() ![]() |
S | 0..1 | unsignedInt | Actual total number of participants enrolled in study | ||||
![]() ![]() ![]() |
0..1 | Reference(Group | EvidenceVariable) | Inclusion and exclusion criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Group) | Group of participants who were enrolled in study | ||||
![]() ![]() |
0..* | BackboneElement | Defined path through the study for a subject | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | id | Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily | |||||
![]() ![]() ![]() |
1..1 | string | Label for study comparisonGroup | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Categorization of study comparisonGroup Binding: ResearchStudyArmType (extensible): desc. | |||||
![]() ![]() ![]() |
0..1 | markdown | Short explanation of study path | |||||
![]() ![]() ![]() |
0..* | Reference(EvidenceVariable) | Interventions or exposures in this comparisonGroup or cohort | |||||
![]() ![]() ![]() |
0..1 | Reference(Group) | Group of participants who were enrolled in study comparisonGroup | |||||
![]() ![]() |
S | 0..* | BackboneElement | A goal for the study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Label for the objective | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective. | |||||
![]() ![]() ![]() |
0..1 | markdown | Description of the objective | |||||
![]() ![]() |
S | 0..* | BackboneElement | A variable measured during the study | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Label for the outcome | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): defn. | |||||
![]() ![]() ![]() |
0..1 | markdown | Description of the outcome | |||||
![]() ![]() ![]() |
0..1 | Reference(EvidenceVariable) | Structured outcome definition | |||||
![]() ![]() |
Σ | 0..* | Reference(EvidenceReport | Citation | DiagnosticReport) | Link to results generated during the study | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ResearchStudy.label.type | Base | extensible | Title Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | preferred | Research Study Primary Purpose Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.phase | Base | example | Research Study Phase | 📍5.0.0 | FHIR Std. |
| ResearchStudy.studyDesign | Base | preferred | Study Design | 📍5.0.0 | FHIR Std. |
| ResearchStudy.focus | Base | example | Research Study Focus Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std. |
| ResearchStudy.keyword | Base | example | Not State | Unknown | |
| ResearchStudy.region | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| ResearchStudy.classifier | Base | example | Research Study Classifiers | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.role | Base | extensible | Research Study Party Role | 📍5.0.0 | FHIR Std. |
| ResearchStudy.associatedParty.classifier | Base | example | Research Study Party Organization Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.progressStatus.state | Base | extensible | Research Study Status | 📍5.0.0 | FHIR Std. |
| ResearchStudy.whyStopped | Base | example | Research Study Reason Stopped | 📍5.0.0 | FHIR Std. |
| ResearchStudy.comparisonGroup.type | Base | extensible | Research Study Arm Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.objective.type | Base | preferred | Research Study Objective Type | 📍5.0.0 | FHIR Std. |
| ResearchStudy.outcomeMeasure.type | Base | preferred | Research Study Objective Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from ResearchStudy
Summary
Mandatory: 8 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron