NCPI FHIR Implementation Guide v2
0.1.0 - ci-build
NCPI FHIR Implementation Guide v2 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2024-11-25 |
Definitions for the SharedDataModelResearchStudy logical model.
Guidance on how to interpret the contents of this table can be found here
0. SharedDataModelResearchStudy | |
Definition | The Shared Data Model for Research Study represents the understanding of what a Research Study is from the context of users and authors of the NCPI FHIR IG. |
Short | Shared Data Model for Research Study |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. SharedDataModelResearchStudy.persistentIdentifier | |
Definition | External facing, globally unique identifier. |
Short | External facing, globally unique identifier. |
Control | 0..* |
Type | Identifier |
4. SharedDataModelResearchStudy.parentStudy | |
Definition | Parent study, required only for substudies. |
Short | Parent study, required only for substudies. |
Control | 0..1 |
Type | https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelResearchStudy |
6. SharedDataModelResearchStudy.name | |
Definition | 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”. |
Short | 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”. |
Control | 1..* |
Type | BackboneElement |
8. SharedDataModelResearchStudy.name.text | |
Definition | The study's name |
Short | The study's name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. SharedDataModelResearchStudy.name.type | |
Definition | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Short | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Name Type (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. SharedDataModelResearchStudy.description | |
Definition | short summary of relevant and important information about the study. |
Short | short summary of relevant and important information about the study. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. SharedDataModelResearchStudy.website | |
Definition | A URL for a website that provides information about the research effort as a whole. |
Short | A URL for a website that provides information about the research effort as a whole. |
Control | 0..* |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. SharedDataModelResearchStudy.totalParticipants | |
Definition | Number of total participants represented by the data in this study. |
Short | Number of total participants represented by the data in this study. |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. SharedDataModelResearchStudy.studyFocus | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
20. SharedDataModelResearchStudy.studyFocus.term | |
Definition | The term used to describe the focus of the study. A valid MeSH is preferred. |
Short | The term used to describe the focus of the study. A valid MeSH is preferred. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. SharedDataModelResearchStudy.studyFocus.termSource | |
Definition | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Short | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. SharedDataModelResearchStudy.enrollmentCriteria | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | markdown |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. SharedDataModelResearchStudy.population | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
28. SharedDataModelResearchStudy.population.type | |
Definition | A term that specifies the population being described. |
Short | A term that specifies the population being described. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. SharedDataModelResearchStudy.population.description | |
Definition | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Short | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. SharedDataModelResearchStudy.citation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. SharedDataModelResearchStudy.publications | |
Definition | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Short | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. SharedDataModelResearchStudy.additionalDocumentation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. SharedDataModelResearchStudy.consortium | |
Definition | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Short | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. SharedDataModelResearchStudy.acknowledgements | |
Definition | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Short | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. SharedDataModelResearchStudy.personnel | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
44. SharedDataModelResearchStudy.personnel.name | |
Definition | The name of the person being described. |
Short | The name of the person being described. |
Control | 1..1 |
Type | HumanName |
46. SharedDataModelResearchStudy.personnel.role | |
Definition | The role of the person being described. |
Short | The role of the person being described. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Personnel Role (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. SharedDataModelResearchStudy.personnel.organization | |
Definition | The organizational affiliation of the person being described. |
Short | The organizational affiliation of the person being described. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. SharedDataModelResearchStudy | |
Definition | The Shared Data Model for Research Study represents the understanding of what a Research Study is from the context of users and authors of the NCPI FHIR IG. |
Short | Shared Data Model for Research Study |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. SharedDataModelResearchStudy.persistentIdentifier | |
Definition | External facing, globally unique identifier. |
Short | External facing, globally unique identifier. |
Control | 0..* |
Type | Identifier |
4. SharedDataModelResearchStudy.parentStudy | |
Definition | Parent study, required only for substudies. |
Short | Parent study, required only for substudies. |
Control | 0..1 |
Type | https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelResearchStudy |
6. SharedDataModelResearchStudy.name | |
Definition | 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”. |
Short | 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”. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
8. SharedDataModelResearchStudy.name.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. SharedDataModelResearchStudy.name.text | |
Definition | The study's name |
Short | The study's name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. SharedDataModelResearchStudy.name.type | |
Definition | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Short | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Name Type (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. SharedDataModelResearchStudy.description | |
Definition | short summary of relevant and important information about the study. |
Short | short summary of relevant and important information about the study. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. SharedDataModelResearchStudy.website | |
Definition | A URL for a website that provides information about the research effort as a whole. |
Short | A URL for a website that provides information about the research effort as a whole. |
Control | 0..* |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. SharedDataModelResearchStudy.totalParticipants | |
Definition | Number of total participants represented by the data in this study. |
Short | Number of total participants represented by the data in this study. |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. SharedDataModelResearchStudy.studyFocus | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
22. SharedDataModelResearchStudy.studyFocus.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. SharedDataModelResearchStudy.studyFocus.term | |
Definition | The term used to describe the focus of the study. A valid MeSH is preferred. |
Short | The term used to describe the focus of the study. A valid MeSH is preferred. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. SharedDataModelResearchStudy.studyFocus.termSource | |
Definition | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Short | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. SharedDataModelResearchStudy.enrollmentCriteria | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | markdown |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. SharedDataModelResearchStudy.population | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
32. SharedDataModelResearchStudy.population.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. SharedDataModelResearchStudy.population.type | |
Definition | A term that specifies the population being described. |
Short | A term that specifies the population being described. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. SharedDataModelResearchStudy.population.description | |
Definition | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Short | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. SharedDataModelResearchStudy.citation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. SharedDataModelResearchStudy.publications | |
Definition | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Short | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. SharedDataModelResearchStudy.additionalDocumentation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. SharedDataModelResearchStudy.consortium | |
Definition | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Short | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. SharedDataModelResearchStudy.acknowledgements | |
Definition | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Short | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. SharedDataModelResearchStudy.personnel | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
50. SharedDataModelResearchStudy.personnel.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
52. SharedDataModelResearchStudy.personnel.name | |
Definition | The name of the person being described. |
Short | The name of the person being described. |
Control | 1..1 |
Type | HumanName |
54. SharedDataModelResearchStudy.personnel.role | |
Definition | The role of the person being described. |
Short | The role of the person being described. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Personnel Role (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. SharedDataModelResearchStudy.personnel.organization | |
Definition | The organizational affiliation of the person being described. |
Short | The organizational affiliation of the person being described. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. SharedDataModelResearchStudy | |
Definition | The Shared Data Model for Research Study represents the understanding of what a Research Study is from the context of users and authors of the NCPI FHIR IG. |
Short | Shared Data Model for Research Study |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. SharedDataModelResearchStudy.persistentIdentifier | |
Definition | External facing, globally unique identifier. |
Short | External facing, globally unique identifier. |
Control | 0..* |
Type | Identifier |
4. SharedDataModelResearchStudy.parentStudy | |
Definition | Parent study, required only for substudies. |
Short | Parent study, required only for substudies. |
Control | 0..1 |
Type | https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelResearchStudy |
6. SharedDataModelResearchStudy.name | |
Definition | 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”. |
Short | 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”. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
8. SharedDataModelResearchStudy.name.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
10. SharedDataModelResearchStudy.name.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on SharedDataModelResearchStudy.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. SharedDataModelResearchStudy.name.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
14. SharedDataModelResearchStudy.name.text | |
Definition | The study's name |
Short | The study's name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. SharedDataModelResearchStudy.name.type | |
Definition | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Short | Type of name or title this name relates to (formal-title, internale-name, familiar-name, etc) |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Name Type (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-name-type-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. SharedDataModelResearchStudy.description | |
Definition | short summary of relevant and important information about the study. |
Short | short summary of relevant and important information about the study. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. SharedDataModelResearchStudy.website | |
Definition | A URL for a website that provides information about the research effort as a whole. |
Short | A URL for a website that provides information about the research effort as a whole. |
Control | 0..* |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. SharedDataModelResearchStudy.totalParticipants | |
Definition | Number of total participants represented by the data in this study. |
Short | Number of total participants represented by the data in this study. |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. SharedDataModelResearchStudy.studyFocus | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
26. SharedDataModelResearchStudy.studyFocus.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. SharedDataModelResearchStudy.studyFocus.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on SharedDataModelResearchStudy.studyFocus.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. SharedDataModelResearchStudy.studyFocus.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
32. SharedDataModelResearchStudy.studyFocus.term | |
Definition | The term used to describe the focus of the study. A valid MeSH is preferred. |
Short | The term used to describe the focus of the study. A valid MeSH is preferred. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. SharedDataModelResearchStudy.studyFocus.termSource | |
Definition | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Short | The source ontology or vocabulary for subjectFocus.Term (optional if term uses curie). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. SharedDataModelResearchStudy.enrollmentCriteria | |
Definition | 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. |
Short | 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. |
Control | 0..1 |
Type | markdown |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. SharedDataModelResearchStudy.population | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
40. SharedDataModelResearchStudy.population.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
42. SharedDataModelResearchStudy.population.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on SharedDataModelResearchStudy.population.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. SharedDataModelResearchStudy.population.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
46. SharedDataModelResearchStudy.population.type | |
Definition | A term that specifies the population being described. |
Short | A term that specifies the population being described. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. SharedDataModelResearchStudy.population.description | |
Definition | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Short | A free text field that provides more information about the population specified in PopulationType within the context of this researchStudy. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. SharedDataModelResearchStudy.citation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. SharedDataModelResearchStudy.publications | |
Definition | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Short | Provide a list of publications that use this data. This may be updated to include new publications as they are created. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. SharedDataModelResearchStudy.additionalDocumentation | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. SharedDataModelResearchStudy.consortium | |
Definition | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Short | If the data in this study was gathered as part of a consortial effort, list the consortium here. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. SharedDataModelResearchStudy.acknowledgements | |
Definition | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Short | Acknowledgements describes any attribution or acknowledgements relevant to the study. This can include but is not limited to funding sources, organizational affiliations or sponsors. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. SharedDataModelResearchStudy.personnel | |
Definition | 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. |
Short | 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. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters ) |
62. SharedDataModelResearchStudy.personnel.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
64. SharedDataModelResearchStudy.personnel.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on SharedDataModelResearchStudy.personnel.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
66. SharedDataModelResearchStudy.personnel.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
68. SharedDataModelResearchStudy.personnel.name | |
Definition | The name of the person being described. |
Short | The name of the person being described. |
Control | 1..1 |
Type | HumanName |
70. SharedDataModelResearchStudy.personnel.role | |
Definition | The role of the person being described. |
Short | The role of the person being described. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from Study Personnel Role (extensible to https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/study-personnel-role-vs ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. SharedDataModelResearchStudy.personnel.organization | |
Definition | The organizational affiliation of the person being described. |
Short | The organizational affiliation of the person being described. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |