Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - ballot International flag

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: ParticipantFlowMeasure

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/participant-flow-measure Version: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ParticipantFlowMeasure

Profile of EvidenceVariable for Evidence Based Medicine IG. The ParticipantFlowMeasure Profile is used to describe outcome measures for completion and reasons for non-completion of participation in a research study.

See Understanding the EvidenceVariable Resource for additional information.

Usage:

Formal Views of Profile Content

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

This structure is derived from VariableDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable VariableDefinition
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Required Pattern: dichotomous

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
Required Pattern: dichotomous

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EvidenceVariable.handlingrequiredPattern: dichotomous
http://hl7.org/fhir/ValueSet/variable-handling|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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_]){1,254}$')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... definition 1..1 CodeableReference(Group) Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the evidence variable
... version Σ 0..1 string Business version of the evidence variable
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this evidence variable (computer friendly)
... title Σ 0..1 string Name for this evidence variable (human friendly)
... shortTitle Σ 0..1 string Title for use in informal contexts
... 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
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the resource was approved by publisher
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
... effectivePeriod 0..1 Period When the resource is expected to be used
... 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
... actual 0..1 boolean Actual or conceptual
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
Required Pattern: dichotomous
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... valueReference 0..1 Reference(Group) Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.typeexampleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
EvidenceVariable.characteristic.definitionByTypeAndValue.methodexampleDefinitionMethod
http://hl7.org/fhir/ValueSet/definition-method
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.offsetexampleCharacteristicOffset
http://hl7.org/fhir/ValueSet/characteristic-offset
from the FHIR Standard
EvidenceVariable.characteristic.definitionByCombination.coderequiredCharacteristicCombination
http://hl7.org/fhir/ValueSet/characteristic-combination|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.timeFromEvent.event[x]exampleEvidenceVariableEvent
http://hl7.org/fhir/ValueSet/evidence-variable-event
from the FHIR Standard
EvidenceVariable.handlingrequiredPattern: dichotomous
http://hl7.org/fhir/ValueSet/variable-handling|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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_]){1,254}$')
cnl-1warningEvidenceVariable.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 VariableDefinition

Summary

Maturity: 1

Differential View

This structure is derived from VariableDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable VariableDefinition
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Required Pattern: dichotomous

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
Required Pattern: dichotomous

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EvidenceVariable.handlingrequiredPattern: dichotomous
http://hl7.org/fhir/ValueSet/variable-handling|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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_]){1,254}$')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... definition 1..1 CodeableReference(Group) Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the evidence variable
... version Σ 0..1 string Business version of the evidence variable
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this evidence variable (computer friendly)
... title Σ 0..1 string Name for this evidence variable (human friendly)
... shortTitle Σ 0..1 string Title for use in informal contexts
... 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
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the resource was approved by publisher
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
... effectivePeriod 0..1 Period When the resource is expected to be used
... 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
... actual 0..1 boolean Actual or conceptual
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
Required Pattern: dichotomous
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... valueReference 0..1 Reference(Group) Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.typeexampleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
EvidenceVariable.characteristic.definitionByTypeAndValue.methodexampleDefinitionMethod
http://hl7.org/fhir/ValueSet/definition-method
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.offsetexampleCharacteristicOffset
http://hl7.org/fhir/ValueSet/characteristic-offset
from the FHIR Standard
EvidenceVariable.characteristic.definitionByCombination.coderequiredCharacteristicCombination
http://hl7.org/fhir/ValueSet/characteristic-combination|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.timeFromEvent.event[x]exampleEvidenceVariableEvent
http://hl7.org/fhir/ValueSet/evidence-variable-event
from the FHIR Standard
EvidenceVariable.handlingrequiredPattern: dichotomous
http://hl7.org/fhir/ValueSet/variable-handling|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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_]){1,254}$')
cnl-1warningEvidenceVariable.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 VariableDefinition

Summary

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron