Research Data Sharing IG
1.0.0 - CI Build International flag

Research Data Sharing IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/research-data-sharing/ and changes regularly. See the Directory of published versions

Resource Profile: ResearchStudyIEHR - Detailed Descriptions

Draft as of 2024-04-08

Definitions for the ResearchStudy-IEHR resource profile.

Guidance on how to interpret the contents of this table can be found here

0. ResearchStudy
Invariantsdom-7: Either ResearchStudy.description or a PDF with documentation must be provided (description.exists() or relatedArtifact.where(type = 'documentation' and document.where(contentType = 'application/pdf' and data.exists()).exists()).exists())
2. ResearchStudy.language
Control1..?
4. ResearchStudy.text
Control1..?
TypeNarrative(NarrativeIEHR)
6. ResearchStudy.extension
SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. ResearchStudy.extension:DataSetDefinition
    Slice NameDataSetDefinition
    Control1..1
    TypeExtension(DataSetDefinitionExtension - IEHR) (Complex Extension)
    10. ResearchStudy.extension:RDDQuestionnaire
    Slice NameRDDQuestionnaire
    TypeExtension(QuestionnaireExtension - IEHR) (Complex Extension)
    12. ResearchStudy.extension:EnrollmentPeriod
    Slice NameEnrollmentPeriod
    Control1..1
    TypeExtension(EnrollmentPeriodExtensionIEHR) (Extension Type: Period)
    14. ResearchStudy.extension:RequestedAnonymizationType
    Slice NameRequestedAnonymizationType
    Control0..1
    TypeExtension(Anonymization Extension - IEHR) (Extension Type: Coding)
    16. ResearchStudy.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    18. ResearchStudy.title
    Control1..?
    20. ResearchStudy.primaryPurposeType
    Control1..?
    22. ResearchStudy.contact
    Control1..?
    24. ResearchStudy.location
    Control1..?
    26. ResearchStudy.description
    Control0..?
    28. ResearchStudy.enrollment
    Control1..?
    TypeReference(Cohort)
    30. ResearchStudy.period
    Control1..?
    32. ResearchStudy.site
    Control1..?
    TypeReference(ResearchLocation)

    Guidance on how to interpret the contents of this table can be found here

    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.

    ShortInvestigation to increase healthcare-related patient-independent knowledge
    Comments

    Need to make sure we encompass public health studies.

    Control0..*
    Is Modifierfalse
    Summaryfalse
    Alternate NamesClinical Trial, Study
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    dom-7: Either ResearchStudy.description or a PDF with documentation must be provided (description.exists() or relatedArtifact.where(type = 'documentation' and document.where(contentType = 'application/pdf' and data.exists()).exists()).exists())
    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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. ResearchStudy.language
    Definition

    The base language in which the resource is written.

    ShortLanguage 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).

    Control10..1
    BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
    (preferred to http://hl7.org/fhir/ValueSet/languages)

    A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. ResearchStudy.text
    Definition

    A human-readable summary of the resource conveying the essential clinical and business information for the resource.


    A human-readable narrative that contains a summary of the resource and can 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.

    ShortHuman-readable summary of the resource (essential clinical and business information)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 information is added later.

    Control10..1
    This element is affected by the following invariants: ele-1
    TypeNarrative(NarrativeIEHR)
    Is Modifierfalse
    Alternate Namesnarrative, html, xhtml, display
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. ResearchStudy.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 10. ResearchStudy.extension:DataSetDefinition
      Slice NameDataSetDefinition
      Definition

      An Extension

      ShortExtension
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(DataSetDefinitionExtension - IEHR) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. ResearchStudy.extension:RDDQuestionnaire
      Slice NameRDDQuestionnaire
      Definition

      An Extension

      ShortExtension
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(QuestionnaireExtension - IEHR) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      14. ResearchStudy.extension:EnrollmentPeriod
      Slice NameEnrollmentPeriod
      Definition

      The period during which participants could enroll in the ResearchStudy

      ShortEnrollment Period
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(EnrollmentPeriodExtensionIEHR) (Extension Type: Period)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. ResearchStudy.extension:RequestedAnonymizationType
      Slice NameRequestedAnonymizationType
      Definition

      The type of anonymization used for the resource

      ShortAnonymization Type
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Anonymization Extension - IEHR) (Extension Type: Coding)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      20. ResearchStudy.identifier
      Definition

      Identifiers assigned to this research study by the sponsor or other systems.

      ShortBusiness Identifier for study
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..*
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. ResearchStudy.title
      Definition

      A short, descriptive user-friendly label for the study.

      ShortName for this study
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. ResearchStudy.status
      Definition

      The current state of the study.

      Shortactive | 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
      Control1..1
      BindingThe codes SHALL be taken from ResearchStudyStatushttp://hl7.org/fhir/ValueSet/research-study-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/research-study-status|4.0.1)

      Codes that convey the current status of the research study.

      Typecode
      Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. ResearchStudy.primaryPurposeType
      Definition

      The type of study based upon the intent of the study's activities. A classification of the intent of the study.

      Shorttreatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
      Control10..1
      BindingUnless not suitable, these codes SHALL be taken from ResearchStudyPrimaryPurposeTypehttp://hl7.org/fhir/ValueSet/research-study-prim-purp-type
      (extensible to http://hl7.org/fhir/ValueSet/research-study-prim-purp-type)

      Codes for the main intent of the study.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. ResearchStudy.contact
      Definition

      Contact details to assist a user in learning more about or engaging with the study.

      ShortContact details for the study
      Control10..*
      TypeContactDetail
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. ResearchStudy.location
      Definition

      Indicates a country, state or other region where the study is taking place.

      ShortGeographic region(s) for study
      Control10..*
      BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction
      (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

      Countries and regions within which this artifact is targeted for use.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. ResearchStudy.description
      Definition

      A full description of how the study is being conducted.

      ShortWhat this is study doing
      Control0..1
      Typemarkdown
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. 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".

      ShortInclusion & exclusion criteria
      Comments

      The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.

      Control10..*
      TypeReference(Cohort, Group)
      Is Modifierfalse
      Summarytrue
      Alternate Namespatient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. ResearchStudy.period
      Definition

      Identifies the start date and the expected (or actual, depending on status) end date for the study.

      ShortWhen the study began and ended
      Control10..1
      TypePeriod
      Is Modifierfalse
      Summarytrue
      Alternate Namestiming
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. ResearchStudy.site
      Definition

      A facility in which study activities are conducted.

      ShortFacility where study activities are conducted
      Control10..*
      TypeReference(ResearchLocation, Location)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      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.

      ShortInvestigation to increase healthcare-related patient-independent knowledge
      Comments

      Need to make sure we encompass public health studies.

      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesClinical Trial, Study
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      dom-7: Either ResearchStudy.description or a PDF with documentation must be provided (description.exists() or relatedArtifact.where(type = 'documentation' and document.where(contentType = 'application/pdf' and data.exists()).exists()).exists())
      2. ResearchStudy.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical 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.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. ResearchStudy.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. ResearchStudy.language
      Definition

      The base language in which the resource is written.

      ShortLanguage 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).

      Control1..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. ResearchStudy.text
      Definition

      A human-readable summary of the resource conveying the essential clinical and business information for the resource.

      ShortHuman-readable summary of the resource (essential clinical and business information)
      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 information is added later.

      Control1..1
      This element is affected by the following invariants: ele-1
      TypeNarrative(NarrativeIEHR)
      Is Modifierfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      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.

      ShortContained, 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. ResearchStudy.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. ResearchStudy.extension:DataSetDefinition
        Slice NameDataSetDefinition
        Definition

        An Extension

        ShortExtension
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(DataSetDefinitionExtension - IEHR) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. ResearchStudy.extension:RDDQuestionnaire
        Slice NameRDDQuestionnaire
        Definition

        An Extension

        ShortExtension
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(QuestionnaireExtension - IEHR) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. ResearchStudy.extension:EnrollmentPeriod
        Slice NameEnrollmentPeriod
        Definition

        The period during which participants could enroll in the ResearchStudy

        ShortEnrollment Period
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(EnrollmentPeriodExtensionIEHR) (Extension Type: Period)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. ResearchStudy.extension:RequestedAnonymizationType
        Slice NameRequestedAnonymizationType
        Definition

        The type of anonymization used for the resource

        ShortAnonymization Type
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Anonymization Extension - IEHR) (Extension Type: Coding)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. ResearchStudy.identifier
        Definition

        Identifiers assigned to this research study by the sponsor or other systems.

        ShortBusiness Identifier for study
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. ResearchStudy.title
        Definition

        A short, descriptive user-friendly label for the study.

        ShortName for this study
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. ResearchStudy.protocol
        Definition

        The set of steps expected to be performed as part of the execution of the study.

        ShortSteps followed in executing study
        Control0..*
        TypeReference(PlanDefinition)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. ResearchStudy.partOf
        Definition

        A larger research study of which this particular study is a component or step.

        ShortPart of larger study
        Control0..*
        TypeReference(ResearchStudy)
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.

        Alternate Namescontainer
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. ResearchStudy.status
        Definition

        The current state of the study.

        Shortactive | 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
        Control1..1
        BindingThe codes SHALL be taken from ResearchStudyStatus
        (required to http://hl7.org/fhir/ValueSet/research-study-status|4.0.1)

        Codes that convey the current status of the research study.

        Typecode
        Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. ResearchStudy.primaryPurposeType
        Definition

        The type of study based upon the intent of the study's activities. A classification of the intent of the study.

        Shorttreatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from ResearchStudyPrimaryPurposeType
        (extensible to http://hl7.org/fhir/ValueSet/research-study-prim-purp-type)

        Codes for the main intent of the study.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. ResearchStudy.phase
        Definition

        The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

        Shortn-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
        Control0..1
        BindingFor example codes, see ResearchStudyPhase
        (example to http://hl7.org/fhir/ValueSet/research-study-phase)

        Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. ResearchStudy.category
        Definition

        Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

        ShortClassifications for the study
        Control0..*
        Binding

        Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. ResearchStudy.focus
        Definition

        The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

        ShortDrugs, devices, etc. under study
        Control0..*
        Binding

        Codes for medications, devices and other interventions.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. ResearchStudy.condition
        Definition

        The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

        ShortCondition being studied
        Control0..*
        BindingFor example codes, see Condition/Problem/DiagnosisCodes
        (example to http://hl7.org/fhir/ValueSet/condition-code)

        Identification of the condition or diagnosis.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. ResearchStudy.contact
        Definition

        Contact details to assist a user in learning more about or engaging with the study.

        ShortContact details for the study
        Control1..*
        TypeContactDetail
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. ResearchStudy.relatedArtifact
        Definition

        Citations, references and other related documents.

        ShortReferences and dependencies
        Control0..*
        TypeRelatedArtifact
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. ResearchStudy.keyword
        Definition

        Key terms to aid in searching for or filtering the study.

        ShortUsed to search for the study
        Control0..*
        Binding

        Words associated with the study that may be useful in discovery.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. ResearchStudy.location
        Definition

        Indicates a country, state or other region where the study is taking place.

        ShortGeographic region(s) for study
        Control1..*
        BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
        (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

        Countries and regions within which this artifact is targeted for use.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. ResearchStudy.description
        Definition

        A full description of how the study is being conducted.

        ShortWhat this is study doing
        Control0..1
        Typemarkdown
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. 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".

        ShortInclusion & exclusion criteria
        Comments

        The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.

        Control1..*
        TypeReference(Cohort)
        Is Modifierfalse
        Summarytrue
        Alternate Namespatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. ResearchStudy.period
        Definition

        Identifies the start date and the expected (or actual, depending on status) end date for the study.

        ShortWhen the study began and ended
        Control1..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Alternate Namestiming
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. ResearchStudy.sponsor
        Definition

        An organization that initiates the investigation and is legally responsible for the study.

        ShortOrganization that initiates and is legally responsible for the study
        Control0..1
        TypeReference(Organization)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. ResearchStudy.principalInvestigator
        Definition

        A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.

        ShortResearcher who oversees multiple aspects of the study
        Control0..1
        TypeReference(Practitioner, PractitionerRole)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. ResearchStudy.site
        Definition

        A facility in which study activities are conducted.

        ShortFacility where study activities are conducted
        Control1..*
        TypeReference(ResearchLocation)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. ResearchStudy.reasonStopped
        Definition

        A description and/or code explaining the premature termination of the study.

        Shortaccrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
        Control0..1
        BindingFor example codes, see ResearchStudyReasonStopped
        (example to http://hl7.org/fhir/ValueSet/research-study-reason-stopped)

        Codes for why the study ended prematurely.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. ResearchStudy.note
        Definition

        Comments made about the study by the performer, subject or other participants.

        ShortComments made about the study
        Control0..*
        TypeAnnotation
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. 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.

        ShortDefined path through the study for a subject
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        74. ResearchStudy.arm.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        76. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        78. ResearchStudy.arm.name
        Definition

        Unique, human-readable label for this arm of the study.

        ShortLabel for study arm
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        80. ResearchStudy.arm.type
        Definition

        Categorization of study arm, e.g. experimental, active comparator, placebo comparater.

        ShortCategorization of study arm
        Control0..1
        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. ResearchStudy.arm.description
        Definition

        A succinct description of the path through the study that would be followed by a subject adhering to this arm.

        ShortShort explanation of study path
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. ResearchStudy.objective
        Definition

        A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

        ShortA goal for the study
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. ResearchStudy.objective.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        88. ResearchStudy.objective.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        90. ResearchStudy.objective.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        92. ResearchStudy.objective.name
        Definition

        Unique, human-readable label for this objective of the study.

        ShortLabel for the objective
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. ResearchStudy.objective.type
        Definition

        The kind of study objective.

        Shortprimary | secondary | exploratory
        Control0..1
        BindingThe codes SHOULD be taken from ResearchStudyObjectiveType
        (preferred to http://hl7.org/fhir/ValueSet/research-study-objective-type)

        Codes for the kind of study objective.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))