Lab UML Documentation

Element

Lab
Class LabTestRequest

This class contains attributes associated with a record of the investigative procedure requested to be performed in the laboratory. Need to flesh out how to model both Panels and individual tests at the same time. It is not reasonable to expect to be able to standardize panels, but may have to enumerate the tests that make up the panel ordered.

Attributes
«IVL_TS» Period	frequency	An administration schedule for how often the requested observation should be performed.
«IVL_TS» Period	intendedDuration	Contains the time period over which one or more LabTestRequests are to be executed. "Contains the duration for which the service is requested." - HL7 Version 2.8, TQ1-6. "Indicates the earliest date/time at which the services should be started." - HL7 Version 2.8, TQ1-7. "Contain(s) the latest date/time that the service should be performed. If it has not been performed by the specified time, it should not be performed at all." - HL7 Version 2.8, TQ1-8.
String	referralType	If the test was accepted as a referral from another facility, only portions of the test may need to be performed. For example, CHCS lists the following: Procedure Only, Report Only, and Outside Films.
«CS» Code	resultsReleaseCategory	"Contains instructions on whether to share the results with the patient, and if so how." - HL7 Version 2.8, OBX-26. Possible values include (from HL7 Table 909): Share To Be Determined: Category to be determined; Share Immediately: Share result with patient immediately; Share Within Normal Limits: Share result in reference/therapeutic range with patient immediately, Share result out of reference/therapeutic ranges with patient after 1 or more business day as agreed to by the systems in play; Share In 1 Day: Share result regardless of reference/therapeutic range after 1 or more business day as agreed to by the systems in play; Share in 1 Day Conditionally: Share result in reference ranges/therapeutic with patient after 1 or more business day as agreed to by the systems in play, Withhold result out of reference/therapeutic range until physician release; Share Withhold: Withhold result regardless of reference/therapeutic ranges.
«CS» Code	specimenActionCode	"Identifies the action to be taken with respect to the specimens that accompany or precede this order." - HL7 Version 2.8, OBR-11. Possible values include (from HL7 Table 65): Add ordered tests to the existing specimen; Generated order - reflex order; Lab to obtain specimen from patient; Specimen obtained by service other than Lab; Pending specimen - Order sent prior to delivery; Revised order; Schedule the tests specified below.
«CS» Code	topicCode	This property exists to show that the Lab Test that has been ordered 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::Order
advanceBeneficiaryNoticeCode, advanceBeneficiaryNoticeDate, advanceBeneficiaryNoticeOverrideReason, alternatePlacerOrderId, basedOn, billingInformation, callbackPhone, confidentialityCode, dangerCode, dateTimeBegin, dateTimeCompleted, dateTimeEnd, dateTimeNeeded, dateTimeOrdered, diagnosisList, doNotPerform, duplicateProcedureReason, enteringLocation, expectedPerformer, expectedPerformerType, isEscortRequired, isInpatientOrder, occurrenceTiming, orderAction, orderingFacility, orderingOrganization, orderingProvider, patientInstructions, patientLocation, placerOrderId, placerSupplementalInfo, plannedPatientTransportComment, precautionProtocolInvoked, priority, promise, reasonForStudy, releaseStatus, relevantClinicalInformation, resultCopiesTo, resultHandling, setOfOrders, standingOrder, status, statusModifier, suggestedPrecaution, transportationArrangementResponsibility, transportationMode, wasTransportArranged

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

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	false
Is Active	false
Is Leaf	false
Keywords
Name	LabTestRequest
Name Expression
Namespace	Lab
Owned Template Signature
Owner	Lab
Owning Template Parameter
Package	Lab
Qualified Name	FHIM::Lab::LabTestRequest
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

frequency

Public «IVL_TS» Period frequency

An administration schedule for how often the requested observation should be performed.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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	frequency
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::frequency
Stereotype
Template Parameter
Type	«IVL_TS» Period
Upper	1
Upper Value	(1)
Visibility	Public

intendedDuration

Public «IVL_TS» Period intendedDuration

Contains the time period over which one or more LabTestRequests are to be executed.
"Contains the duration for which the service is requested." - HL7 Version 2.8, TQ1-6.
"Indicates the earliest date/time at which the services should be started." - HL7 Version 2.8, TQ1-7.
"Contain(s) the latest date/time that the service should be performed. If it has not been performed by the specified time, it should not be performed at all." - HL7 Version 2.8, TQ1-8.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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	intendedDuration
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::intendedDuration
Stereotype
Template Parameter
Type	«IVL_TS» Period
Upper	1
Upper Value	(1)
Visibility	Public

referralType

Public String referralType

If the test was accepted as a referral from another facility, only portions of the test may need to be performed. For example, CHCS lists the following: Procedure Only, Report Only, and Outside Films.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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	referralType
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::referralType
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

resultsReleaseCategory

Public «CS» Code resultsReleaseCategory

"Contains instructions on whether to share the results with the patient, and if so how." - HL7 Version 2.8, OBX-26.
Possible values include (from HL7 Table 909): Share To Be Determined: Category to be determined; Share Immediately: Share result with patient immediately; Share Within Normal Limits: Share result in reference/therapeutic range with patient immediately, Share result out of reference/therapeutic ranges with patient after 1 or more business day as agreed to by the systems in play; Share In 1 Day: Share result regardless of reference/therapeutic range after 1 or more business day as agreed to by the systems in play; Share in 1 Day Conditionally: Share result in reference ranges/therapeutic with patient after 1 or more business day as agreed to by the systems in play, Withhold result out of reference/therapeutic range until physician release; Share Withhold: Withhold result regardless of reference/therapeutic ranges.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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	resultsReleaseCategory
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::resultsReleaseCategory
Stereotype
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

specimenActionCode

Public «CS» Code specimenActionCode

"Identifies the action to be taken with respect to the specimens that accompany or precede this order." - HL7 Version 2.8, OBR-11. Possible values include (from HL7 Table 65): Add ordered tests to the existing specimen; Generated order - reflex order; Lab to obtain specimen from patient; Specimen obtained by service other than Lab; Pending specimen - Order sent prior to delivery; Revised order; Schedule the tests specified below.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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	specimenActionCode
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::specimenActionCode
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

topicCode

Public «CS» Code topicCode

This property exists to show that the Lab Test that has been ordered 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:

Aggregation	None
Alias
Association
Association End
Class	LabTestRequest
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 Composite	false
Is Derived	true
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	topicCode
Name Expression
Namespace	LabTestRequest
Opposite
Owner	LabTestRequest
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Lab::LabTestRequest::topicCode
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Lab UML Documentation

Summary:AttributesProperties

Detail:Attributes