HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: JP_ResearchStudy

項目内容
定義URL http://jpfhir.jp/fhir/core/StructureDefinition/JP_ResearchStudy
Version 2.0.0-dev
Name

JP_ResearchStudy

Status Active ( 2023-10-31 )
Copyright

Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG

JP_ResearchStudy 暫定プロファイル

Usage:

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

プロファイル詳細

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

This structure is derived from ResearchStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
... meta
.... lastUpdated S 0..1 instant When the resource version last changed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 0..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 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.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for study
... title Σ 0..1 string Name for this study
... protocol Σ 0..* Reference(PlanDefinition) Steps followed in executing study
... partOf Σ 0..* Reference(ResearchStudy) Part of larger study
... status ?!Σ 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.

... primaryPurposeType Σ 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.

... phase Σ 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.

... category Σ 0..* CodeableConcept Classifications for the study
Binding Description (No ValueSet): (example): Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc.


... focus Σ 0..* CodeableConcept Drugs, devices, etc. under study
Binding Description (No ValueSet): (example): Codes for medications, devices and other interventions.


... condition Σ 0..* CodeableConcept Condition being studied
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.


... contact Σ 0..* ContactDetail Contact details for the study
... relatedArtifact 0..* RelatedArtifact References and dependencies
... keyword Σ 0..* CodeableConcept Used to search for the study
Binding Description (No ValueSet): (example): Words associated with the study that may be useful in discovery.


... location Σ 0..* CodeableConcept Geographic region(s) for study
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... description 0..1 markdown What this is study doing
... enrollment Σ 0..* Reference(Group) Inclusion & exclusion criteria
... period Σ 0..1 Period When the study began and ended
... sponsor Σ 0..1 Reference(Organization) Organization that initiates and is legally responsible for the study
... principalInvestigator Σ 0..1 Reference(Practitioner | PractitionerRole) Researcher who oversees multiple aspects of the study
... site Σ 0..* Reference(Location) Facility where study activities are conducted
... reasonStopped Σ 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.

... note 0..* Annotation Comments made about the study
... arm 0..* BackboneElement Defined path through the study for a subject
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Label for study arm
.... type 0..1 CodeableConcept Categorization of study arm
.... description 0..1 string Short explanation of study path
... objective 0..* BackboneElement A goal for the study
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Label for the objective
.... type 0..1 CodeableConcept primary | secondary | exploratory
Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ResearchStudy.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ResearchStudy.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ResearchStudy.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ResearchStudy.statusrequiredResearchStudyStatus
http://hl7.org/fhir/ValueSet/research-study-status|4.3.0
from the FHIR Standard
ResearchStudy.primaryPurposeTypeextensibleResearchStudyPrimaryPurposeType
http://hl7.org/fhir/ValueSet/research-study-prim-purp-type
from the FHIR Standard
ResearchStudy.phaseexampleResearchStudyPhase
http://hl7.org/fhir/ValueSet/research-study-phase
from the FHIR Standard
ResearchStudy.categoryexample
ResearchStudy.focusexample
ResearchStudy.conditionexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
ResearchStudy.keywordexample
ResearchStudy.locationextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ResearchStudy.reasonStoppedexampleResearchStudyReasonStopped
http://hl7.org/fhir/ValueSet/research-study-reason-stopped
from the FHIR Standard
ResearchStudy.objective.typepreferredResearchStudyObjectiveType
http://hl7.org/fhir/ValueSet/research-study-objective-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorResearchStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorResearchStudyIf 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-4errorResearchStudyIf 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-5errorResearchStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceResearchStudyA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningResearchStudy.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ResearchStudy

Summary

Must-Support: 1 element

Differential View

This structure is derived from ResearchStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
... meta
.... lastUpdated S 0..1 instant When the resource version last changed

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 0..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 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.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy 0..* ResearchStudy Investigation to increase healthcare-related patient-independent knowledge
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for study
... title Σ 0..1 string Name for this study
... protocol Σ 0..* Reference(PlanDefinition) Steps followed in executing study
... partOf Σ 0..* Reference(ResearchStudy) Part of larger study
... status ?!Σ 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.

... primaryPurposeType Σ 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.

... phase Σ 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.

... category Σ 0..* CodeableConcept Classifications for the study
Binding Description (No ValueSet): (example): Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc.


... focus Σ 0..* CodeableConcept Drugs, devices, etc. under study
Binding Description (No ValueSet): (example): Codes for medications, devices and other interventions.


... condition Σ 0..* CodeableConcept Condition being studied
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.


... contact Σ 0..* ContactDetail Contact details for the study
... relatedArtifact 0..* RelatedArtifact References and dependencies
... keyword Σ 0..* CodeableConcept Used to search for the study
Binding Description (No ValueSet): (example): Words associated with the study that may be useful in discovery.


... location Σ 0..* CodeableConcept Geographic region(s) for study
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... description 0..1 markdown What this is study doing
... enrollment Σ 0..* Reference(Group) Inclusion & exclusion criteria
... period Σ 0..1 Period When the study began and ended
... sponsor Σ 0..1 Reference(Organization) Organization that initiates and is legally responsible for the study
... principalInvestigator Σ 0..1 Reference(Practitioner | PractitionerRole) Researcher who oversees multiple aspects of the study
... site Σ 0..* Reference(Location) Facility where study activities are conducted
... reasonStopped Σ 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.

... note 0..* Annotation Comments made about the study
... arm 0..* BackboneElement Defined path through the study for a subject
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Label for study arm
.... type 0..1 CodeableConcept Categorization of study arm
.... description 0..1 string Short explanation of study path
... objective 0..* BackboneElement A goal for the study
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Label for the objective
.... type 0..1 CodeableConcept primary | secondary | exploratory
Binding: ResearchStudyObjectiveType (preferred): Codes for the kind of study objective.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ResearchStudy.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ResearchStudy.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ResearchStudy.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ResearchStudy.statusrequiredResearchStudyStatus
http://hl7.org/fhir/ValueSet/research-study-status|4.3.0
from the FHIR Standard
ResearchStudy.primaryPurposeTypeextensibleResearchStudyPrimaryPurposeType
http://hl7.org/fhir/ValueSet/research-study-prim-purp-type
from the FHIR Standard
ResearchStudy.phaseexampleResearchStudyPhase
http://hl7.org/fhir/ValueSet/research-study-phase
from the FHIR Standard
ResearchStudy.categoryexample
ResearchStudy.focusexample
ResearchStudy.conditionexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
ResearchStudy.keywordexample
ResearchStudy.locationextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ResearchStudy.reasonStoppedexampleResearchStudyReasonStopped
http://hl7.org/fhir/ValueSet/research-study-reason-stopped
from the FHIR Standard
ResearchStudy.objective.typepreferredResearchStudyObjectiveType
http://hl7.org/fhir/ValueSet/research-study-objective-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorResearchStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorResearchStudyIf 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-4errorResearchStudyIf 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-5errorResearchStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceResearchStudyA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningResearchStudy.containedContaining 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ResearchStudy

Summary

Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron

本実装ガイドへのご質問・ご指摘については、GitHub IssueおよびGitHub PullRequestにて受け付けております。