Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_ResearchStudy_R3 - Detailed Descriptions

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.

ShortInvestigation to increase healthcare-related patient-independent knowledge
Comments

Need to make sure we encompass public health studies.

Control0..*
Alternate NamesClinical Trial, Study
Invariantsdom-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.

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.

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.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. ResearchStudy.extension:primaryPurposeType
    Slice NameprimaryPurposeType
    Definition

    R4: ResearchStudy.primaryPurposeType (new:CodeableConcept)

    ShortR4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)
    Comments

    Element ResearchStudy.primaryPurposeType has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.primaryPurposeType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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 Namephase
    Definition

    R4: ResearchStudy.phase (new:CodeableConcept)

    ShortR4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)
    Comments

    Element ResearchStudy.phase has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.phase has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(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 Modifierfalse
    Invariantsele-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 Namecondition
    Definition

    R4: ResearchStudy.condition (new:CodeableConcept)

    ShortR4: Condition being studied (new)
    Comments

    Element ResearchStudy.condition has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.condition has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: Condition being studied (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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 Nameobjective
    Definition

    R4: ResearchStudy.objective (new:BackboneElement)

    ShortR4: A goal for the study (new)
    Comments

    Element ResearchStudy.objective has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.objective has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: A goal for the study (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-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.

    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    16. ResearchStudy.status
    Definition

    The current state of the study.

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

    Control1..1
    BindingThe 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

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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.

    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
    Alternate Namesextensions, user content
    SlicingThis element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. ResearchStudy.status.extension:status
      Slice Namestatus
      Definition

      R4: ResearchStudy.status

      ShortR4: 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 ResearchStudy.status is mapped to FHIR STU3 element ResearchStudy.status as SourceIsBroaderThanTarget. The target context ResearchStudy.status is a modifier element, so this extension does not need to be defined as a modifier.

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(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 Modifierfalse
      Invariantsele-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
      Control0..*
      SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 4. ResearchStudy.extension:primaryPurposeType
        Slice NameprimaryPurposeType
        Definition

        R4: ResearchStudy.primaryPurposeType (new:CodeableConcept)

        ShortR4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)
        Comments

        Element ResearchStudy.primaryPurposeType has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.primaryPurposeType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept)
        6. ResearchStudy.extension:phase
        Slice Namephase
        Definition

        R4: ResearchStudy.phase (new:CodeableConcept)

        ShortR4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)
        Comments

        Element ResearchStudy.phase has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.phase has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(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 Namecondition
        Definition

        R4: ResearchStudy.condition (new:CodeableConcept)

        ShortR4: Condition being studied (new)
        Comments

        Element ResearchStudy.condition has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.condition has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        TypeExtension(R4: Condition being studied (new)) (Extension Type: CodeableConcept)
        10. ResearchStudy.extension:objective
        Slice Nameobjective
        Definition

        R4: ResearchStudy.objective (new:BackboneElement)

        ShortR4: A goal for the study (new)
        Comments

        Element ResearchStudy.objective has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.objective has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..*
        TypeExtension(R4: A goal for the study (new)) (Complex Extension)
        12. ResearchStudy.status
        14. ResearchStudy.status.extension
        Control0..*
        SlicingThis element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. ResearchStudy.status.extension:status
          Slice Namestatus
          Definition

          R4: ResearchStudy.status

          ShortR4: 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 ResearchStudy.status is mapped to FHIR STU3 element ResearchStudy.status as SourceIsBroaderThanTarget. The target context ResearchStudy.status is a modifier element, so this extension does not need to be defined as a modifier.

          Control0..1
          TypeExtension(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
          Control0..*
          SlicingThis element introduces a set of slices on ResearchStudy.principalInvestigator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. ResearchStudy.principalInvestigator.extension:principalInvestigator
            Slice NameprincipalInvestigator
            Definition

            R4: ResearchStudy.principalInvestigator additional types from child elements (display, identifier, reference, type)

            ShortR4: Researcher who oversees multiple aspects of the study additional types
            Comments

            Element ResearchStudy.principalInvestigator is mapped to FHIR STU3 element ResearchStudy.principalInvestigator as SourceIsBroaderThanTarget. The mappings for ResearchStudy.principalInvestigator do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element ResearchStudy.principalInvestigator with unmapped reference targets: PractitionerRole.

            Control0..1
            TypeExtension(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.

            ShortInvestigation to increase healthcare-related patient-independent knowledge
            Comments

            Need to make sure we encompass public health studies.

            Control0..*
            Alternate NamesClinical Trial, Study
            Invariantsdom-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.

            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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            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.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Summarytrue
            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.

            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.

            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.

            Control0..1
            Typeuri
            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            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).

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from Common Languages
            (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

            A human language.

            Additional BindingsPurpose
            All LanguagesMax Binding
            Typecode
            Primitive ValueThis 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.

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

            Control0..1
            This element is affected by the following invariants: dom-1
            TypeNarrative
            Alternate Namesnarrative, 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.

            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.

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

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 16. ResearchStudy.extension:primaryPurposeType
              Slice NameprimaryPurposeType
              Definition

              R4: ResearchStudy.primaryPurposeType (new:CodeableConcept)

              ShortR4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)
              Comments

              Element ResearchStudy.primaryPurposeType has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.primaryPurposeType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(R4: treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility (new)) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Invariantsele-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 Namephase
              Definition

              R4: ResearchStudy.phase (new:CodeableConcept)

              ShortR4: n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 (new)
              Comments

              Element ResearchStudy.phase has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.phase has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(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 Modifierfalse
              Invariantsele-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 Namecondition
              Definition

              R4: ResearchStudy.condition (new:CodeableConcept)

              ShortR4: Condition being studied (new)
              Comments

              Element ResearchStudy.condition has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.condition has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(R4: Condition being studied (new)) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Invariantsele-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 Nameobjective
              Definition

              R4: ResearchStudy.objective (new:BackboneElement)

              ShortR4: A goal for the study (new)
              Comments

              Element ResearchStudy.objective has a context of ResearchStudy based on following the parent source element upwards and mapping to ResearchStudy. Element ResearchStudy.objective has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(R4: A goal for the study (new)) (Complex Extension)
              Is Modifierfalse
              Invariantsele-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.

              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 No Modifier Reason provideed in previous versions of FHIR
              Alternate Namesextensions, user content
              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)
              Control0..*
              TypeIdentifier
              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.

              28. ResearchStudy.title
              Definition

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

              ShortName for this study
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              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)
              Summarytrue
              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)
              Summarytrue
              Requirements

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

              Alternate Namescontainer
              34. ResearchStudy.status
              Definition

              The current state of the study.

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

              Control1..1
              BindingThe 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

              Typecode
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              36. ResearchStudy.status.id
              Definition

              unique id for the element within a resource (for internal references)

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              38. ResearchStudy.status.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              SlicingThis element introduces a set of slices on ResearchStudy.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. ResearchStudy.status.extension:status
                Slice Namestatus
                Definition

                R4: ResearchStudy.status

                ShortR4: 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 ResearchStudy.status is mapped to FHIR STU3 element ResearchStudy.status as SourceIsBroaderThanTarget. The target context ResearchStudy.status is a modifier element, so this extension does not need to be defined as a modifier.

                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(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 Modifierfalse
                Invariantsele-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

                ShortPrimitive value for code
                Control0..1
                Typecode
                XML FormatIn 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.

                ShortClassifications for the study
                Control0..*
                Binding

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

                TypeCodeableConcept
                Summarytrue
                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.

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

                Codes for medications, devices, conditions and other interventions

                TypeCodeableConcept
                Summarytrue
                48. ResearchStudy.contact
                Definition

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

                ShortContact details for the study
                Control0..*
                TypeContactDetail
                Summarytrue
                50. ResearchStudy.relatedArtifact
                Definition

                Citations, references and other related documents.

                ShortReferences and dependencies
                Control0..*
                TypeRelatedArtifact
                52. 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
                Summarytrue
                54. ResearchStudy.jurisdiction
                Definition

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

                ShortGeographic region(s) for study
                Control0..*
                BindingUnless 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

                TypeCodeableConcept
                Summarytrue
                56. ResearchStudy.description
                Definition

                A full description of how the study is being conducted.

                ShortWhat this is study doing
                Control0..1
                Typemarkdown
                Primitive ValueThis 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".

                ShortInclusion & exclusion criteria
                Comments

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

                Control0..*
                TypeReference(Group)
                Summarytrue
                Alternate Namespatient
                60. 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
                Control0..1
                TypePeriod
                Summarytrue
                Requirements

                [The list of types may be constrained as appropriate for the type of event].

                Alternate Namestiming
                62. ResearchStudy.sponsor
                Definition

                The organization responsible for the execution of the study.

                ShortOrganization responsible for the study
                Control0..1
                TypeReference(Organization)
                Summarytrue
                64. ResearchStudy.principalInvestigator
                Definition

                Indicates the individual who has primary oversite of the execution of the study.

                ShortThe individual responsible for the study
                Control0..1
                TypeReference(Practitioner)
                Summarytrue
                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.

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                68. ResearchStudy.principalInvestigator.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                SlicingThis element introduces a set of slices on ResearchStudy.principalInvestigator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 70. ResearchStudy.principalInvestigator.extension:principalInvestigator
                  Slice NameprincipalInvestigator
                  Definition

                  R4: ResearchStudy.principalInvestigator additional types from child elements (display, identifier, reference, type)

                  ShortR4: Researcher who oversees multiple aspects of the study additional types
                  Comments

                  Element ResearchStudy.principalInvestigator is mapped to FHIR STU3 element ResearchStudy.principalInvestigator as SourceIsBroaderThanTarget. The mappings for ResearchStudy.principalInvestigator do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element ResearchStudy.principalInvestigator with unmapped reference targets: PractitionerRole.

                  Control0..1
                  TypeExtension(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.

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

                  Control0..1
                  This element is affected by the following invariants: ref-1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  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.

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

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Summarytrue
                  76. ResearchStudy.principalInvestigator.display
                  Definition

                  Plain text narrative that identifies the resource in addition to the resource reference.

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

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  78. ResearchStudy.site
                  Definition

                  Clinic, hospital or other healthcare location that is participating in the study.

                  ShortLocation involved in study execution
                  Control0..*
                  TypeReference(Location)
                  Summarytrue
                  80. ResearchStudy.reasonStopped
                  Definition

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

                  ShortReason for terminating study early
                  Control0..1
                  TypeCodeableConcept
                  Summarytrue
                  82. ResearchStudy.note
                  Definition

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

                  ShortComments made about the event
                  Control0..*
                  TypeAnnotation
                  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.

                  ShortDefined path through the study for a subject
                  Control0..*
                  TypeBackboneElement
                  Invariantsele-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.

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn 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.

                  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
                  Alternate Namesextensions, 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.

                  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 No Modifier Reason provideed in previous versions of FHIR
                  Summarytrue
                  Alternate Namesextensions, user content, modifiers
                  92. ResearchStudy.arm.name
                  Definition

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

                  ShortLabel for study arm
                  Control1..1
                  Typestring
                  Primitive ValueThis 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.

                  ShortCategorization of study arm
                  Control0..1
                  TypeCodeableConcept
                  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.

                  ShortShort explanation of study path
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension