Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème
0.1.0 - trial-use

This page is part of the Implementation Guide FHIR pour le projet ECLAIRE, base de données qui recense les essais cliniques en France (v0.1.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ECLAIREResearchStudy - Detailed Descriptions

Draft as of 2023-07-28

Definitions for the eclaire-researchstudy resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. ResearchStudy
Definition

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

Control0..*
Alternate NamesClinical Trial, Study
Comments

Need to make sure we encompass public health studies.

2. ResearchStudy.id
Definition

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

Control0..1
Typeid
Summarytrue
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.

3. ResearchStudy.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.

Control0..1 This element is affected by the following invariants: ele-1
TypeMeta
Standards StatusNormative (from Trial Use)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. ResearchStudy.implicitRules
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. ResearchStudy.language
Definition

The base language in which the resource is written.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Standards StatusNormative (from Trial Use)
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. ResearchStudy.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.

Control0..1 This element is affected by the following invariants: ele-1
TypeNarrative
Standards StatusNormative (from Trial Use)
Alternate Namesnarrative, html, xhtml, display
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. ResearchStudy.contained
Definition

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

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained 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.

8. ResearchStudy.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. ResearchStudy.extension:eclaire-review-date
SliceNameeclaire-review-date
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de permettre l'ajout d'une date de révision fonctionnelle lorque que l'on souhaite indiquer la date de la dernière modification substancielle

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECLAIREReviewDate) (Extension Type: date)
Must Supporttrue
InvariantsDefined on this element
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. ResearchStudy.extension:eclaire-condition-details
SliceNameeclaire-condition-details
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de permettre l'ajout de précisions sur le sujet concerné par l'essai

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECLAIREConditionDetails) (Extension Type: string)
Must Supporttrue
InvariantsDefined on this element
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())
11. ResearchStudy.extension:eclaire-therapeutic-area
SliceNameeclaire-therapeutic-area
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de permettre l'ajout du domaine thérapeutique concerné par l'essai

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECLAIRETherapeuticArea) (Extension Type: string)
Must Supporttrue
InvariantsDefined on this element
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())
12. ResearchStudy.extension:eclaire-recruitment-period
SliceNameeclaire-recruitment-period
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de permettre l'ajout de la période prévisionnelle de recrutement l'essai

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECLAIRERecruitmentPeriod) (Extension Type: Period)
Must Supporttrue
InvariantsDefined on this element
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())
13. ResearchStudy.extension:eclaire-secondary-sponsor
SliceNameeclaire-secondary-sponsor
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de pouvoir renseigner le(s) promoteur(s) secondaire(s)

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ECLAIRESecondarySponsor) (Extension Type: Reference(Organization))
Must Supporttrue
InvariantsDefined on this element
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. ResearchStudy.extension:eclaire-label
SliceNameeclaire-label
Definition

Extension créée dans le cadre du projet API ECLAIRE afin de permettre l'ajout de plusieurs titres pour l'essai

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ECLAIRELabel) (Complex Extension)
Must Supporttrue
InvariantsDefined on this element
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())
15. ResearchStudy.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
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
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. ResearchStudy.identifier
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: ele-1
TypeIdentifier
Summarytrue
Requirements

Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ResearchStudy.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ use
17. ResearchStudy.identifier:idPrimary
SliceNameidPrimary
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1 This element is affected by the following invariants: ele-1
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. ResearchStudy.identifier:idPrimary.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. ResearchStudy.identifier:idPrimary.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. ResearchStudy.identifier:idPrimary.use
Definition

The purpose of this identifier.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valueofficial
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. ResearchStudy.identifier:idPrimary.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. ResearchStudy.identifier:idPrimary.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. ResearchStudy.identifier:idPrimary.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. ResearchStudy.identifier:idPrimary.period
Definition

Time period during which identifier is/was valid for use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
25. ResearchStudy.identifier:idPrimary.assigner
Definition

Organization that issued/manages the identifier.

Control0..1 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
26. ResearchStudy.identifier:idSecondary
SliceNameidSecondary
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: ele-1
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. ResearchStudy.identifier:idSecondary.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
28. ResearchStudy.identifier:idSecondary.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
29. ResearchStudy.identifier:idSecondary.use
Definition

The purpose of this identifier.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Pattern Valuesecondary
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. ResearchStudy.identifier:idSecondary.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. ResearchStudy.identifier:idSecondary.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1 This element is affected by the following invariants: ele-1
Typeuri
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. ResearchStudy.identifier:idSecondary.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. ResearchStudy.identifier:idSecondary.period
Definition

Time period during which identifier is/was valid for use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
34. ResearchStudy.identifier:idSecondary.assigner
Definition

Organization that issued/manages the identifier.

Control0..1 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
35. ResearchStudy.title
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Must Supporttrue
Summarytrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. ResearchStudy.protocol
Definition

The set of steps expected to be performed as part of the execution of the study.

Control0..* This element is affected by the following invariants: ele-1
TypeReference(PlanDefinition)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
37. ResearchStudy.partOf
Definition

A larger research study of which this particular study is a component or step.

Control0..* This element is affected by the following invariants: ele-1
TypeReference(ResearchStudy)
Standards StatusNormative (from Trial Use)
Summarytrue
Requirements

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

Alternate Namescontainer
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
38. ResearchStudy.status
Definition

The current state of the study.

Control1..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ResearchStudyStatus Codes that convey the current status of the research study
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ResearchStudy.primaryPurposeType
Definition

The type of study based upon the intent of the study's activities. A classification of the intent of the study.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ResearchStudyPrimaryPurposeType; other codes may be used where these codes are not suitable Codes for the main intent of the study
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. ResearchStudy.phase
Definition

The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Value Set type de phase Eclaire de l'essai; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. ResearchStudy.category
Definition

Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

Control0..* This element is affected by the following invariants: ele-1
Binding

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

TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. ResearchStudy.focus
Definition

The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

Control0..* This element is affected by the following invariants: ele-1
Binding

Codes for medications, devices and other interventions.

TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. ResearchStudy.condition
Definition

The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

Control0..* This element is affected by the following invariants: ele-1
BindingFor example codes, see Condition/Problem/DiagnosisCodes Identification of the condition or diagnosis
TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. ResearchStudy.contact
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeContactDetail
Must Supporttrue
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. ResearchStudy.contact.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
46. ResearchStudy.contact.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.contact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
47. ResearchStudy.contact.extension:eclaire-contact-type
SliceNameeclaire-contact-type
Definition

Extension créée dans le cadre du projet ECLAIRE qui indique le type de Contact : Public ou Scientific

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECLAIREContactType) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined on this element
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())
48. ResearchStudy.contact.name
Definition

The name of an individual to contact.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

If there is no named individual, the telecom information is for the organization as a whole.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. ResearchStudy.contact.telecom
Definition

The contact details for the individual (if a name was provided) or the organization.

Control0..* This element is affected by the following invariants: ele-1
TypeContactPoint
Standards StatusNormative (from Trial Use)
Summarytrue
InvariantsDefined on this element
cpt-2: A system is required if a value is provided. (: value.empty() or system.exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. ResearchStudy.relatedArtifact
Definition

Citations, references and other related documents.

Control0..* This element is affected by the following invariants: ele-1
TypeRelatedArtifact
Standards StatusTrial Use (from Trial Use)
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. ResearchStudy.keyword
Definition

Key terms to aid in searching for or filtering the study.

Control0..* This element is affected by the following invariants: ele-1
Binding

Words associated with the study that may be useful in discovery.

TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. ResearchStudy.location
Definition

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

Control0..* This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use
TypeCodeableConcept
Must Supporttrue
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. ResearchStudy.description
Definition

A full description of how the study is being conducted.

Control0..1 This element is affected by the following invariants: ele-1
Typemarkdown
Must Supporttrue
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. ResearchStudy.enrollment
Definition

Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".

Control0..* This element is affected by the following invariants: ele-1
TypeReference(Group)
Must Supporttrue
Summarytrue
Alternate Namespatient
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
55. ResearchStudy.period
Definition

Identifies the start date and the expected (or actual, depending on status) end date for the study.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Trial Use)
Summarytrue
Alternate Namestiming
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))
56. ResearchStudy.sponsor
Definition

An organization that initiates the investigation and is legally responsible for the study.

Control0..1 This element is affected by the following invariants: ele-1
TypeReference(Organization)
Must Supporttrue
Summarytrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
57. ResearchStudy.principalInvestigator
Definition

A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.

Control0..1 This element is affected by the following invariants: ele-1
TypeReference(Practitioner|PractitionerRole)
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
58. ResearchStudy.site
Definition

A facility in which study activities are conducted.

Control0..* This element is affected by the following invariants: ele-1
TypeReference(Location)
Must Supporttrue
Summarytrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
59. ResearchStudy.reasonStopped
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
BindingFor example codes, see ResearchStudyReasonStopped Codes for why the study ended prematurely
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Summarytrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. ResearchStudy.note
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeAnnotation
Standards StatusNormative (from Trial Use)
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. ResearchStudy.arm
Definition

Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

Control0..* This element is affected by the following invariants: ele-1
TypeBackboneElement
Standards StatusNormative (from Trial Use)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. ResearchStudy.arm.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
63. ResearchStudy.arm.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.arm.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. ResearchStudy.arm.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Summarytrue
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, modifiers
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.

InvariantsDefined on this element
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())
65. ResearchStudy.arm.name
Definition

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

Control1..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. ResearchStudy.arm.type
Definition

Categorization of study arm, e.g. experimental, active comparator, placebo comparater.

Control0..1 This element is affected by the following invariants: ele-1
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. ResearchStudy.arm.description
Definition

A succinct description of the path through the study that would be followed by a subject adhering to this arm.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. ResearchStudy.objective
Definition

A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

Control0..* This element is affected by the following invariants: ele-1
TypeBackboneElement
Standards StatusNormative (from Trial Use)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. ResearchStudy.objective.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
70. ResearchStudy.objective.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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on ResearchStudy.objective.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
71. ResearchStudy.objective.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).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue
Standards StatusNormative (from Trial Use)
Summarytrue
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, modifiers
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.

InvariantsDefined on this element
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())
72. ResearchStudy.objective.name
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Standards StatusNormative (from Trial Use)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. ResearchStudy.objective.type
Definition

The kind of study objective.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from ResearchStudyObjectiveType Codes for the kind of study objective
TypeCodeableConcept
Standards StatusNormative (from Trial Use)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))