Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ResearchStudy | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_ResearchStudy_R4B | ||
This cross-version profile allows STU3 ResearchStudy content to be represented via FHIR R4B ResearchStudy resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy(4.3.0) | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn Binding: ResearchStudyStatus (required): Codes that convey the current status of the research study. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.status | Base | required | ResearchStudyStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ResearchStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ResearchStudy | 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 | error | ResearchStudy | 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 | error | ResearchStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ResearchStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ResearchStudy.implicitRules, ResearchStudy.modifierExtension, ResearchStudy.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ResearchStudy.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ResearchStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchStudy(4.3.0) | Investigation to increase healthcare-related patient-independent knowledge | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this study | ||||
![]() ![]() |
Σ | 0..* | Reference(PlanDefinition) | Steps followed in executing study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: protocol additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(ResearchStudy) | Part of larger study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn Binding: ResearchStudyStatus (required): Codes that convey the current status of the research study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (extensible): Codes for the main intent of the study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 Binding: ResearchStudyPhase (example): Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classifications for the study Binding Description: (example): Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Drugs, devices, etc. under study Binding Description: (example): Codes for medications, devices and other interventions. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Condition being studied Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
0..* | RelatedArtifact | References and dependencies | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | STU3: relatedArtifact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.relatedArtifact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Short label | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Brief description of the related artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | What document is being referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Used to search for the study Binding Description: (example): Words associated with the study that may be useful in discovery. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Geographic region(s) for study Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | What this is study doing | |||||
![]() ![]() |
Σ | 0..* | Reference(Group) | Inclusion & exclusion criteria | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: enrollment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Period | When the study began and ended | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.period Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that initiates and is legally responsible for the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Organization responsible for the study additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Researcher who oversees multiple aspects of the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The individual responsible for the study additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Location) | Facility where study activities are conducted | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Location involved in study execution additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design Binding: ResearchStudyReasonStopped (example): Codes for why the study ended prematurely. | ||||
![]() ![]() |
0..* | Annotation | Comments made about the study | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | STU3: Comments made about the event additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.note Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
0..* | BackboneElement | Defined path through the study for a subject | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | string | Label for study arm | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Categorization of study arm | |||||
![]() ![]() ![]() |
0..1 | string | Short explanation of study path | |||||
![]() ![]() |
0..* | BackboneElement | A goal for the study | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | Label for the objective | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ResearchStudy.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ResearchStudy.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ResearchStudy.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ResearchStudy.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ResearchStudy.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.protocol.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.status | Base | required | ResearchStudyStatus | 📍4.3.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | extensible | ResearchStudyPrimaryPurposeType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.phase | Base | example | ResearchStudyPhase | 📍4.3.0 | FHIR Std. |
| ResearchStudy.category | Base | example | Not State | Unknown | |
| ResearchStudy.focus | Base | example | Not State | Unknown | |
| ResearchStudy.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| ResearchStudy.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.keyword | Base | example | Not State | Unknown | |
| ResearchStudy.location | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ResearchStudy.enrollment.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.sponsor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.principalInvestigator.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.site.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.reasonStopped | Base | example | ResearchStudyReasonStopped | 📍4.3.0 | FHIR Std. |
| ResearchStudy.objective.type | Base | preferred | ResearchStudyObjectiveType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ResearchStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ResearchStudy | 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 | error | ResearchStudy | 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 | error | ResearchStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ResearchStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | ResearchStudy.contained | 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)
|
| ele-1 | error | ResearchStudy.meta, ResearchStudy.meta.extension, ResearchStudy.meta.extension:meta, ResearchStudy.meta.versionId, ResearchStudy.meta.lastUpdated, ResearchStudy.meta.source, ResearchStudy.meta.profile, ResearchStudy.meta.security, ResearchStudy.meta.tag, ResearchStudy.implicitRules, ResearchStudy.language, ResearchStudy.text, ResearchStudy.text.extension, ResearchStudy.text.extension:text, ResearchStudy.text.status, ResearchStudy.text.div, ResearchStudy.extension, ResearchStudy.modifierExtension, ResearchStudy.identifier, ResearchStudy.identifier.extension, ResearchStudy.identifier.extension:identifier, ResearchStudy.identifier.use, ResearchStudy.identifier.type, ResearchStudy.identifier.system, ResearchStudy.identifier.value, ResearchStudy.identifier.period, ResearchStudy.identifier.assigner, ResearchStudy.title, ResearchStudy.protocol, ResearchStudy.protocol.extension, ResearchStudy.protocol.extension:protocol, ResearchStudy.protocol.reference, ResearchStudy.protocol.type, ResearchStudy.protocol.identifier, ResearchStudy.protocol.display, ResearchStudy.partOf, ResearchStudy.partOf.extension, ResearchStudy.partOf.extension:partOf, ResearchStudy.partOf.reference, ResearchStudy.partOf.type, ResearchStudy.partOf.identifier, ResearchStudy.partOf.display, ResearchStudy.status, ResearchStudy.primaryPurposeType, ResearchStudy.phase, ResearchStudy.category, ResearchStudy.focus, ResearchStudy.condition, ResearchStudy.contact, ResearchStudy.contact.extension, ResearchStudy.contact.extension:contact, ResearchStudy.contact.name, ResearchStudy.contact.telecom, ResearchStudy.relatedArtifact, ResearchStudy.relatedArtifact.extension, ResearchStudy.relatedArtifact.extension:relatedArtifact, ResearchStudy.relatedArtifact.type, ResearchStudy.relatedArtifact.label, ResearchStudy.relatedArtifact.display, ResearchStudy.relatedArtifact.citation, ResearchStudy.relatedArtifact.url, ResearchStudy.relatedArtifact.document, ResearchStudy.relatedArtifact.resource, ResearchStudy.keyword, ResearchStudy.location, ResearchStudy.description, ResearchStudy.enrollment, ResearchStudy.enrollment.extension, ResearchStudy.enrollment.extension:enrollment, ResearchStudy.enrollment.reference, ResearchStudy.enrollment.type, ResearchStudy.enrollment.identifier, ResearchStudy.enrollment.display, ResearchStudy.period, ResearchStudy.period.extension, ResearchStudy.period.extension:period, ResearchStudy.period.start, ResearchStudy.period.end, ResearchStudy.sponsor, ResearchStudy.sponsor.extension, ResearchStudy.sponsor.extension:sponsor, ResearchStudy.sponsor.reference, ResearchStudy.sponsor.type, ResearchStudy.sponsor.identifier, ResearchStudy.sponsor.display, ResearchStudy.principalInvestigator, ResearchStudy.principalInvestigator.extension, ResearchStudy.principalInvestigator.extension:principalInvestigator, ResearchStudy.principalInvestigator.reference, ResearchStudy.principalInvestigator.type, ResearchStudy.principalInvestigator.identifier, ResearchStudy.principalInvestigator.display, ResearchStudy.site, ResearchStudy.site.extension, ResearchStudy.site.extension:site, ResearchStudy.site.reference, ResearchStudy.site.type, ResearchStudy.site.identifier, ResearchStudy.site.display, ResearchStudy.reasonStopped, ResearchStudy.note, ResearchStudy.note.extension, ResearchStudy.note.extension:note, ResearchStudy.note.author[x], ResearchStudy.note.time, ResearchStudy.note.text, ResearchStudy.arm, ResearchStudy.arm.extension, ResearchStudy.arm.modifierExtension, ResearchStudy.arm.name, ResearchStudy.arm.type, ResearchStudy.arm.description, ResearchStudy.objective, ResearchStudy.objective.extension, ResearchStudy.objective.modifierExtension, ResearchStudy.objective.name, ResearchStudy.objective.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ResearchStudy.meta.extension, ResearchStudy.meta.extension:meta, ResearchStudy.text.extension, ResearchStudy.text.extension:text, ResearchStudy.extension, ResearchStudy.modifierExtension, ResearchStudy.identifier.extension, ResearchStudy.identifier.extension:identifier, ResearchStudy.protocol.extension, ResearchStudy.protocol.extension:protocol, ResearchStudy.partOf.extension, ResearchStudy.partOf.extension:partOf, ResearchStudy.contact.extension, ResearchStudy.contact.extension:contact, ResearchStudy.relatedArtifact.extension, ResearchStudy.relatedArtifact.extension:relatedArtifact, ResearchStudy.enrollment.extension, ResearchStudy.enrollment.extension:enrollment, ResearchStudy.period.extension, ResearchStudy.period.extension:period, ResearchStudy.sponsor.extension, ResearchStudy.sponsor.extension:sponsor, ResearchStudy.principalInvestigator.extension, ResearchStudy.principalInvestigator.extension:principalInvestigator, ResearchStudy.site.extension, ResearchStudy.site.extension:site, ResearchStudy.note.extension, ResearchStudy.note.extension:note, ResearchStudy.arm.extension, ResearchStudy.arm.modifierExtension, ResearchStudy.objective.extension, ResearchStudy.objective.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ResearchStudy.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ResearchStudy.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ResearchStudy
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchStudy(4.3.0) | Investigation to increase healthcare-related patient-independent knowledge | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn Binding: ResearchStudyStatus (required): Codes that convey the current status of the research study. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.status | Base | required | ResearchStudyStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ResearchStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ResearchStudy | 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 | error | ResearchStudy | 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 | error | ResearchStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ResearchStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ResearchStudy.implicitRules, ResearchStudy.modifierExtension, ResearchStudy.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ResearchStudy.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ResearchStudy
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchStudy(4.3.0) | Investigation to increase healthcare-related patient-independent knowledge | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this study | ||||
![]() ![]() |
Σ | 0..* | Reference(PlanDefinition) | Steps followed in executing study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: protocol additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(ResearchStudy) | Part of larger study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn Binding: ResearchStudyStatus (required): Codes that convey the current status of the research study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility Binding: ResearchStudyPrimaryPurposeType (extensible): Codes for the main intent of the study. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 Binding: ResearchStudyPhase (example): Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classifications for the study Binding Description: (example): Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Drugs, devices, etc. under study Binding Description: (example): Codes for medications, devices and other interventions. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Condition being studied Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis. | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.contact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of an individual to contact | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
![]() ![]() |
0..* | RelatedArtifact | References and dependencies | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | STU3: relatedArtifact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.relatedArtifact Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Short label | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Brief description of the related artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | What document is being referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Used to search for the study Binding Description: (example): Words associated with the study that may be useful in discovery. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Geographic region(s) for study Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | What this is study doing | |||||
![]() ![]() |
Σ | 0..* | Reference(Group) | Inclusion & exclusion criteria | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: enrollment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Period | When the study began and ended | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.period Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that initiates and is legally responsible for the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Organization responsible for the study additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Researcher who oversees multiple aspects of the study | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The individual responsible for the study additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Location) | Facility where study activities are conducted | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Location involved in study execution additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design Binding: ResearchStudyReasonStopped (example): Codes for why the study ended prematurely. | ||||
![]() ![]() |
0..* | Annotation | Comments made about the study | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | STU3: Comments made about the event additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ResearchStudy.note Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
0..* | BackboneElement | Defined path through the study for a subject | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | string | Label for study arm | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Categorization of study arm | |||||
![]() ![]() ![]() |
0..1 | string | Short explanation of study path | |||||
![]() ![]() |
0..* | BackboneElement | A goal for the study | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | Label for the objective | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | primary | secondary | exploratory Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective. | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ResearchStudy.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ResearchStudy.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ResearchStudy.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ResearchStudy.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ResearchStudy.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ResearchStudy.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.protocol.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.status | Base | required | ResearchStudyStatus | 📍4.3.0 | FHIR Std. |
| ResearchStudy.primaryPurposeType | Base | extensible | ResearchStudyPrimaryPurposeType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.phase | Base | example | ResearchStudyPhase | 📍4.3.0 | FHIR Std. |
| ResearchStudy.category | Base | example | Not State | Unknown | |
| ResearchStudy.focus | Base | example | Not State | Unknown | |
| ResearchStudy.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍4.3.0 | FHIR Std. |
| ResearchStudy.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.keyword | Base | example | Not State | Unknown | |
| ResearchStudy.location | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| ResearchStudy.enrollment.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.sponsor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.principalInvestigator.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.site.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ResearchStudy.reasonStopped | Base | example | ResearchStudyReasonStopped | 📍4.3.0 | FHIR Std. |
| ResearchStudy.objective.type | Base | preferred | ResearchStudyObjectiveType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ResearchStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ResearchStudy | 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 | error | ResearchStudy | 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 | error | ResearchStudy | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ResearchStudy | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | ResearchStudy.contained | 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)
|
| ele-1 | error | ResearchStudy.meta, ResearchStudy.meta.extension, ResearchStudy.meta.extension:meta, ResearchStudy.meta.versionId, ResearchStudy.meta.lastUpdated, ResearchStudy.meta.source, ResearchStudy.meta.profile, ResearchStudy.meta.security, ResearchStudy.meta.tag, ResearchStudy.implicitRules, ResearchStudy.language, ResearchStudy.text, ResearchStudy.text.extension, ResearchStudy.text.extension:text, ResearchStudy.text.status, ResearchStudy.text.div, ResearchStudy.extension, ResearchStudy.modifierExtension, ResearchStudy.identifier, ResearchStudy.identifier.extension, ResearchStudy.identifier.extension:identifier, ResearchStudy.identifier.use, ResearchStudy.identifier.type, ResearchStudy.identifier.system, ResearchStudy.identifier.value, ResearchStudy.identifier.period, ResearchStudy.identifier.assigner, ResearchStudy.title, ResearchStudy.protocol, ResearchStudy.protocol.extension, ResearchStudy.protocol.extension:protocol, ResearchStudy.protocol.reference, ResearchStudy.protocol.type, ResearchStudy.protocol.identifier, ResearchStudy.protocol.display, ResearchStudy.partOf, ResearchStudy.partOf.extension, ResearchStudy.partOf.extension:partOf, ResearchStudy.partOf.reference, ResearchStudy.partOf.type, ResearchStudy.partOf.identifier, ResearchStudy.partOf.display, ResearchStudy.status, ResearchStudy.primaryPurposeType, ResearchStudy.phase, ResearchStudy.category, ResearchStudy.focus, ResearchStudy.condition, ResearchStudy.contact, ResearchStudy.contact.extension, ResearchStudy.contact.extension:contact, ResearchStudy.contact.name, ResearchStudy.contact.telecom, ResearchStudy.relatedArtifact, ResearchStudy.relatedArtifact.extension, ResearchStudy.relatedArtifact.extension:relatedArtifact, ResearchStudy.relatedArtifact.type, ResearchStudy.relatedArtifact.label, ResearchStudy.relatedArtifact.display, ResearchStudy.relatedArtifact.citation, ResearchStudy.relatedArtifact.url, ResearchStudy.relatedArtifact.document, ResearchStudy.relatedArtifact.resource, ResearchStudy.keyword, ResearchStudy.location, ResearchStudy.description, ResearchStudy.enrollment, ResearchStudy.enrollment.extension, ResearchStudy.enrollment.extension:enrollment, ResearchStudy.enrollment.reference, ResearchStudy.enrollment.type, ResearchStudy.enrollment.identifier, ResearchStudy.enrollment.display, ResearchStudy.period, ResearchStudy.period.extension, ResearchStudy.period.extension:period, ResearchStudy.period.start, ResearchStudy.period.end, ResearchStudy.sponsor, ResearchStudy.sponsor.extension, ResearchStudy.sponsor.extension:sponsor, ResearchStudy.sponsor.reference, ResearchStudy.sponsor.type, ResearchStudy.sponsor.identifier, ResearchStudy.sponsor.display, ResearchStudy.principalInvestigator, ResearchStudy.principalInvestigator.extension, ResearchStudy.principalInvestigator.extension:principalInvestigator, ResearchStudy.principalInvestigator.reference, ResearchStudy.principalInvestigator.type, ResearchStudy.principalInvestigator.identifier, ResearchStudy.principalInvestigator.display, ResearchStudy.site, ResearchStudy.site.extension, ResearchStudy.site.extension:site, ResearchStudy.site.reference, ResearchStudy.site.type, ResearchStudy.site.identifier, ResearchStudy.site.display, ResearchStudy.reasonStopped, ResearchStudy.note, ResearchStudy.note.extension, ResearchStudy.note.extension:note, ResearchStudy.note.author[x], ResearchStudy.note.time, ResearchStudy.note.text, ResearchStudy.arm, ResearchStudy.arm.extension, ResearchStudy.arm.modifierExtension, ResearchStudy.arm.name, ResearchStudy.arm.type, ResearchStudy.arm.description, ResearchStudy.objective, ResearchStudy.objective.extension, ResearchStudy.objective.modifierExtension, ResearchStudy.objective.name, ResearchStudy.objective.type | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ResearchStudy.meta.extension, ResearchStudy.meta.extension:meta, ResearchStudy.text.extension, ResearchStudy.text.extension:text, ResearchStudy.extension, ResearchStudy.modifierExtension, ResearchStudy.identifier.extension, ResearchStudy.identifier.extension:identifier, ResearchStudy.protocol.extension, ResearchStudy.protocol.extension:protocol, ResearchStudy.partOf.extension, ResearchStudy.partOf.extension:partOf, ResearchStudy.contact.extension, ResearchStudy.contact.extension:contact, ResearchStudy.relatedArtifact.extension, ResearchStudy.relatedArtifact.extension:relatedArtifact, ResearchStudy.enrollment.extension, ResearchStudy.enrollment.extension:enrollment, ResearchStudy.period.extension, ResearchStudy.period.extension:period, ResearchStudy.sponsor.extension, ResearchStudy.sponsor.extension:sponsor, ResearchStudy.principalInvestigator.extension, ResearchStudy.principalInvestigator.extension:principalInvestigator, ResearchStudy.site.extension, ResearchStudy.site.extension:site, ResearchStudy.note.extension, ResearchStudy.note.extension:note, ResearchStudy.arm.extension, ResearchStudy.arm.modifierExtension, ResearchStudy.objective.extension, ResearchStudy.objective.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ResearchStudy.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ResearchStudy.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ResearchStudy
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron