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_ResearchSubject_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ResearchSubject resource profile.

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

0. ResearchSubject
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 NamesStudy Subject
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. ResearchSubject.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. ResearchSubject.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
6. ResearchSubject.status
Definition

The current state of the subject.

Shortcandidate | enrolled | active | suspended | withdrawn | completed
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 ResearchSubjectStatus .http://hl7.org/fhir/ValueSet/research-subject-status|3.0.2
(required to http://hl7.org/fhir/ValueSet/research-subject-status|3.0.2)

Indicates the progression of a study subject through a 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
8. ResearchSubject.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 ResearchSubject.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. ResearchSubject.status.extension:status
    Slice Namestatus
    Definition

    R4: ResearchSubject.status additional codes

    ShortR4: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes
    Comments

    Element ResearchSubject.status is mapped to FHIR STU3 element ResearchSubject.status as RelatedTo. The mappings for ResearchSubject.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context ResearchSubject.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: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes) (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())
    12. ResearchSubject.study
    Definition

    Reference to the study the subject is participating in.

    ShortStudy subject is part of
    Control1..1
    TypeReference(ResearchStudy)
    Summarytrue
    14. ResearchSubject.individual
    Definition

    The record of the person or animal who is involved in the study.

    ShortWho is part of study
    Control1..1
    TypeReference(Patient)
    Summarytrue

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

    0. ResearchSubject
    2. ResearchSubject.status
    4. ResearchSubject.status.extension
    Control0..*
    SlicingThis element introduces a set of slices on ResearchSubject.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. ResearchSubject.status.extension:status
      Slice Namestatus
      Definition

      R4: ResearchSubject.status additional codes

      ShortR4: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes
      Comments

      Element ResearchSubject.status is mapped to FHIR STU3 element ResearchSubject.status as RelatedTo. The mappings for ResearchSubject.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context ResearchSubject.status is a modifier element, so this extension does not need to be defined as a modifier.

      Control0..1
      TypeExtension(R4: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes) (Extension Type: code)

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

      0. ResearchSubject
      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 NamesStudy Subject
      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. ResearchSubject.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. ResearchSubject.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. ResearchSubject.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. ResearchSubject.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. ResearchSubject.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. ResearchSubject.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. ResearchSubject.extension
      Definition

      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.

      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
      16. ResearchSubject.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
      18. ResearchSubject.identifier
      Definition

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

      ShortBusiness Identifier for research subject
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      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.

      20. ResearchSubject.status
      Definition

      The current state of the subject.

      Shortcandidate | enrolled | active | suspended | withdrawn | completed
      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 ResearchSubjectStatus .
      (required to http://hl7.org/fhir/ValueSet/research-subject-status|3.0.2)

      Indicates the progression of a study subject through a 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
      22. ResearchSubject.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.
      24. ResearchSubject.status.extension
      Definition

      An Extension

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

        R4: ResearchSubject.status additional codes

        ShortR4: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes
        Comments

        Element ResearchSubject.status is mapped to FHIR STU3 element ResearchSubject.status as RelatedTo. The mappings for ResearchSubject.status do not allow expression of the necessary codes, per the bindings on the source and target. The target context ResearchSubject.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: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn additional codes) (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())
        28. ResearchSubject.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.
        30. ResearchSubject.period
        Definition

        The dates the subject began and ended their participation in the study.

        ShortStart and end of participation
        Control0..1
        TypePeriod
        Summarytrue
        Alternate Namestiming
        32. ResearchSubject.study
        Definition

        Reference to the study the subject is participating in.

        ShortStudy subject is part of
        Control1..1
        TypeReference(ResearchStudy)
        Summarytrue
        34. ResearchSubject.individual
        Definition

        The record of the person or animal who is involved in the study.

        ShortWho is part of study
        Control1..1
        TypeReference(Patient)
        Summarytrue
        36. ResearchSubject.assignedArm
        Definition

        The name of the arm in the study the subject is expected to follow as part of this study.

        ShortWhat path should be followed
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        38. ResearchSubject.actualArm
        Definition

        The name of the arm in the study the subject actually followed as part of this study.

        ShortWhat path was followed
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        40. ResearchSubject.consent
        Definition

        A record of the patient's informed agreement to participate in the study.

        ShortAgreement to participate in study
        Control0..1
        TypeReference(Consent)