Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: LabServiceDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: LabServiceDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.18

The LabServiceDefinition profile constrains the PlanDefinition resource to represent a laboratory diagnostic service for the clinicians using such services. Clinicians typically order laboratory services and use the results thereof in the course of their delivery of clinical care.

A laboratory diagnostic service is a kind of clinical artifact that falls within the scope of PlanDefinition. It involves preparation of the patient, collection and delivery to the lab of biological/digital specimens , tests and panels performed on these specimens, interpretation of the results by the pathologist, and delivery of the results and diagnostic report back to the ordering clinician and possibly other recipients, including the patient. PlanDefinition conveys the general properties of the lab service. It describes the usage of the service, the contexts and situations in which this service is useful, and may also detail the goals that the laboratory service contributes to, such as screening or diagnostic of a particular pathology, monitoring of a long course treatment …

An instance of PlanDefintion, thus, represents a laboratory service. It references one or more instances of ActivityDefinition, describing the service in terms of laboratory procedures, with their input and output observations. The PlanDefinition also references the instances of SpecimenDefinition representing the kinds of specimens needed to perform the service.

A service may be a panel or super-panel grouping other laboratory services that may also be ordered independently. In that case, the PlanDefinition of the encompassing service references the PlanDefinition resources representing the included services (relatedArtifact, type composed-of).

Reflex tests are represented as sub-actions grouped in a logical group with behavior any, meaning that any number of members of the group may be performed. Each sub-action is associated with a trigger conveying the named event, which reflexes it.

A definition of a laboratory diagnostic service conforming to this profile can be used in a laboratory compendium/catalog as well as in other contexts.

A laboratory service is fulfilled through the execution of one or more laboratory procedures. The logical combinations of these procedures may be conjunctions (execute each of them) or disjunctions (execute at most one of them), or a mixture of both logical structures. The closest resource that may represent a service as a set of activities logically combined with this flexibility is PlanDefinition. PlanDefinition is therefore selected to represent a laboratory service, and the laboratory procedures needed to achieve this service are represented by instances of ActivityDefinition referenced by PlanDefinition, from logical groups defined in PlanDefinition.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..* PlanDefinition The definition of a plan for a series of actions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:CatalogReference 0..* Reference(Catalog Header) Reference to a catalog exposing this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference
.... extension:ServiceBillingCode 0..* CodeableConcept A billing code associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode
.... extension:BillingSummary 0..1 (Complex) Textual summary of billing applied to the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary
.... extension:ScheduleSummary 0..1 string Textual summary of the schedule of the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary
.... extension:LimitationSummary 0..1 string Textual summary of limitations associated with the service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary
.... extension:RegulatorySummary 0..1 string Textual summary of regulations applicable to this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/RegulatorySummary
.... extension:ResultInterpretationSummary 0..1 markdown markdown summary of result interpretation guidance for this service
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ResultInterpretationSummary
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherTitle 0..* (Complex) Synonym in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
... type S 0..1 CodeableConcept panel | test
Binding: Types of diagnostic services performed by a laboratory (extensible)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:OtherDescription 0..* (Complex) Translation in a specified language
URL: http://hl7.org/fhir/StructureDefinition/translation
... Slices for useContext S 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code, type:value, pattern:value
.... useContext:Orderable S 0..1 UsageContext Service is orderable
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABOE
.... useContext:PathologistInitiative 0..1 UsageContext Service may be added by pathologist
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LABRREV
.... useContext:OneGender 0..1 UsageContext service restricted to one gender
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: gender
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: AdministrativeGender (required)
.... useContext:StoreSpecimen 0..1 UsageContext Specimens to be kept
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: task
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: STORE
.... useContext:AgeRange 0..* UsageContext A patient age range applicable for this service
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: age
..... value[x] 1..1 Range patient age range applicable for this service
... usage S 0..1 markdown Describes the clinical usage of the laboratory diagnostic service
... topic S 0..* CodeableConcept categorization of the laboratory service
... Slices for relatedArtifact S 0..* RelatedArtifact Additional documentation, citations
Slice: Unordered, Open by value:type
.... relatedArtifact:InputDocumentExpected 0..* RelatedArtifact Input document expected by the laboratory service
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: depends-on
..... label 1..1 string Name of the kind of document expected
..... display 1..1 string Brief description of the related artifact
..... document 0..1 Attachment Document model
...... url 0..1 url url of the model of document expected
...... title 0..1 string Title of the kind or model of document
.... relatedArtifact:IsReplacedBy 0..* RelatedArtifact Reference to a service replacing the current non-usable one
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: successor
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Includes 0..* RelatedArtifact Reference to a panel or test included by the current one
..... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: composed-of
..... resource 1..1 canonical(Laboratory Service Definition) What artifact is being referenced
.... relatedArtifact:Bibliography 0..* RelatedArtifact Additional documentation, citation or justification
..... type 1..1 code documentation | justification | citation
Binding: Types of bibliographic artifacts (required)
... action 1..1 BackboneElement Action defined by the plan
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:SpecimenRequested 0..* (Complex) Specimens required for this action
URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested
.... description 0..1 markdown Brief description of the laboratory service and its method
.... priority 0..1 code routine | urgent | asap | stat
.... code S 0..1 CodeableConcept Code of the laboratory service
..... Slices for coding 0..* Coding Code for the laboratory service
Slice: Unordered, Open by value:system
...... coding:orderCodeLOINC S 0..1 Coding LOINC code for the laboratory service
....... system S 0..1 uri LOINC code system
Fixed Value: http://loinc.org
.... Slices for trigger S 0..* TriggerDefinition When the action should be triggered
Slice: Unordered, Open by value:type
..... trigger:Reflex 0..* TriggerDefinition Reflex laboratory procedure
...... type 1..1 code named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
...... name 1..1 string Name or URI that identifies the event
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Fixed Value: logical-group
.... definition[x] S 0..1 canonical(Laboratory Procedure Definition) Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.typeextensibleLaboratoryServiceType
http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type
from this IG
PlanDefinition.useContext:OneGender.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
PlanDefinition.relatedArtifact:Bibliography.typerequiredBibliographyArtifactType
http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type
from this IG

 

Other representations of profile: CSV, Excel, Schematron