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

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

Resource Profile: Profile_R4_ResearchDefinition_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-ResearchDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_ResearchDefinition_R4B

This cross-version profile allows R4 ResearchDefinition content to be represented via FHIR R4B ResearchDefinition resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition C 0..* ResearchDefinition(4.3.0) A research context or question
Constraints: rsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ResearchDefinition.status Base required PublicationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ResearchDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ResearchDefinition 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 ResearchDefinition 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 ResearchDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ResearchDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error ResearchDefinition.implicitRules, ResearchDefinition.modifierExtension, ResearchDefinition.status, ResearchDefinition.population All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ResearchDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
rsd-0 warning ResearchDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from ResearchDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition 0..* ResearchDefinition(4.3.0) A research context or question

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition C 0..* ResearchDefinition(4.3.0) A research context or question
Constraints: rsd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this research definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the research definition
... version Σ 0..1 string Business version of the research definition
... name Σ 0..1 string Name for this research definition (computer friendly)
... title Σ 0..1 string Name for this research definition (human friendly)
... shortTitle 0..1 string Title for use in informal contexts
... subtitle 0..1 string Subordinate title of the ResearchDefinition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the research definition
... comment 0..* string Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this research definition is defined
... usage 0..1 string Describes the clinical usage of the ResearchDefinition
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the research definition was approved by publisher
... lastReviewDate 0..1 date When the research definition was last reviewed
... effectivePeriod Σ 0..1 Period When the research definition is expected to be used
... topic 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... library 0..* canonical(Library) Logic used by the ResearchDefinition
... population Σ 1..1 Reference(ResearchElementDefinition) What population?
... exposure Σ 0..1 Reference(ResearchElementDefinition) What exposure?
... exposureAlternative Σ 0..1 Reference(ResearchElementDefinition) What alternative exposure state?
... outcome Σ 0..1 Reference(ResearchElementDefinition) What outcome?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ResearchDefinition.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ResearchDefinition.status Base required PublicationStatus 📍4.3.0 FHIR Std.
ResearchDefinition.subject[x] Base extensible Subject type 📍4.3.0 FHIR Std.
ResearchDefinition.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
ResearchDefinition.topic Base example DefinitionTopic 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ResearchDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ResearchDefinition 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 ResearchDefinition 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 ResearchDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ResearchDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ResearchDefinition.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 ResearchDefinition.meta, ResearchDefinition.implicitRules, ResearchDefinition.language, ResearchDefinition.text, ResearchDefinition.extension, ResearchDefinition.modifierExtension, ResearchDefinition.url, ResearchDefinition.identifier, ResearchDefinition.version, ResearchDefinition.name, ResearchDefinition.title, ResearchDefinition.shortTitle, ResearchDefinition.subtitle, ResearchDefinition.status, ResearchDefinition.experimental, ResearchDefinition.subject[x], ResearchDefinition.date, ResearchDefinition.publisher, ResearchDefinition.contact, ResearchDefinition.description, ResearchDefinition.comment, ResearchDefinition.useContext, ResearchDefinition.jurisdiction, ResearchDefinition.purpose, ResearchDefinition.usage, ResearchDefinition.copyright, ResearchDefinition.approvalDate, ResearchDefinition.lastReviewDate, ResearchDefinition.effectivePeriod, ResearchDefinition.topic, ResearchDefinition.author, ResearchDefinition.editor, ResearchDefinition.reviewer, ResearchDefinition.endorser, ResearchDefinition.relatedArtifact, ResearchDefinition.library, ResearchDefinition.population, ResearchDefinition.exposure, ResearchDefinition.exposureAlternative, ResearchDefinition.outcome All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ResearchDefinition.extension, ResearchDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
rsd-0 warning ResearchDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from ResearchDefinition

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition C 0..* ResearchDefinition(4.3.0) A research context or question
Constraints: rsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ResearchDefinition.status Base required PublicationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ResearchDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ResearchDefinition 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 ResearchDefinition 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 ResearchDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ResearchDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error ResearchDefinition.implicitRules, ResearchDefinition.modifierExtension, ResearchDefinition.status, ResearchDefinition.population All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ResearchDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
rsd-0 warning ResearchDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Differential View

This structure is derived from ResearchDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition 0..* ResearchDefinition(4.3.0) A research context or question

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ResearchDefinition C 0..* ResearchDefinition(4.3.0) A research context or question
Constraints: rsd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this research definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the research definition
... version Σ 0..1 string Business version of the research definition
... name Σ 0..1 string Name for this research definition (computer friendly)
... title Σ 0..1 string Name for this research definition (human friendly)
... shortTitle 0..1 string Title for use in informal contexts
... subtitle 0..1 string Subordinate title of the ResearchDefinition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the research definition
... comment 0..* string Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this research definition is defined
... usage 0..1 string Describes the clinical usage of the ResearchDefinition
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the research definition was approved by publisher
... lastReviewDate 0..1 date When the research definition was last reviewed
... effectivePeriod Σ 0..1 Period When the research definition is expected to be used
... topic 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... library 0..* canonical(Library) Logic used by the ResearchDefinition
... population Σ 1..1 Reference(ResearchElementDefinition) What population?
... exposure Σ 0..1 Reference(ResearchElementDefinition) What exposure?
... exposureAlternative Σ 0..1 Reference(ResearchElementDefinition) What alternative exposure state?
... outcome Σ 0..1 Reference(ResearchElementDefinition) What outcome?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ResearchDefinition.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ResearchDefinition.status Base required PublicationStatus 📍4.3.0 FHIR Std.
ResearchDefinition.subject[x] Base extensible Subject type 📍4.3.0 FHIR Std.
ResearchDefinition.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
ResearchDefinition.topic Base example DefinitionTopic 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ResearchDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ResearchDefinition 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 ResearchDefinition 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 ResearchDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ResearchDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ResearchDefinition.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 ResearchDefinition.meta, ResearchDefinition.implicitRules, ResearchDefinition.language, ResearchDefinition.text, ResearchDefinition.extension, ResearchDefinition.modifierExtension, ResearchDefinition.url, ResearchDefinition.identifier, ResearchDefinition.version, ResearchDefinition.name, ResearchDefinition.title, ResearchDefinition.shortTitle, ResearchDefinition.subtitle, ResearchDefinition.status, ResearchDefinition.experimental, ResearchDefinition.subject[x], ResearchDefinition.date, ResearchDefinition.publisher, ResearchDefinition.contact, ResearchDefinition.description, ResearchDefinition.comment, ResearchDefinition.useContext, ResearchDefinition.jurisdiction, ResearchDefinition.purpose, ResearchDefinition.usage, ResearchDefinition.copyright, ResearchDefinition.approvalDate, ResearchDefinition.lastReviewDate, ResearchDefinition.effectivePeriod, ResearchDefinition.topic, ResearchDefinition.author, ResearchDefinition.editor, ResearchDefinition.reviewer, ResearchDefinition.endorser, ResearchDefinition.relatedArtifact, ResearchDefinition.library, ResearchDefinition.population, ResearchDefinition.exposure, ResearchDefinition.exposureAlternative, ResearchDefinition.outcome All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ResearchDefinition.extension, ResearchDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
rsd-0 warning ResearchDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from ResearchDefinition

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron