| ClinicalObservation UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
Indicates the criteron by which the reference range is valid. Different reference ranges may be defined based on the subject's age, race, sex, etc."When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common." - HL7 Version 2.8, OBX-7"Guidance on how to interpret the value by comparison to a normal or recommended range." - HL7 FHIR, Observation.referenceRange
Attributes | ||
ageRange |
"The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so." - HL7 FHIR, Observation.referenceRange.age |
|
«CS» Code | appliesTo |
Reference ranges may be different for specific populations of individuals, based on some other determinant trait held by those individuals. For example, total serum iron concentrations normally differ in males versus females. Males and post-menopausal females share the same reference range for the normal concentration of Ferritin, but the reference range for pre-menopausal females normally has a lower upper limit. Similarly, Prostate Specific Antigen levels are normally lower in Asian men than in Caucasian men. In addition, some reference ranges may differ depending on the time of day the sample was drawn. For example, Cortisol levels are normally higher in the morning than they are at night. This property therefore indicates the determinant that distinguishes this reference range instance from other reference range instances. In other words, it contains (codes conveying) male, female, pre-menopausal female, post-menopausal female, Caucasian, Asian, African, etc."Contains the nature of the abnormal test.... As many of the codes as apply may be included" - HL7 Version 2.8, OBX-10. Possible values (from HL7 Table 80) include: An age-based population; None - generic normal range; A race-based population; A sex-based population; Species; Breed; Strain."Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race." - HL7 FHIR, Observation.referenceRange.appliesTo |
String | criterionDescription |
Describes the criteron by which the reference range is valid. Different reference ranges may be defined based on the subject's age, race, sex, etc. This property is a human-readable label for the criterion, it is not necessarily computable. Examples include 40-50 years old, Female, etc. |
«TS» PointInTime | effectiveDate |
"Contains the date (and, optionally, the time) on which the values in OBX-7-reference range went into effect...." - HL7 Version 2.8, OBX-12. Note that we may wish change this to a date range in the future. |
«PQ» Quantity | high |
The upper bound of the range of normal values determined for a particular kind of observation. For toxicology, this range is the theraputic range."When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common." - HL7 Version 2.8, OBX-7."The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3)." - HL7 FHIR, Observation.referenceRange.high |
«CS» Code | kind |
Specifies the type of Reference Range to which this criterion belongs. For example, there are normal reference ranges, therapeutic ranges, etc."Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range." Possible values are: Normal Range; Recommended Range; Treatment Range; Therapeutic Desired Level; Pre Therapeutic Desired Level; Post Therapeutic Desired Level; Endocrine; Pre-Puberty; Follicular Stage; MidCycle; Luteal; Post-Menopause. - HL7 FHIR, Observation.referenceRange.type |
«PQ» Quantity | low |
The lower bound of the range of normal values determined for a particular kind of observation. For toxicology, this range is the theraputic range."When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common." - HL7 Version 2.8, OBX-7."The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3)." - HL7 FHIR, Observation.referenceRange.low |
String | text |
"Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of normal values." - HL7 FHIR, Observation.referenceRange.text. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ReferenceRange |
Name Expression | |
Namespace | ClinicalObservation |
Owned Template Signature | |
Owner | ClinicalObservation |
Owning Template Parameter | |
Package | ClinicalObservation |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public ageRange
"The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so." - HL7 FHIR, Observation.referenceRange.age
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | ageRange |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::ageRange |
Stereotype | |
Template Parameter | |
Type | |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code appliesTo
Reference ranges may be different for specific populations of individuals, based on some other determinant trait held by those individuals. For example, total serum iron concentrations normally differ in males versus females. Males and post-menopausal females share the same reference range for the normal concentration of Ferritin, but the reference range for pre-menopausal females normally has a lower upper limit. Similarly, Prostate Specific Antigen levels are normally lower in Asian men than in Caucasian men. In addition, some reference ranges may differ depending on the time of day the sample was drawn. For example, Cortisol levels are normally higher in the morning than they are at night. This property therefore indicates the determinant that distinguishes this reference range instance from other reference range instances. In other words, it contains (codes conveying) male, female, pre-menopausal female, post-menopausal female, Caucasian, Asian, African, etc."Contains the nature of the abnormal test.... As many of the codes as apply may be included" - HL7 Version 2.8, OBX-10. Possible values (from HL7 Table 80) include: An age-based population; None - generic normal range; A race-based population; A sex-based population; Species; Breed; Strain."Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race." - HL7 FHIR, Observation.referenceRange.appliesTo
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
Terminologies | [ HL7_FHIR_R4 Observation Reference Range Applies To Codes http://hl7.org/fhir/ValueSet/referencerange-appliesto ] |
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 | * |
Name | appliesTo |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::appliesTo |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String criterionDescription
Describes the criteron by which the reference range is valid. Different reference ranges may be defined based on the subject's age, race, sex, etc. This property is a human-readable label for the criterion, it is not necessarily computable. Examples include 40-50 years old, Female, etc.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | criterionDescription |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::criterionDescription |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime effectiveDate
"Contains the date (and, optionally, the time) on which the values in OBX-7-reference range went into effect...." - HL7 Version 2.8, OBX-12. Note that we may wish change this to a date range in the future.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | effectiveDate |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::effectiveDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» Quantity high
The upper bound of the range of normal values determined for a particular kind of observation. For toxicology, this range is the theraputic range."When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common." - HL7 Version 2.8, OBX-7."The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3)." - HL7 FHIR, Observation.referenceRange.high
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | high |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::high |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code kind
Specifies the type of Reference Range to which this criterion belongs. For example, there are normal reference ranges, therapeutic ranges, etc."Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range." Possible values are: Normal Range; Recommended Range; Treatment Range; Therapeutic Desired Level; Pre Therapeutic Desired Level; Post Therapeutic Desired Level; Endocrine; Pre-Puberty; Follicular Stage; MidCycle; Luteal; Post-Menopause. - HL7 FHIR, Observation.referenceRange.type
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
Terminologies | [ HL7_FHIR_R4 Observation Reference Range Meaning Codes http://hl7.org/fhir/ValueSet/referencerange-meaning ] |
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 | kind |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::kind |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» Quantity low
The lower bound of the range of normal values determined for a particular kind of observation. For toxicology, this range is the theraputic range."When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common." - HL7 Version 2.8, OBX-7."The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3)." - HL7 FHIR, Observation.referenceRange.low
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | low |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::low |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String text
"Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of normal values." - HL7 FHIR, Observation.referenceRange.text.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ReferenceRange |
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 | text |
Name Expression | |
Namespace | ReferenceRange |
Opposite | |
Owner | ReferenceRange |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalObservation::ReferenceRange::text |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| ClinicalObservation UML Documentation |
Summary:AttributesProperties | Detail:Attributes |