Lab
Class LaboratoryObservation
This class represents a test result or observation that may be reported. Some tests, such as an microbiology identification may have multiple results reported over time, for example a preliminary gram stain result might be initially reported, followed by the identification and relative number of organisms, followed by an antibiotic senstivity test results. Each one of these results would manifest as a separate instance of this class, each with their own date/times, performers, etc."The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a report." - HL7 Version 2.8, OBX
| Attributes |
| «TS» PointInTime |  dateDeemedReportable |
"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.
|
| «TS» PointInTime | dateTimeOfAnalysis |
"The time stamp associated with generation of the analytical result by the instrument specified in [the deviceInstance]" - HL7 Version 2.8, OBX.19
|
| PractitionerParticipation | laboratoryDirector |
This is the director of the laboratory that is reporting the result to the Orderer. This person may or may not be the director of the organization that actually performed the analysis, rather of the reporting organization.
|
| «REAL» Decimal | probability |
"Contains the probability of a result being true for results with categorical values. It mainly applies to discrete coded results. It is a decimal number ... between 0 and 1, inclusive." - HL7 Version 2.8, OBX-9.
|
| «TS» PointInTime | reportDate |
"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.
|
| «CS» Code | reReleaseReason |
"Indicates the root cause for the reissue of a previously released lab report. This element is used in conjunction with OBX-11 Observation Result Status to define the root cause for a reissued laboratory report in the case of a corrected, amended, appended, or revised report." - HL7 Version 2.8, OBX-27.
|
| String | subId |
"This field is used to distinguish between multiple OBX segments with the same observation ID organized under one OBR." - HL7 Version 2.8, OBX-4.
|
| «CS» Code | topicCode |
This property exists to show that the Lab Test that has been observed (aka resulted) is handled using the topicCode property inherited from ClinicalStatement. This property is marked as derived in that it will generally not be implemented, or if it is, it would be re-defined such that the allowable set of values that this property can reference is limited to Lab observations. Generally these will be LOINC codes, but will be a SNOMED code in the case of microbe identification. Note that VA's VistA system uses the VA National Laboratory Test code via File 64."Contains a unique identifier for the observation.... In most systems the identifier will point to a master observation table that will provide other attributes of the observation that may be used by the receiving system to process the observations it receives". - HL7 Version 2.8, OBX-3.
|
| Attribution | transcription |
If the laboratory observation report was dictated, this property identifies the person who converted the spoken words into written form.
|
| String | userDefinedAccessCheck |
"This field permits the producer to record results-dependent codes for classifying the observation at the receiving system. This field should be needed only rarely..." - HL7 Version 2.8, OBX-13.
|
Attributes inherited from  FHIM::ClinicalObservation::ObservationStatement |
| basedOn, bodySite, category, componentObservation, dataAbsentReason, dateTime, dateTimeIssued, deltaFlag, description, deviceInstance, evaluationProcedure, exceptionValue, interpretationEvent, method, multimedia, observed, observedCharacteristic, referenceRange, reliability, resultStatus, specimen, value, derivedFrom, hasMember, partOf |
| Attributes inherited from FHIM::Common::ClinicalStatement |
| clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
| Attributes inherited from FHIM::Common::InformationEntry |
| identifier |
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | true |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | LaboratoryObservation |
| Name Expression | |
| Namespace | Lab |
| Owned Template Signature | |
| Owner | Lab |
| Owning Template Parameter | |
| Package | Lab |
| Qualified Name | FHIM::Lab::LaboratoryObservation |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
dateDeemedReportable
Public «TS» PointInTime dateDeemedReportable
-
"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | 1 |
| Lower Value | (1) |
| Multiplicity | 1 |
| Name | dateDeemedReportable |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::dateDeemedReportable |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
dateTimeOfAnalysis
Public «TS» PointInTime dateTimeOfAnalysis
-
"The time stamp associated with generation of the analytical result by the instrument specified in [the deviceInstance]" - HL7 Version 2.8, OBX.19
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | false |
| Keywords | |
| Lower | 1 |
| Lower Value | (1) |
| Multiplicity | 1 |
| Name | dateTimeOfAnalysis |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::dateTimeOfAnalysis |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
laboratoryDirector
Public PractitionerParticipation laboratoryDirector
-
This is the director of the laboratory that is reporting the result to the Orderer. This person may or may not be the director of the organization that actually performed the analysis, rather of the reporting organization.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | laboratoryDirector |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::laboratoryDirector |
| Stereotype | |
| Template Parameter | |
| Type | PractitionerParticipation |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
probability
Public «REAL» Decimal probability
-
"Contains the probability of a result being true for results with categorical values. It mainly applies to discrete coded results. It is a decimal number ... between 0 and 1, inclusive." - HL7 Version 2.8, OBX-9.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | probability |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::probability |
| Stereotype | |
| Template Parameter | |
| Type | «REAL» Decimal |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
reportDate
Public «TS» PointInTime reportDate
-
"Specifies the date/time when the results were reported or status changed. This conditional field is required whenever [Report Status] is valued. This field is used to indicate the date and time that the results are composed into a report and released, or that [Healthcare Order status] is entered or changed." - HL7 Version 2.8, OBR-22.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | 1 |
| Lower Value | (1) |
| Multiplicity | 1 |
| Name | reportDate |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::reportDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
reReleaseReason
Public «CS» Code reReleaseReason
-
"Indicates the root cause for the reissue of a previously released lab report. This element is used in conjunction with OBX-11 Observation Result Status to define the root cause for a reissued laboratory report in the case of a corrected, amended, appended, or revised report." - HL7 Version 2.8, OBX-27.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | reReleaseReason |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::reReleaseReason |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
subId
Public String subId
-
"This field is used to distinguish between multiple OBX segments with the same observation ID organized under one OBR." - HL7 Version 2.8, OBX-4.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | subId |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::subId |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
topicCode
Public «CS» Code topicCode
-
This property exists to show that the Lab Test that has been observed (aka resulted) is handled using the topicCode property inherited from ClinicalStatement. This property is marked as derived in that it will generally not be implemented, or if it is, it would be re-defined such that the allowable set of values that this property can reference is limited to Lab observations. Generally these will be LOINC codes, but will be a SNOMED code in the case of microbe identification. Note that VA's VistA system uses the VA National Laboratory Test code via File 64."Contains a unique identifier for the observation.... In most systems the identifier will point to a master observation table that will provide other attributes of the observation that may be used by the receiving system to process the observations it receives". - HL7 Version 2.8, OBX-3.
-
Constraints:
-
Properties:
-
transcription
Public Attribution transcription
-
If the laboratory observation report was dictated, this property identifies the person who converted the spoken words into written form.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | transcription |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::transcription |
| Stereotype | |
| Template Parameter | |
| Type | Attribution |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
userDefinedAccessCheck
Public String userDefinedAccessCheck
-
"This field permits the producer to record results-dependent codes for classifying the observation at the receiving system. This field should be needed only rarely..." - HL7 Version 2.8, OBX-13.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LaboratoryObservation |
| 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 | userDefinedAccessCheck |
| Name Expression | |
| Namespace | LaboratoryObservation |
| Opposite | |
| Owner | LaboratoryObservation |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::LaboratoryObservation::userDefinedAccessCheck |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |