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

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

Resource Profile: Profile_R4_ResearchDefinition_R4B - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ResearchDefinition resource profile.

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

0. ResearchDefinition
Definition

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

ShortA research context or question
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
rsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
rsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. ResearchDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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())
6. ResearchDefinition.status
Definition

The status of this research definition. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of research definitions that are appropriate for use versus not.

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0
(required to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ResearchDefinition.population
Definition

A reference to a ResearchElementDefinition resource that defines the population for the research.

ShortWhat population?
Control1..1
TypeReference(ResearchElementDefinition)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. ResearchDefinition

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

0. ResearchDefinition
Definition

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

ShortA research context or question
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
rsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. ResearchDefinition.id
Definition

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

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. ResearchDefinition.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ResearchDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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

IETF language tag

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

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ResearchDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
14. ResearchDefinition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. ResearchDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

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

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

An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.

ShortCanonical identifier for this research definition, represented as a URI (globally unique)
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Allows the research definition to be referenced by a single globally unique identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ResearchDefinition.identifier
Definition

A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the research definition
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research definition outside of FHIR, where it is not possible to use the logical URI.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

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

The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

ShortBusiness version of the research definition
Comments

There may be different research definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research definition with the format [url]|[version].

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ResearchDefinition.name
Definition

A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

ShortName for this research definition (computer friendly)
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Support human navigation and code generation.

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

A short, descriptive, user-friendly title for the research definition.

ShortName for this research definition (human friendly)
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ResearchDefinition.shortTitle
Definition

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

ShortTitle for use in informal contexts
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ResearchDefinition.subtitle
Definition

An explanatory or alternate title for the ResearchDefinition giving additional information about its content.

ShortSubordinate title of the ResearchDefinition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ResearchDefinition.status
Definition

The status of this research definition. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

Allows filtering of research definitions that are appropriate for use versus not.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus
(required to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ResearchDefinition.experimental
Definition

A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ShortFor testing purposes, not real usage
Comments

Allows filtering of research definitions that are appropriate for use versus not.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level research definition.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ResearchDefinition.subject[x]
Definition

The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of the ResearchDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.3.0)

The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supportfalse
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ResearchDefinition.date
Definition

The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.

ShortDate last changed
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ResearchDefinition.publisher
Definition

The name of the organization or individual that published the research definition.

ShortName of the publisher (organization or individual)
Comments

Usually an organization but may be an individual. The publisher (or steward) of the research definition is the organization or individual primarily responsible for the maintenance and upkeep of the research definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research definition. This item SHOULD be populated unless the information is available from context.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Helps establish the "authority/credibility" of the research definition. May also allow for contact.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ResearchDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a telephone number, etc.

Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ResearchDefinition.description
Definition

A free text natural language description of the research definition from a consumer's perspective.

ShortNatural language description of the research definition
Comments

This description can be used to capture details such as why the research definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research definition is presumed to be the predominant language in the place the research definition was created).

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ResearchDefinition.comment
Definition

A human-readable string to clarify or explain concepts about the resource.

ShortUsed for footnotes or explanatory notes
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ResearchDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.

ShortThe context that the content is intended to support
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ResearchDefinition.jurisdiction
Definition

A legal or geographic region in which the research definition is intended to be used.

ShortIntended jurisdiction for research definition (if applicable)
Comments

It may be possible for the research definition to be used in jurisdictions other than those for which it was originally designed or intended.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.3.0)

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

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

Explanation of why this research definition is needed and why it has been designed as it has.

ShortWhy this research definition is defined
Comments

This element does not describe the usage of the research definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research definition.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ResearchDefinition.usage
Definition

A detailed description, from a clinical perspective, of how the ResearchDefinition is used.

ShortDescribes the clinical usage of the ResearchDefinition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. ResearchDefinition.copyright
Definition

A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.

ShortUse and/or publishing restrictions
Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Consumers must be able to determine any legal restrictions on the use of the research definition and/or its content.

Alternate NamesLicense, Restrictions
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. ResearchDefinition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen the research definition was approved by publisher
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. ResearchDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

ShortWhen the research definition was last reviewed
Comments

If specified, this date follows the original approval date.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. ResearchDefinition.effectivePeriod
Definition

The period during which the research definition content was or is planned to be in active use.

ShortWhen the research definition is expected to be used
Comments

The effective period for a research definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Control0..1
TypePeriod
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research definition are or are expected to be used instead.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. ResearchDefinition.topic
Definition

Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.

ShortThe category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
Control0..*
BindingFor example codes, see DefinitionTopic
(example to http://hl7.org/fhir/ValueSet/definition-topic|4.3.0)

High-level categorization of the definition, used for searching, sorting, and filtering.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Repositories must be able to determine how to categorize the ResearchDefinition so that it can be found by topical searches.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. ResearchDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

ShortWho authored the content
Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. ResearchDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

ShortWho edited the content
Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. ResearchDefinition.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

ShortWho reviewed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. ResearchDefinition.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

ShortWho endorsed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. ResearchDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

ShortAdditional documentation, citations, etc.
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Control0..*
TypeRelatedArtifact
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

ResearchDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. ResearchDefinition.library
Definition

A reference to a Library resource containing the formal logic used by the ResearchDefinition.

ShortLogic used by the ResearchDefinition
Control0..*
Typecanonical(Library)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. ResearchDefinition.population
Definition

A reference to a ResearchElementDefinition resource that defines the population for the research.

ShortWhat population?
Control1..1
TypeReference(ResearchElementDefinition)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. ResearchDefinition.exposure
Definition

A reference to a ResearchElementDefinition resource that defines the exposure for the research.

ShortWhat exposure?
Control0..1
TypeReference(ResearchElementDefinition)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. ResearchDefinition.exposureAlternative
Definition

A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.

ShortWhat alternative exposure state?
Control0..1
TypeReference(ResearchElementDefinition)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. ResearchDefinition.outcome
Definition

A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

ShortWhat outcome?
Control0..1
TypeReference(ResearchElementDefinition)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))