AnVIL Implementation Guide
0.1.0 - CI Build

AnVIL Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

StructureDefinition: AnvilResearchStudy

An AnVIL ResearchStudy.

The official URL for this profile is: 

http://theanvil.io/fhir/anvil/StructureDefinition/anvil-research-study

Formal Views of Profile Content

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

This structure is derived from ResearchStudy

Summary

Extensions

This structure refers to these extensions:

This structure is derived from ResearchStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy I0..*ResearchStudyInvestigation to increase healthcare-related patient-independent knowledge
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... anvil-document-reference I0..*Reference(DRS Attachment)Optional Extensions Element
URL: http://theanvil.io/fhir/anvil/StructureDefinition/anvil-document-reference
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for study
... title ΣI0..1stringName for this study
... protocol ΣI0..*Reference(PlanDefinition)Steps followed in executing study
... partOf ΣI0..*Reference(ResearchStudy)Part of larger study
... status ?!ΣI1..1codeactive | 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)
... primaryPurposeType ΣI0..1CodeableConcepttreatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
Binding: ResearchStudyPrimaryPurposeType (extensible)
... phase ΣI0..1CodeableConceptn-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
Binding: ResearchStudyPhase (example)
... category ΣI0..*CodeableConceptClassifications for the study
Binding: (unbound) (example)
... focus ΣI0..*CodeableConceptDrugs, devices, etc. under study
Binding: (unbound) (example)
... condition ΣI0..*CodeableConceptCondition being studied
Binding: Condition/Problem/DiagnosisCodes (example)
... contact ΣI0..*ContactDetailContact details for the study
... relatedArtifact I0..*RelatedArtifactReferences and dependencies
... keyword ΣI0..*CodeableConceptUsed to search for the study
Binding: (unbound) (example)
... location ΣI0..*CodeableConceptGeographic region(s) for study
Binding: Jurisdiction ValueSet (extensible)
... description I0..1markdownWhat this is study doing
... enrollment ΣI0..*Reference(Group)Inclusion & exclusion criteria
... period ΣI0..1PeriodWhen the study began and ended
... sponsor ΣI0..1Reference(Organization)Organization that initiates and is legally responsible for the study
... principalInvestigator ΣI0..1Reference(Practitioner | PractitionerRole)Researcher who oversees multiple aspects of the study
... site ΣI0..*Reference(Location)Facility where study activities are conducted
... reasonStopped ΣI0..1CodeableConceptaccrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
Binding: ResearchStudyReasonStopped (example)
... note I0..*AnnotationComments made about the study
... arm I0..*BackboneElementDefined path through the study for a subject
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name I1..1stringLabel for study arm
.... type I0..1CodeableConceptCategorization of study arm
.... description I0..1stringShort explanation of study path
... objective I0..*BackboneElementA goal for the study
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name I0..1stringLabel for the objective
.... type I0..1CodeableConceptprimary | secondary | exploratory
Binding: ResearchStudyObjectiveType (preferred)

doco Documentation for this format

This structure is derived from ResearchStudy

Summary

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ResearchStudy

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchStudy I0..*ResearchStudyInvestigation to increase healthcare-related patient-independent knowledge
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... anvil-document-reference I0..*Reference(DRS Attachment)Optional Extensions Element
URL: http://theanvil.io/fhir/anvil/StructureDefinition/anvil-document-reference
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifier for study
... title ΣI0..1stringName for this study
... protocol ΣI0..*Reference(PlanDefinition)Steps followed in executing study
... partOf ΣI0..*Reference(ResearchStudy)Part of larger study
... status ?!ΣI1..1codeactive | 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)
... primaryPurposeType ΣI0..1CodeableConcepttreatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
Binding: ResearchStudyPrimaryPurposeType (extensible)
... phase ΣI0..1CodeableConceptn-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
Binding: ResearchStudyPhase (example)
... category ΣI0..*CodeableConceptClassifications for the study
Binding: (unbound) (example)
... focus ΣI0..*CodeableConceptDrugs, devices, etc. under study
Binding: (unbound) (example)
... condition ΣI0..*CodeableConceptCondition being studied
Binding: Condition/Problem/DiagnosisCodes (example)
... contact ΣI0..*ContactDetailContact details for the study
... relatedArtifact I0..*RelatedArtifactReferences and dependencies
... keyword ΣI0..*CodeableConceptUsed to search for the study
Binding: (unbound) (example)
... location ΣI0..*CodeableConceptGeographic region(s) for study
Binding: Jurisdiction ValueSet (extensible)
... description I0..1markdownWhat this is study doing
... enrollment ΣI0..*Reference(Group)Inclusion & exclusion criteria
... period ΣI0..1PeriodWhen the study began and ended
... sponsor ΣI0..1Reference(Organization)Organization that initiates and is legally responsible for the study
... principalInvestigator ΣI0..1Reference(Practitioner | PractitionerRole)Researcher who oversees multiple aspects of the study
... site ΣI0..*Reference(Location)Facility where study activities are conducted
... reasonStopped ΣI0..1CodeableConceptaccrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
Binding: ResearchStudyReasonStopped (example)
... note I0..*AnnotationComments made about the study
... arm I0..*BackboneElementDefined path through the study for a subject
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name I1..1stringLabel for study arm
.... type I0..1CodeableConceptCategorization of study arm
.... description I0..1stringShort explanation of study path
... objective I0..*BackboneElementA goal for the study
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name I0..1stringLabel for the objective
.... type I0..1CodeableConceptprimary | secondary | exploratory
Binding: ResearchStudyObjectiveType (preferred)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ResearchStudy.languagepreferredCommonLanguages
Max Binding: AllLanguages
ResearchStudy.statusrequiredResearchStudyStatus
ResearchStudy.primaryPurposeTypeextensibleResearchStudyPrimaryPurposeType
ResearchStudy.phaseexampleResearchStudyPhase
ResearchStudy.categoryexample
ResearchStudy.focusexample
ResearchStudy.conditionexampleCondition/Problem/DiagnosisCodes
ResearchStudy.keywordexample
ResearchStudy.locationextensibleJurisdiction ValueSet
ResearchStudy.reasonStoppedexampleResearchStudyReasonStopped
ResearchStudy.objective.typepreferredResearchStudyObjectiveType

Constraints

Constraints

IdPathDetailsRequirements