Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ResearchStudy resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ResearchStudy | |
| Definition | 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. A ResearchStudy involves the gathering of information about human or animal subjects. |
| Short | Investigation to increase healthcare-related patient-independent knowledge |
| Comments | Need to make sure we encompass public health studies. |
| Control | 0..* |
| Alternate Names | Clinical Trial, Study |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. ResearchStudy.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. ResearchStudy.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. ResearchStudy.extension:primaryPurposeType | |
| Slice Name | primaryPurposeType |
| Definition | R4: |
| Short | R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. ResearchStudy.extension:phase | |
| Slice Name | phase |
| Definition | R4: |
| Short | R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. ResearchStudy.extension:condition | |
| Slice Name | condition |
| Definition | R4: |
| Short | R4: Condition being studied (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Condition being studied (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. ResearchStudy.extension:objective | |
| Slice Name | objective |
| Definition | R4: |
| Short | R4: A goal for the study (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: A goal for the study (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. ResearchStudy.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 16. ResearchStudy.status | |
| Definition | The current state of the study. |
| Short | draft | in-progress | suspended | stopped | completed | entered-in-error |
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ResearchStudyStatus http://hl7.org/fhir/ValueSet/research-study-status|3.0.2(required to http://hl7.org/fhir/ValueSet/research-study-status|3.0.2)Codes that convey the current status of the research study |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 18. ResearchStudy.status.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. ResearchStudy.status.extension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ResearchStudy | |
| 2. ResearchStudy.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. ResearchStudy.extension:primaryPurposeType | |
| Slice Name | primaryPurposeType |
| Definition | R4: |
| Short | R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept) |
| 6. ResearchStudy.extension:phase | |
| Slice Name | phase |
| Definition | R4: |
| Short | R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)) (Extension Type: CodeableConcept) |
| 8. ResearchStudy.extension:condition | |
| Slice Name | condition |
| Definition | R4: |
| Short | R4: Condition being studied (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Condition being studied (new)) (Extension Type: CodeableConcept) |
| 10. ResearchStudy.extension:objective | |
| Slice Name | objective |
| Definition | R4: |
| Short | R4: A goal for the study (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: A goal for the study (new)) (Complex Extension) |
| 12. ResearchStudy.status | |
| 14. ResearchStudy.status.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. ResearchStudy.status.extension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn) (Extension Type: code) |
| 18. ResearchStudy.principalInvestigator | |
| 20. ResearchStudy.principalInvestigator.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on ResearchStudy.principalInvestigator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. ResearchStudy.principalInvestigator.extension:principalInvestigator | |
| Slice Name | principalInvestigator |
| Definition | R4: |
| Short | R4: Researcher who oversees multiple aspects of the study additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ResearchStudy | |||||
| Definition | 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. A ResearchStudy involves the gathering of information about human or animal subjects. | ||||
| Short | Investigation to increase healthcare-related patient-independent knowledge | ||||
| Comments | Need to make sure we encompass public health studies. | ||||
| Control | 0..* | ||||
| Alternate Names | Clinical Trial, Study | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. ResearchStudy.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. ResearchStudy.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. ResearchStudy.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. ResearchStudy.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. ResearchStudy.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. ResearchStudy.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. ResearchStudy.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. ResearchStudy.extension:primaryPurposeType | |||||
| Slice Name | primaryPurposeType | ||||
| Definition | R4: | ||||
| Short | R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. ResearchStudy.extension:phase | |||||
| Slice Name | phase | ||||
| Definition | R4: | ||||
| Short | R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. ResearchStudy.extension:condition | |||||
| Slice Name | condition | ||||
| Definition | R4: | ||||
| Short | R4: Condition being studied (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Condition being studied (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. ResearchStudy.extension:objective | |||||
| Slice Name | objective | ||||
| Definition | R4: | ||||
| Short | R4: A goal for the study (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: A goal for the study (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. ResearchStudy.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 26. ResearchStudy.identifier | |||||
| Definition | Identifiers assigned to this research study by the sponsor or other systems. | ||||
| Short | Business Identifier for study | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers. | ||||
| 28. ResearchStudy.title | |||||
| Definition | A short, descriptive user-friendly label for the study. | ||||
| Short | Name for this study | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 30. ResearchStudy.protocol | |||||
| Definition | The set of steps expected to be performed as part of the execution of the study. | ||||
| Short | Steps followed in executing study | ||||
| Control | 0..* | ||||
| Type | Reference(PlanDefinition) | ||||
| Summary | true | ||||
| 32. ResearchStudy.partOf | |||||
| Definition | A larger research study of which this particular study is a component or step. | ||||
| Short | Part of larger study | ||||
| Control | 0..* | ||||
| Type | Reference(ResearchStudy) | ||||
| Summary | true | ||||
| Requirements | Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc. | ||||
| Alternate Names | container | ||||
| 34. ResearchStudy.status | |||||
| Definition | The current state of the study. | ||||
| Short | draft | in-progress | suspended | stopped | completed | entered-in-error | ||||
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ResearchStudyStatus ![]() (required to http://hl7.org/fhir/ValueSet/research-study-status|3.0.2)Codes that convey the current status of the research study | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 36. ResearchStudy.status.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 38. ResearchStudy.status.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. ResearchStudy.status.extension:status | |||||
| Slice Name | status | ||||
| Definition | R4: | ||||
| Short | R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 42. ResearchStudy.status.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 44. ResearchStudy.category | |||||
| Definition | Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc. | ||||
| Short | Classifications for the study | ||||
| Control | 0..* | ||||
| Binding | Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 46. ResearchStudy.focus | |||||
| Definition | The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about. | ||||
| Short | Drugs, devices, conditions, etc. under study | ||||
| Control | 0..* | ||||
| Binding | Codes for medications, devices, conditions and other interventions | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 48. ResearchStudy.contact | |||||
| Definition | Contact details to assist a user in learning more about or engaging with the study. | ||||
| Short | Contact details for the study | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 50. ResearchStudy.relatedArtifact | |||||
| Definition | Citations, references and other related documents. | ||||
| Short | References and dependencies | ||||
| Control | 0..* | ||||
| Type | RelatedArtifact | ||||
| 52. ResearchStudy.keyword | |||||
| Definition | Key terms to aid in searching for or filtering the study. | ||||
| Short | Used to search for the study | ||||
| Control | 0..* | ||||
| Binding | Words associated with the study that may be useful in discovery | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 54. ResearchStudy.jurisdiction | |||||
| Definition | Indicates a country, state or other region where the study is taking place. | ||||
| Short | Geographic region(s) for study | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)Countries and regions within which this artifact is targeted for use | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 56. ResearchStudy.description | |||||
| Definition | A full description of how the study is being conducted. | ||||
| Short | What this is study doing | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 58. ResearchStudy.enrollment | |||||
| Definition | Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes". | ||||
| Short | Inclusion & exclusion criteria | ||||
| Comments | The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource. | ||||
| Control | 0..* | ||||
| Type | Reference(Group) | ||||
| Summary | true | ||||
| Alternate Names | patient | ||||
| 60. ResearchStudy.period | |||||
| Definition | Identifies the start date and the expected (or actual, depending on status) end date for the study. | ||||
| Short | When the study began and ended | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | [The list of types may be constrained as appropriate for the type of event]. | ||||
| Alternate Names | timing | ||||
| 62. ResearchStudy.sponsor | |||||
| Definition | The organization responsible for the execution of the study. | ||||
| Short | Organization responsible for the study | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 64. ResearchStudy.principalInvestigator | |||||
| Definition | Indicates the individual who has primary oversite of the execution of the study. | ||||
| Short | The individual responsible for the study | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner) | ||||
| Summary | true | ||||
| 66. ResearchStudy.principalInvestigator.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 68. ResearchStudy.principalInvestigator.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on ResearchStudy.principalInvestigator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. ResearchStudy.principalInvestigator.extension:principalInvestigator | |||||
| Slice Name | principalInvestigator | ||||
| Definition | R4: | ||||
| Short | R4: Researcher who oversees multiple aspects of the study additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 72. ResearchStudy.principalInvestigator.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 74. ResearchStudy.principalInvestigator.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 76. ResearchStudy.principalInvestigator.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 78. ResearchStudy.site | |||||
| Definition | Clinic, hospital or other healthcare location that is participating in the study. | ||||
| Short | Location involved in study execution | ||||
| Control | 0..* | ||||
| Type | Reference(Location) | ||||
| Summary | true | ||||
| 80. ResearchStudy.reasonStopped | |||||
| Definition | A description and/or code explaining the premature termination of the study. | ||||
| Short | Reason for terminating study early | ||||
| Control | 0..1 | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 82. ResearchStudy.note | |||||
| Definition | Comments made about the event by the performer, subject or other participants. | ||||
| Short | Comments made about the event | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| 84. ResearchStudy.arm | |||||
| Definition | Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. | ||||
| Short | Defined path through the study for a subject | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 86. ResearchStudy.arm.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 88. ResearchStudy.arm.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 90. ResearchStudy.arm.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 92. ResearchStudy.arm.name | |||||
| Definition | Unique, human-readable label for this arm of the study. | ||||
| Short | Label for study arm | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 94. ResearchStudy.arm.code | |||||
| Definition | Categorization of study arm, e.g. experimental, active comparator, placebo comparater. | ||||
| Short | Categorization of study arm | ||||
| Control | 0..1 | ||||
| Type | CodeableConcept | ||||
| 96. ResearchStudy.arm.description | |||||
| Definition | A succinct description of the path through the study that would be followed by a subject adhering to this arm. | ||||
| Short | Short explanation of study path | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||