Order Catalog Implementation Guide
current - CI Build

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

LabChargeItemDefinition Profile

Profile of ChargeItemDefinition representing the definition of a billing code and its detailed properties and rules of applicability for a lab service

CatalogHeader Profile

Profile of Composition representing the global properties of a catalog of healthcare items (products, services, knowledge artifacts)

LabServiceDefinition Profile

Profile of PlanDefinition representing the definition of a laboratory diagnostic service viewable and usable by potential consumers (clinicians, nurses, patients …)

LabProcedureDefinition Profile

Profile of ActivityDefinition representing the definition of a laboratory operational procedure

LabSpecimenDefinition Profile

Profile of SpecimenDefinition representing the definition of an IVD specimen used by a laboratory operational procedure

InputObservationDefinition Profile

Profile of ObservationDefinition representing the definition of an observation expected from the orderer by the performing laboratory for use in one of its procedures

LabObservationDefinition Profile

Profile of ObservationDefinition representing the definition of an observation outcome of a laboratory procedure, to be returned to the orderer of the service

CatalogMessageDefinition Profile

Profile of MessageDefinition for sending content of a catalog

ItemTransactionRequest Profile

Profile of Bundle for updating the content of a catalog in transaction mode

ItemTransactionResponse Profile

Profile of Bundle conveying the response to a transaction request for administering catalog content

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

ValidityPeriod Extension

Extension adding catalog validity period to the CatalogHeader profile of Composition

CatalogReference Extension

Extension adding catalog reference to the LabServiceDefinition profile of PlanDefinition

BillingSummary Extension

Extension adding a billing summary to the LabServiceDefinition profile of PlanDefinition

ScheduleSummary Extension

Extension adding a service schedule summary to the LabServiceDefinition profile of PlanDefinition

LimitationSummary Extension

Extension adding a service limitation summary to the LabServiceDefinition profile of PlanDefinition

RegulatorySummary Extension

Extension adding a textual summary of regulations applicable to the LabServiceDefinition profile of PlanDefinition

ResultInterpretationSummary Extension

Extension adding a markdown summary of result interpretation guidance applicable to the LabServiceDefinition profile of PlanDefinition

ServiceBillingCode Extension

Extension adding a service billing code (and possibly associated billing rules) to the LabServiceDefinition profile of PlanDefinition

SpecimenRequested Extension

Extension attaching specimen requested to a PlanDefinition.action, as a set of (possibly choosable) references to SpecimenDefiniton

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Laboratory service types ValueSet

Value set for types of laboratory service in the LabServiceDefinition profile of PlanDefinition

Laboratory service reimbursability categories ValueSet

ValueSet providing coarse categories of reimbursement dispositions for laboratory services

Bibliographic artifact ValueSet

Restrained value set for types of bibliographic artifact in the LabServiceDefinition profile of PlanDefinition

Order catalog message events ValueSet

ValueSet providing event codes for MessageHeader.eventCoding in FHIR messages conveying catalog content

Lab normal clinical focus for billing vitamin D

Lab E6 - value set of normal contexts enabling billing of Vitamin D test

Possible contexts for any lab test order

Contexts possibly associated with any laboratory test

Valid coded reasons for ordering a lab service

Lab E* - broadest value set of reasons for ordering a laboratory service

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Laboratory service types CodeSystem

Code system for types of laboratory service

Laboratory service reimbursability categories CodeSystem

Code system providing coarse categories of reimbursement dispositions for laboratory services

Catalog message events CodeSystem

Code system providing event codes for messaging the content of order catalogs

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

A clinical laboratory catalog

Lab E* - Catalog header representing a clinical laboratory compendium, used by all lab examples in this implementation guide

Lab service serum K

Lab E1 - simple test laboratory service - serum K

Lab service blood electrolyte

Lab E2 - panel laboratory service - electrolyte on blood or plasma

Lab service 24H urine creat

Lab E3, E5 - panel laboratory service - creatinine on 24-hour urine specimen

Lab service serum creat

Lab E4, E5 - panel laboratory service - creatinine on serum or plasma specimen

Lab service creat renal clearance

Lab E5 - panel laboratory service - creatinine renal clearance using 24-hour urine specimen and serum or plasma specimen

Lab service vitamin D

Lab E6 - simple test laboratory service - vitamin D (in French)

Lab service HSV 2 IgM titer

Lab E7 - simple test laboratory service - serum HSV 2 IgM titer

Lab service HSV 1 IgM titer

Lab E7 - simple test laboratory service - serum HSV 1 IgM titer

Lab service HSV IgM

Lab E7 - panel laboratory service - serum HSV 1 & 2 IgM screen panel + reflex titer

Lab service CMV IgM

Lab E7 - test laboratory service - serum CMV IgM test

Lab service Rubella IgM

Lab E7 - test laboratory service - serum Rubella IgM test

Lab service Toxoplasma gondii Antibody

Lab E7 - panel laboratory service - serum Toxoplasma gondii Antibody panel

Lab service TORCH panel

Lab E7 - panel laboratory service - serum TORCH panel

Lab procedure 24H urine creat

Lab E3, E5 - panel laboratory procedure - 24-hour urine creatinine

Lab procedure serum creatinine

Lab E4, E5 - laboratory procedure - creatinine - on serum or plasma

Lab procedure serum K

Lab E1 - simple test laboratory procedure - serum K

Lab procedure blood electrolyte

Lab E2 - panel laboratory procedure - electrolyte on serum or plasma

Lab procedure creat renal clearance

Lab E5 - laboratory procedure carrying a single observation - creatinine renal clearance

Lab procedure vitamin D

Lab E6 - simple test laboratory procedure - vitamin D (in French)

Lab procedure Toxoplasma gondii

Lab E7 - laboratory procedure - Toxoplasma gondii serology

Lab procedure Rubella IgM

Lab E7 - laboratory procedure - Rubella serology

Lab procedure CMV IgM

Lab E7 - laboratory procedure - CMV IgM

Lab procedure HSV serology

Lab E7 - laboratory procedure - HSV 1 & 2 IgM

Lab procedure HSV 1 IgM titer

Lab E7 - laboratory procedure - HSV 1 IgM titer

Lab procedure HSV 2 IgM titer

Lab E7 - laboratory procedure - HSV 2 IgM titer

Lab specimen - venous serum 1 test

Lab E1, E4, E5, E6 - venous serum specimen requirement for a single chemistry test

Lab specimen - capillary serum 1 test

Lab E4, E5 - capillary serum specimen requirement for a single chemistry test

Lab specimen - serum/plasma

Lab E2: serum/plasma specimen

Lab specimen - 24H urine

Lab E3: 24H urine specimen

Lab specimen - venous serum 3 mL

Lab E7 - 3 mL serum specimen

Lab specimen - venous serum 2 mL

Lab E7 - 2 mL serum specimen

Lab input observation - reason

Lab E1, E2: observation reason for test

Lab input observation - vitamin d

Lab E6: observation clinical context for vitamin D test

Lab observation serum Na

Lab E2: observation Na/serum

Lab observation serum K

Lab E1, E2: observation K/serum

Lab observation serum Cl

Lab E2 - definition of output observation Cl on serum

Lab observation collection duration

Lab E3 - definition of input/output observation urine collection duration

Lab observation urine volume

Lab E3 - definition of input/output observation 24-hour urine collection volume

Lab observation urine creat

Lab E3 - definition of lab observation 24-hour urine creatinine

Lab observation serum/plasma creat

Lab E4 - definition of lab observation serum/plasma creatinine

Lab observation creat renal clearance

Lab E5 - definition of lab observation - creatinine renal clearance in 24 hour urine and serum or plasma

Lab observation vitamin D

Lab E6: observation vitamin D on blood serum (in French)

Lab observation HSV 2 IgM titer

Lab E7: observation HSV 2 IgM titer on serum

Lab observation HSV 1 IgM titer

Lab E7: observation HSV 1 IgM titer on serum

Lab observation HSV 2 IgM presence

Lab E7: observation HSV 2 IgM presence detection on serum

Lab observation HSV 1 IgM presence

Lab E7: observation HSV 1 IgM presence detection on serum

Lab observation Rubella IgM

Lab E7: observation Rubella IgM on serum

Lab observation CMV IgM

Lab E7: observation CMV IgM on serum

Lab observation Toxoplasma IgM

Lab E7: observation Toxoplasma IgM on serum

Lab observation Toxoplasma IgG

Lab E7: observation Toxoplasma IgG on serum

Lab observation Toxoplasma Ab interpretation

Lab E7: observation Toxoplasma Ab interpretation

Lab billing code and rule for vitamin D

Lab E6 - definition of charge item for laboratory service Vitamin D

Message definition for messaging a new catalog

MessageDefinition for messages conveying a new catalog to the receiver

Message definition for messaging a catalog update

MessageDefinition for messages conveying an update to the receiver’s catalog

Create test in laboratory compendium

Lab E8 - transaction Bundle posted for creation of a test and its supporting resources into a laboratory compendium

Test created in laboratory compendium

Lab E8 - transaction-response Bundle returned after creation of a test and its supporting resources into a laboratory compendium

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories

Laboratory Organization

Lab E* - a fake laboratory Organization resource used by all laboratory examples of this implementation guide