Common UML Documentation

Element

Common
Class Prediction

"Describes the expected outcome for the subject." - HL7 FHIR, RiskAssessment.prediction

Attributes
«CS» Code	outcome	"One of the potential outcomes for the patient (e.g. remission, death, a particular condition)." - HL7 FHIR, RiskAssessment.prediction.outcome
«REAL» Decimal	probabilityDecimal	"How likely is the outcome (in the specified timeframe)." - HL7 FHIR, RiskAssessment.prediction.probability[x]
«CS» Code	probabilityRange	"How likely is the outcome (in the specified timeframe)." - HL7 FHIR, RiskAssessment.prediction.probability[x]
«CS» Code	qualitativeRisk	"How likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high)." - HL7 FHIR, RiskAssessment.prediction.qualitativeRisk
String	rationale	"Additional information explaining the basis for the prediction." - HL7 FHIR, RiskAssessment.prediction.rationale
«REAL» Decimal	relativeRisk	"Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk)." - HL7 FHIR, RiskAssessment.prediction.relativeRisk
«IVL_TS» TimeInterval	when	"Indicates the period of time or age range of the subject to which the specified probability applies." - HL7 FHIR, RiskAssessment.prediction.when Note that the FHIR datatype can be a Period or Range; FHIM currently models this as a TimeInterval.

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	Prediction
Name Expression
Namespace	Common
Owned Template Signature
Owner	Common
Owning Template Parameter
Package	Common
Qualified Name	FHIM::Common::Prediction
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

outcome

Public «CS» Code outcome

"One of the potential outcomes for the patient (e.g. remission, death, a particular condition)." - HL7 FHIR, RiskAssessment.prediction.outcome

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	outcome
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::outcome
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

probabilityDecimal

Public «REAL» Decimal probabilityDecimal

"How likely is the outcome (in the specified timeframe)." - HL7 FHIR, RiskAssessment.prediction.probability[x]

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	probabilityDecimal
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::probabilityDecimal
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

probabilityRange

Public «CS» Code probabilityRange

"How likely is the outcome (in the specified timeframe)." - HL7 FHIR, RiskAssessment.prediction.probability[x]

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	probabilityRange
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::probabilityRange
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

qualitativeRisk

Public «CS» Code qualitativeRisk

"How likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high)." - HL7 FHIR, RiskAssessment.prediction.qualitativeRisk

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	qualitativeRisk
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::qualitativeRisk
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

rationale

Public String rationale

"Additional information explaining the basis for the prediction." - HL7 FHIR, RiskAssessment.prediction.rationale

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	rationale
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::rationale
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

relativeRisk

Public «REAL» Decimal relativeRisk

"Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk)." - HL7 FHIR, RiskAssessment.prediction.relativeRisk

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	relativeRisk
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::relativeRisk
Stereotype
Template Parameter
Type	«REAL» Decimal
Upper	1
Upper Value	(1)
Visibility	Public

when

Public «IVL_TS» TimeInterval when

"Indicates the period of time or age range of the subject to which the specified probability applies." - HL7 FHIR, RiskAssessment.prediction.when
Note that the FHIR datatype can be a Period or Range; FHIM currently models this as a TimeInterval.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Prediction
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	when
Name Expression
Namespace	Prediction
Opposite
Owner	Prediction
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::Prediction::when
Stereotype
Template Parameter
Type	«IVL_TS» TimeInterval
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Common UML Documentation

Summary:AttributesProperties

Detail:Attributes