Lab
Class LabTestPromise

This class represents an intent to perform one or more Laboratory Tests in response to a Request (an Order) from an authorized entity (usually a doctor). A Promise is an intent to perform a service that has the strength of a commitment, i.e., other parties may rely on the originator of such promise that said originator will see to it that the promised act will be fulfilled. A promise can be either solicited or unsolicited. The entity that makes such a promise is also called a "filler", while the entity that requests the service is also called a "placer". The Laboratory Test Promise can be looked at as the Laboratory Test Order from the laboratory's point of view.

Attributes
AccessionEvent accessionEvent accessionEvent

This property points to the record of the laboratory's accepting a laboratory test and entering the test into the laboratory's workload.

ProcedureListEntry billingProcedureList billingProcedureList

"Contains a unique identifier assigned to the procedure, if any, associated with the charge." - HL7 Version 2.8, OBR-44.
"Contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable.... Multiple modifiers may be reported...." - HL7 Version 2.8, OBR-45.

«TS» PointInTime dateReportCompleted dateReportCompleted

"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.

LabReferral labReferral labReferral

An order placed by a laboratory to another laboratory to perform a test that the originating laboratory had taken on. This action typically occurs when the originating laboratory cannot perform the requested test in-house.

PractitionerParticipation medicalDirector medicalDirector

"Contains the medical director of the organization/service responsible for performing the service. For labs, this field specifies the medical director of the laboratory that produced the test result described in this OBX segment. This field is different than OBX-16 in that OBX-16 identifies the individual who performed the lab test (made the observation) whereas this field identifies the individual who is the medical director of the organization responsible for the result. It should be reported explicitly when the test results are produced at outside laboratories, for example. This information supports CLIA regulations in the US." - HL7 Version 2.8, OBX-25.

String producersReference producersReference

"Contains a unique identifier of the responsible producing service. It should be reported explicitly when the test results are produced at outside laboratories, for example. When this field is null, the receiving system assumes that the observations were produced by the sending organization. This information supports CLIA regulations in the US...." - HL7 Version 2.8, OBX-15.

LaboratoryObservation reportableResult reportableResult

This property points to the set (zero to many) of test results or observations that were generated as a result of the laboratory tests performed. Note that the word Reportable is used to indicate that these Results are limited to those which have reached the point where they are deemed to be reportable or releasable. The result may or may not have been part of an actual report, as it might be on hold waiting for other results to be combined with it. A result that has not yet been approved by the appropriate personnel does not meet the criteria of being reportable, and therefore will not be available through this stucture.

SpecimenAssessment specimenAssessment specimenAssessment

Contains observations regarding the Specimen. Such observations, or assessments, of the Specimen are performed by the laboratory upon initial receipt, although periodic assessments may be performed later, especially when the Specimen is in long-term storage, or when some change in custody has occurred. The assessment also contains information concerning the handling of the Specimen, such as storage or transportation information.

«CS» Code topicCode topicCode

This property exists to show that the Lab Test that has been promised (aka accessioned) 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 orderable Lab Tests.

"This field contains the identifier code for the requested observation/test/battery." - HL7 Version 2.8, OBR-4

Attributes inherited from FHIM::Orders::Promise FHIM::Orders::Promise
chargeToPracticeCode chargeToPracticeCode, chargeToPracticeCost chargeToPracticeCost, dateAccepted dateAccepted, discontinueDate discontinueDate, expectedAvailabilityDate expectedAvailabilityDate, fillerOrderId fillerOrderId, fillerSupplementalInfo fillerSupplementalInfo, order order, orderModality orderModality, precautionProtocolInvoked precautionProtocolInvoked, priority priority, promisingOrganization promisingOrganization, promisingProvider promisingProvider, scheduledDateTime scheduledDateTime, status status, statusChangeDateTime statusChangeDateTime, statusModifier statusModifier

Attributes inherited from FHIM::Common::ActionStatement FHIM::Common::ActionStatement
category category, currentStatus currentStatus, description description, indication indication, inputFinding inputFinding, instantiatesCanonical instantiatesCanonical, instantiatesUri instantiatesUri, insurance insurance, intent intent, justification justification, location location, method method, outputFinding outputFinding, precondition precondition, reasonCode reasonCode, reasonNarrative reasonNarrative, reasonReference reasonReference, relevantHistory relevantHistory, scope scope, supportingInformation supportingInformation, usingDevice usingDevice, wasReported wasReported

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsEntryPoint
NameLabTestPromise
Name Expression
NamespaceLab
Owned Template Signature
OwnerLab
Owning Template Parameter
PackageLab
Qualified NameFHIM::Lab::LabTestPromise
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 accessionEvent
Public AccessionEvent accessionEvent

This property points to the record of the laboratory's accepting a laboratory test and entering the test into the laboratory's workload.

Constraints:
Properties:

AggregationNone
Alias
AssociationlabTestPromise_accessionEvent
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameaccessionEvent
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::accessionEvent
Stereotype
Template Parameter
TypeAccessionEvent
Upper*
Upper Value(*)
VisibilityPublic


 billingProcedureList
Public ProcedureListEntry billingProcedureList

"Contains a unique identifier assigned to the procedure, if any, associated with the charge." - HL7 Version 2.8, OBR-44.
"Contains the procedure code modifier to the procedure code reported in OBR-44-procedure code, when applicable.... Multiple modifiers may be reported...." - HL7 Version 2.8, OBR-45.

Constraints:
Properties:

AggregationNone
Alias
AssociationlabTestPromise_billingProcedureList
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamebillingProcedureList
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::billingProcedureList
Stereotype
Template Parameter
TypeProcedureListEntry
Upper*
Upper Value(*)
VisibilityPublic


 dateReportCompleted
Public «TS» PointInTime dateReportCompleted

"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:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateReportCompleted
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::dateReportCompleted
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 labReferral
Public LabReferral labReferral

An order placed by a laboratory to another laboratory to perform a test that the originating laboratory had taken on. This action typically occurs when the originating laboratory cannot perform the requested test in-house.

Constraints:
Properties:

AggregationNone
Alias
AssociationlabTestPromise_labReferral
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamelabReferral
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::labReferral
Stereotype
Template Parameter
TypeLabReferral
Upper*
Upper Value(*)
VisibilityPublic


 medicalDirector
Public PractitionerParticipation medicalDirector

"Contains the medical director of the organization/service responsible for performing the service. For labs, this field specifies the medical director of the laboratory that produced the test result described in this OBX segment. This field is different than OBX-16 in that OBX-16 identifies the individual who performed the lab test (made the observation) whereas this field identifies the individual who is the medical director of the organization responsible for the result. It should be reported explicitly when the test results are produced at outside laboratories, for example. This information supports CLIA regulations in the US." - HL7 Version 2.8, OBX-25.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamemedicalDirector
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::medicalDirector
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 producersReference
Public String producersReference

"Contains a unique identifier of the responsible producing service. It should be reported explicitly when the test results are produced at outside laboratories, for example. When this field is null, the receiving system assumes that the observations were produced by the sending organization. This information supports CLIA regulations in the US...." - HL7 Version 2.8, OBX-15.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameproducersReference
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::producersReference
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 reportableResult
Public LaboratoryObservation reportableResult

This property points to the set (zero to many) of test results or observations that were generated as a result of the laboratory tests performed. Note that the word Reportable is used to indicate that these Results are limited to those which have reached the point where they are deemed to be reportable or releasable. The result may or may not have been part of an actual report, as it might be on hold waiting for other results to be combined with it. A result that has not yet been approved by the appropriate personnel does not meet the criteria of being reportable, and therefore will not be available through this stucture.

Constraints:
Properties:

AggregationNone
Alias
AssociationlabTestPromise_reportableResult
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereportableResult
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::reportableResult
Stereotype
Template Parameter
TypeLaboratoryObservation
Upper*
Upper Value(*)
VisibilityPublic


 specimenAssessment
Public SpecimenAssessment specimenAssessment

Contains observations regarding the Specimen. Such observations, or assessments, of the Specimen are performed by the laboratory upon initial receipt, although periodic assessments may be performed later, especially when the Specimen is in long-term storage, or when some change in custody has occurred. The assessment also contains information concerning the handling of the Specimen, such as storage or transportation information.

Constraints:
Properties:

AggregationNone
Alias
AssociationlabTestPromise_specimenAssessment
Association End
Class«EntryPoint» LabTestPromise
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamespecimenAssessment
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::specimenAssessment
Stereotype
Template Parameter
TypeSpecimenAssessment
Upper*
Upper Value(*)
VisibilityPublic


 topicCode
Public «CS» Code topicCode

This property exists to show that the Lab Test that has been promised (aka accessioned) 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 orderable Lab Tests.

"This field contains the identifier code for the requested observation/test/battery." - HL7 Version 2.8, OBR-4

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» LabTestPromise
Terminologies[
C-CDA_2.1 LOINC 2.16.840.1.113883.6.1
,
HL7_FHIR_R4 LOINC Codes http://hl7.org/fhir/ValueSet/observation-codes
,
HL7_V2 Ordered Test 2.16.840.1.114222.4.11.1004
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NametopicCode
Name Expression
Namespace«EntryPoint» LabTestPromise
Opposite
Owner«EntryPoint» LabTestPromise
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::LabTestPromise::topicCode
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic