| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
"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 |
"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 |
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 |
"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 |
"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 |
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 |
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 |
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 | ||
chargeToPracticeCode, chargeToPracticeCost, dateAccepted, discontinueDate, expectedAvailabilityDate, fillerOrderId, fillerSupplementalInfo, order, orderModality, precautionProtocolInvoked, priority, promisingOrganization, promisingProvider, scheduledDateTime, status, statusChangeDateTime, statusModifier |
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 | EntryPoint |
Name | LabTestPromise |
Name Expression | |
Namespace | Lab |
Owned Template Signature | |
Owner | Lab |
Owning Template Parameter | |
Package | Lab |
Qualified Name | FHIM::Lab::LabTestPromise |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | labTestPromise_accessionEvent |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | accessionEvent |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::accessionEvent |
Stereotype | |
Template Parameter | |
Type | AccessionEvent |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | labTestPromise_billingProcedureList |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | billingProcedureList |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::billingProcedureList |
Stereotype | |
Template Parameter | |
Type | ProcedureListEntry |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | dateReportCompleted |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::dateReportCompleted |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | labTestPromise_labReferral |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | labReferral |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::labReferral |
Stereotype | |
Template Parameter | |
Type | LabReferral |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | medicalDirector |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::medicalDirector |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | producersReference |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::producersReference |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | labTestPromise_reportableResult |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | reportableResult |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::reportableResult |
Stereotype | |
Template Parameter | |
Type | LaboratoryObservation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | labTestPromise_specimenAssessment |
Association End | |
Class | «EntryPoint» LabTestPromise |
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 | specimenAssessment |
Name Expression | |
Namespace | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::specimenAssessment |
Stereotype | |
Template Parameter | |
Type | SpecimenAssessment |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
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 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 | «EntryPoint» LabTestPromise |
Opposite | |
Owner | «EntryPoint» LabTestPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::LabTestPromise::topicCode |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |