ResearchStudy Definition

Basic Definition

The ResearchStudy FHIR resource represents an individual research effort and acts as a grouper or “container” for that effort’s study participants and their related data files. It provides information about the research effort including the purpose, goal, and contact information. In addition to being informational, a ResearchStudy resource describes who has responsibility for and authority to share the associated data files.

Limits

Participant Identifier Context

A top level (parent) ResearchStudy should encompass a single participant identifier context. A participant identifier context can be understood as a unique research-based ID for an individual, and is directly related to governance and administration of the participant and their data.

A participant identifier context functions within the research space similarly to how an MRN functions within the healthcare space. One individual may have different MRNs at different institutions. Each of these MRNs is an example of a patient identifier context. This context also conveys aspects of governance and authority, because the systems that use the same MRN will generally fall under the same authority when it comes to protecting or sharing data. A participant identifier context works the same way- it defines a space in which a particular identifier is used for a participant, and is contiguous with the authority to share or responsibility to protect research data gathered about that participant.

Because each parent (top-level) ResearchStudy should represent a single participant identifier context, participants may only belong to one parent ResearchStudy (though they may be grouped into multiple subStudies below the main ResearchStudy).

Funding, Protocol, Organization

Usually, a ResearchStudy will align with a set of funds, with an organization, or with a particular protocol. However there may be cases where there is more than one applicable protocol, source of funding, or organization involved in a given instance of ResearchStudy. Always default to the idea of participant identifier context when determining whether an effort that spans multiple protocols, funding sources, or organizations should be considered a single ResearchStudy.

Data Files

Participant Specific Data files should always be associated with participants within a particular Participant Identifier Context. As a result, data files can only ever belong to a single parent ResearchStudy. If files from one context are reused in a new, separate analysis, the new ResearchStudy should point back to the original source files in their original ResearchStudy context.

Structure

Parent Study, Child Study

It is common for research efforts to have varied structures. Some may have multiple studies or study arms that together constitute a single effort. When determining how to represent a research effort within the model of ResearchStudy, consider the participant identifier context. If the studies in question all use the same study ID for the participant, and are governed under related protocols or investigator authority, these should be represented by the same parent ResearchStudy. If those studies do not use the same study ID for the participant, and are governed under unrelated protocols or investigator authority, these should be represented by different ResearchStudies.

Studies which all use the same participant identifier context may be represented as individual child studies (also called sub-studies) which all share a common parent ResearchStudy. This allows researchers to represent the important unique characteristics of the individual study, while maintaining the appropriate governance structure for data sharing.

Consent Groups, Access Groups, Data Use Groups

Data within a study might be subject to different access or data use limitations depending on local or national governance, protocol documents, consent documents, or more. Items with similar consent, access, or data use controls should be grouped together.

Related Studies

Some research efforts may be related to each other in ways that are important to track, even if these studies cover different Participant Identifier Contexts. One example of this might be research efforts that are part of the same consortium. These efforts might share a common funder and organization, and may even share some aspects of methodology or design, but constitute separate ResearchStudy instances. The consortial relationship can be recorded in the Consortium attribute.

Note: studies could be related via funding, or by sharing of participants - do we need to include the possibility to document this type of relationship?

Research Study Attributes

PersistentIdentifier

Each instance of ResearchStudy should have one accession identifier, and can be supplied as a combination of namespace + identifier. This identifier should be globally unique and will be external facing (not an internal ID). An example of an appropriate AccessionNumber value would be a dbgap phs ID.

ParentStudy

ResearchStudy objects that represent substudies (or child studies) as described above should have a value populated for ParentStudy. SubStudies may have only one immediate ParentStudy.

Name

Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.

Name.Text

Name.Text is the string object that is used to document a name used for this research study

Name.Type

Name.Type defines the type of name provided in the Name.Text field for this Name object. Name.Type can include formal name, nickname, acronym, alternative name.

Description

Description should provide a short summary of relevant and important information about the study. For example, this could include the primary purpose of the study, study design and findings, technologies used, and/or content being shared via the study. If possible, the description should use original language. If the description uses copyrighted material, similar to dbGaP requirements please include the following within the description: “Reprinted from [Article Citation], with permission from [Publisher].

Website

A URL for a website that provides information about the research effort as a whole. This should not be a URL to specific study materials such as data dictionaries, github repos, or other technical documentation - that can be added under AdditionalDocumentation.

Total Participants

Number of total participants represented by the data in this study. (Optional)

StudyFocus - Option 2

SubjectFocus is a repeatable object that describes the primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred, but other terms may be used if there is no appropriate MeSH term. If a non-MeSH term is used, it is preferable that the term be selected from an ontology/controlled vocabulary rather than supplied as free text.

StudyFocus.Term

The term used to describe the focus of the study. A valid MeSH is preferred.

StudyFocus.TermSource

The source ontology or vocabulary for SubjectFocus.Term.

ErollmentCriteria

EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.

Population

Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.

PopulationType

A term that specifies the population being described

PopulationDescription

A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.

Citation

Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.

Publications

Provide a list of publications that use this data. This may be updated to include new publications as they are created.

AdditionalDocumentation

AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.

Consortium

If the data in this study was gathered as part of a consortial effort, list the consortium here.

Acknowledgements

Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.

Personnel

Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.

Personnel.Name

The name of the person being described.

Personnel.Role

The role of the person being described. This is a controlled list of terms.

Personnel.Organization

The organizational affiliation of the person being described.

Additional thoughts:

• Fields we might consider including - please add your thoughts or other fields that you think of
  • Consent codes
    • listed in notes section but not sure if we decided to include this
  • Short codes
    • What does this mean?
  • Sponsor orgs
    • this is covered under attribution but could be called out as its own item if we feel that’s useful or necessary
  • Related studies
    • Studies that are related to this one in ways other that parent/child or consortium
    • Not sure that we need this, but we could consider it (or add it later)
  • PI/Study Contact
    • Gather some information about who the primary contact should be for this study
  • Tax ID - from Mike Feolo in 26 Sep mtg
    • Taxonomy ID

For other documentation:

• Add best practices for how to create an ID if there is not an appropriate one already available
  • Look for paper about FAIR ID creation
• Add total participants elsewhere (perhaps calculated from portal ETL)

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
SharedDataModelResearchStudy		0..*	Base	Shared Data Model for Research Study Instances of this logical model are not marked to be the target of a Reference
persistentIdentifier		0..*	Identifier	External facing, globally unique identifier.
parentStudy		0..1	SharedDataModelResearchStudy	Parent study, required only for substudies.
name		1..*	BackboneElement	Name is a repeatable object that consists of sets of two fields. All ResearchStudy records must have at least one Name object with Name.Type=”formal title”.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..1	string	The study's name
type		0..1	code	Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) Binding: Study Name Type (extensible)
description		1..1	string	short summary of relevant and important information about the study.
website		0..*	url	A URL for a website that provides information about the research effort as a whole.
totalParticipants		0..1	integer	Number of total participants represented by the data in this study.
studyFocus		0..*	BackboneElement	The primary focus(es) of the study. This can include terms related to disease area, intervention, drug, device, or other focus. MeSH terms are preferred.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
term		1..1	string	The term used to describe the focus of the study. A valid MeSH is preferred.
termSource		0..1	string	The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie).
enrollmentCriteria		0..1	markdown	EnrollmentCriteria describes the inclusion and exclusion criteria used to enroll participants in this study. This can be provided as a free text description, but may also be structured using bullets, tables, or other organizational methods.
population		0..*	BackboneElement	Population is a repeatable object that consists of sets of two fields. Population provides an overall description of the general population enrolled in the study, including basic demographics at a minimum and other useful population descriptors as appropriate.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	A term that specifies the population being described.
description		0..1	string	A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy.
citation		0..*	string	Provide any relevant information regarding how to cite this study. This can be as specific as including a full citation or as simple as a DOI.
publications		0..*	string	Provide a list of publications that use this data. This may be updated to include new publications as they are created.
additionalDocumentation		0..*	string	AdditionalDocumentation should be used to provide URLs, citations, or other appropriate references to technical documentation that is important for understanding the data included in this study. This can include data dictionaries, methods descriptions, github repositories, case report forms (CRFs), or any other relevant documentation.
consortium		0..1	string	If the data in this study was gathered as part of a consortial effort, list the consortium here.
acknowledgements		0..*	string	Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors.
personnel		0..*	BackboneElement	Every study must have at least one Primary Contact defined. Additional personnel such as Primary Investigator(s), Administrator(s), Collaborator(s) or other roles may also be included. If there are no appropriate individuals who can serve as primary contact for a study, an organization may be provided.
@id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	HumanName	The name of the person being described.
role		1..1	code	The role of the person being described. Binding: Study Personnel Role (extensible)
organization		0..1	string	The organizational affiliation of the person being described.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SharedDataModelResearchStudy.name.type	extensible	StudyNameTypeVS (a valid code from Study Name Type) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs from this IG
SharedDataModelResearchStudy.personnel.role	extensible	StudyPersonnelRoleVS (a valid code from Study Personnel Role) https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (7 nested mandatory elements)