Order Catalog Implementation Guide
1.0.0 - STU 1

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

## : Lab compendium test created - XML Representation

Raw xml | Download

    <Bundle xmlns="http://hl7.org/fhir">
      <id value="example-lab-test-creation-transaction-response"/>
      <meta>
        <profile
                 value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionResponse"/>
      </meta>
      <type value="transaction-response"/>
      <entry>
        <fullUrl
                 value="https://jade.phast.fr/resources-server/api/FHIR/SpecimenDefinition/QDXSpec3"/>
        <resource>
          <SpecimenDefinition>
            <id value="QDXSpec3"/>
            <meta>
              <versionId value="1"/>
              <lastUpdated value="2020-07-09T09:28:00.392383+02:00"/>
              <profile
                       value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="SpecimenDefinition_QDXSpec3"> </a>
                            <p>Venous blood specimen collected in evacuated blood collection tube, thrombin/clot activator/gel separator tube (dark yellow cap), to be tested as serum - min. vol. 2 mL</p>
                        </div>
            </text>
            <status value="active"/>
            <typeCollected>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="122555007"/>
                <display value="Venous blood specimen"/>
              </coding>
            </typeCollected>
            <patientPreparation>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="263678003"/>
                <display value="At rest"/>
              </coding>
            </patientPreparation>
            <timeAspect value="preferrably morning time"/>
            <typeTested>
              <type>
                <coding>
                  <system value="http://snomed.info/sct"/>
                  <code value="119364003"/>
                  <display value="Serum specimen"/>
                </coding>
              </type>
              <preference value="preferred"/>
              <container>
                <type>
                  <coding>
                    <system value="http://snomed.info/sct"/>
                    <code value="702281005"/>
                    <display
                             value="Evacuated blood collection tube, thrombin/clot activator/gel separator"/>
                  </coding>
                </type>
                <cap>
                  <coding>
                    <system
                            value="http://terminology.hl7.org/CodeSystem/container-cap"/>
                    <code value="dark-yellow"/>
                    <display value="dark yellow cap"/>
                  </coding>
                </cap>
                <minimumVolumeQuantity>
                  <value value="2"/>
                  <unit value="ml"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mL"/>
                </minimumVolumeQuantity>
              </container>
              <handling>
                <temperatureQualifier>
                  <coding>
                    <system
                            value="http://terminology.hl7.org/CodeSystem/handling-condition"/>
                    <code value="room"/>
                    <display value="room temperature"/>
                  </coding>
                  <text value="Ambient temperature"/>
                </temperatureQualifier>
                <temperatureRange>
                  <low>
                    <value value="15"/>
                    <unit value="°C"/>
                    <system value="http://unitsofmeasure.org"/>
                    <code value="Cel"/>
                  </low>
                  <high>
                    <value value="25"/>
                    <unit value="°C"/>
                    <system value="http://unitsofmeasure.org"/>
                    <code value="Cel"/>
                  </high>
                </temperatureRange>
                <maxDuration>
                  <value value="60"/>
                  <unit value="minute"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="min"/>
                </maxDuration>
              </handling>
              <handling>
                <temperatureQualifier>
                  <coding>
                    <system
                            value="http://terminology.hl7.org/CodeSystem/handling-condition"/>
                    <code value="refrigerated"/>
                    <display value="refrigerated"/>
                  </coding>
                </temperatureQualifier>
                <temperatureRange>
                  <low>
                    <value value="2"/>
                    <unit value="°C"/>
                    <system value="http://unitsofmeasure.org"/>
                    <code value="Cel"/>
                  </low>
                  <high>
                    <value value="8"/>
                    <unit value="°C"/>
                    <system value="http://unitsofmeasure.org"/>
                    <code value="Cel"/>
                  </high>
                </temperatureRange>
                <maxDuration>
                  <value value="8"/>
                  <unit value="hour"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="h"/>
                </maxDuration>
              </handling>
            </typeTested>
          </SpecimenDefinition>
        </resource>
        <response>
          <status value="Created"/>
          <location
                    value="https://jade.phast.fr/resources-server/api/FHIR/SpecimenDefinition/QDXFMSpec3/_history/1"/>
          <etag value="W/&quot;1&quot;"/>
        </response>
      </entry>
      <entry>
        <fullUrl
                 value="https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000"/>
        <resource>
          <ObservationDefinition>
            <id value="QDXFM90000000"/>
            <meta>
              <versionId value="1"/>
              <lastUpdated value="2020-07-09T09:28:01.640399+02:00"/>
              <profile
                       value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition"/>
            </meta>
            <language value="en-US"/>
            <text>
              <status value="additional"/>
              <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US"><a name="ObservationDefinition_QDXFM90000000"> </a>
                            <p>Laboratory observation: potassium level in blood</p>
                        </div>
            </text>
            <status value="active"/>
            <category>
              <coding>
                <system
                        value="http://terminology.hl7.org/CodeSystem/observation-category"/>
                <code value="laboratory"/>
                <display value="Laboratory"/>
              </coding>
            </category>
            <code>
              <coding>
                <system value="http://loinc.org"/>
                <code value="2823-3"/>
                <display value="Potassium [Moles/volume] in Serum or Plasma"/>
              </coding>
            </code>
            <permittedDataType value="Quantity"/>
            <permittedDataType value="string"/>
            <multipleResultsAllowed value="false"/>
            <method>
              <text value="Ion Selective Electrode (ISE)"/>
            </method>
            <preferredReportName value="Potassium"/>
            <permittedUnit>
              <system value="http://unitsofmeasure.org"/>
              <code value="mmol/L"/>
            </permittedUnit>
            <permittedUnit>
              <system value="http://unitsofmeasure.org"/>
              <code value="g/L"/>
            </permittedUnit>
            <qualifiedValue>
              <context>
                <coding>
                  <system
                          value="http://terminology.hl7.org/CodeSystem/referencerange-meaning"/>
                  <code value="normal"/>
                  <display value="Normal Range"/>
                </coding>
              </context>
              <age>
                <low>
                  <value value="2"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="a"/>
                </low>
                <high>
                  <value value="19"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="a"/>
                </high>
              </age>
              <rangeCategory value="reference"/>
              <range>
                <low>
                  <value value="3.8"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mmol/L"/>
                </low>
                <high>
                  <value value="5.1"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mmol/L"/>
                </high>
              </range>
            </qualifiedValue>
            <qualifiedValue>
              <context>
                <coding>
                  <system
                          value="http://terminology.hl7.org/CodeSystem/referencerange-meaning"/>
                  <code value="normal"/>
                  <display value="Normal Range"/>
                </coding>
              </context>
              <age>
                <low>
                  <value value="20"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="a"/>
                </low>
              </age>
              <rangeCategory value="reference"/>
              <range>
                <low>
                  <value value="3.5"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mmol/L"/>
                </low>
                <high>
                  <value value="5.3"/>
                  <system value="http://unitsofmeasure.org"/>
                  <code value="mmol/L"/>
                </high>
              </range>
            </qualifiedValue>
          </ObservationDefinition>
        </resource>
        <response>
          <status value="Created"/>
          <location
                    value="https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000/_history/1"/>
          <etag value="W/&quot;1&quot;"/>
        </response>
      </entry>
      <entry>
        <fullUrl
                 value="https://jade.phast.fr/resources-server/api/FHIR/ActivityDefinition/QDXFM456"/>
        <resource>
          <ActivityDefinition>
            <id value="QDXFM456"/>
            <meta>
              <versionId value="1"/>
              <lastUpdated value="2020-07-09T09:28:02.217606+02:00"/>
              <profile
                       value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition"/>
            </meta>
            <language value="en-US"/>
            <text>
              <status value="additional"/>
              <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US"><a name="ActivityDefinition_QDXFM456"> </a>
                            <p>Potassium measurement on blood serum</p>
                        </div>
            </text>
            <url value="http://questdiagnostics.com/ActivityDefinition/QDXFM456"/>
            <identifier>
              <use value="official"/>
              <value value="K_serum_test"/>
            </identifier>
            <name value="PotassiumSerumMeasurementProcedure"/>
            <title
                   value="Procedure - potassium measurement on in vitro blood serum"/>
            <status value="draft"/>
            <experimental value="true"/>
            <date value="2020-01-24T14:00:00+02:00"/>
            <publisher value="HL7 International"/>
            <contact>
              <name value="HL7 Orders and Observations Work Group"/>
              <telecom>
                <system value="other"/>
                <value
                       value="http://www.hl7.org/Special/committees/orders/index.cfm"/>
              </telecom>
            </contact>
            <description
                         value="Potassium measurement procedure on in-vitro serum specimen"/>
            <purpose
                     value="This _ActivityDefinition_ specifies the input specimens and observations needed to perform potassium level test on serum, and the output observation.                  It is referenced by any _PlanDefinition_ representing a lab service focusing on this test."/>
            <effectivePeriod>
              <start value="2020-04-01"/>
              <end value="2020-12-25"/>
            </effectivePeriod>
            <topic>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="166312007"/>
                <display value="Blood chemistry"/>
              </coding>
            </topic>
            <kind value="ServiceRequest"/>
            <code>
              <coding>
                <system value="http://loinc.org"/>
                <code value="2823-3"/>
                <display value="Potassium [Moles/volume] in Serum or Plasma"/>
              </coding>
            </code>
            <priority value="routine"/>
            <timingDuration>
              <value value="30"/>
              <unit value="minutes"/>
              <system value="http://unitsofmeasure.org"/>
              <code value="mn"/>
            </timingDuration>
            <observationResultRequirement
                                          value="https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000"/>
          </ActivityDefinition>
        </resource>
        <response>
          <status value="Created"/>
          <location
                    value="https://jade.phast.fr/resources-server/api/FHIR/ActivityDefinition/QDXFM456/_history/1"/>
          <etag value="W/&quot;1&quot;"/>
        </response>
      </entry>
      <entry>
        <fullUrl
                 value="https://jade.phast.fr/resources-server/api/FHIR/PlanDefinition/QDXPD456"/>
        <resource>
          <PlanDefinition>
            <id value="QDXPD456"/>
            <meta>
              <versionId value="1"/>
              <lastUpdated value="2020-07-09T09:28:02.6544126+02:00"/>
              <profile
                       value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition"/>
            </meta>
            <language value="en-US"/>
            <text>
              <status value="additional"/>
              <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US"><a name="PlanDefinition_QDXPD456"> </a>
                            <p>Potassium measurement on blood serum</p>
                        </div>
            </text>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference">
              <valueReference>🔗
                <reference value="Composition/example-lab-compendium-header"/>
              </valueReference>
            </extension>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode">
              <valueCodeableConcept>
                <coding>
                  <system
                          value="http://hl7.org/fhir/uv/order-catalog/CodeSystem/example-cpt"/>
                  <code value="CPTfakecode"/>
                  <display value="Potassium, serum"/>
                </coding>
              </valueCodeableConcept>
            </extension>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode">
              <valueCodeableConcept>
                <coding>
                  <system
                          value="http://hl7.org/fhir/uv/order-catalog/CodeSystem/example-cpt"/>
                  <code value="1608"/>
                  <display value="BLOOD: POTASSIUM (K)"/>
                </coding>
              </valueCodeableConcept>
            </extension>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary">
              <extension url="textualSummary">
                <valueMarkdown value="no notable particularity for billing"/>
              </extension>
              <extension url="reimbursabilitySummary">
                <valueCode value="normal"/>
              </extension>
            </extension>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary">
              <valueString
                           value="Set up: Mon-Sat (Day shift or Night shift), Sun (Day shift); Report available: 1 day"/>
            </extension>
            <extension
                       url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary">
              <valueString value="No specific limitation for this test"/>
            </extension>
            <name value="PotassiumSerumMeasurement"/>
            <title value="Potassium measurement on in vitro blood serum"/>
            <type>
              <coding>
                <system
                        value="http://hl7.org/fhir/uv/order-catalog/CodeSystem/laboratory-service-definition-type"/>
                <code value="test"/>
                <display
                         value="unitary measurement performed on an in vitro biologic specimen"/>
              </coding>
            </type>
            <status value="draft"/>
            <experimental value="true"/>
            <date value="2020-02-05T20:00:00+02:00"/>
            <publisher value="HL7 International"/>
            <description value="Potassium measurement on serum specimen"/>
            <useContext>
              <code>
                <system
                        value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
                <code value="task"/>
              </code>
              <valueCodeableConcept>
                <coding>
                  <system
                          value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
                  <code value="LABOE"/>
                  <display value="laboratory test order entry task"/>
                </coding>
              </valueCodeableConcept>
            </useContext>
            <topic>
              <coding>
                <system value="http://loinc.org"/>
                <code value="18719-5"/>
                <display value="Chemistry studies (set)"/>
              </coding>
            </topic>
            <topic>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="166312007"/>
                <display value="Blood chemistry"/>
              </coding>
            </topic>
            <relatedArtifact>
              <type value="documentation"/>
              <citation
                        value="Potassium (symbol K from Latin:kalium) is a key chemical element involved in neuron function and influencing osmotic balance between cells and interstitial fluid. Depletion in potassium levels results in deficient fluid and electrolyte balance in the body as well as various nervous and cardiac dysfunctions. Studies suggest diets high in potassium can reduce the risk of hypertension and possibly stroke. Foods rich in potassium include parsley, dried apricots, potatoes, bananas, avocados, soybeans, and bran, as well as most fruits, vegetables, meat and fish. Overall, clear cases of potassium deficiency are rare in healthy individuals."/>
              <document>
                <url value="https://en.wikipedia.org/wiki/Potassium"/>
              </document>
            </relatedArtifact>
            <action>
              <extension
                         url="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested">
                <extension url="ExclusiveGroup">
                  <extension url="Material">
                    <valueReference>
                      <reference value="SpecimenDefinition/QDXSpec3"/>
                    </valueReference>
                  </extension>
                </extension>
              </extension>
              <code>
                <!--   20200731: Proprietary codes excluded from the examples, to avoid additional QA slicing info messages  -->
                <coding>
                  <system value="https://testdirectory.questdiagnostics.com/"/>
                  <code value="733"/>
                  <display value="Potassium, Serum"/>
                </coding>
                <coding>
                  <system value="http://loinc.org"/>
                  <code value="2823-3"/>
                  <display value="Potassium [Moles/volume] in Serum or Plasma"/>
                </coding>
              </code>
              <timingDuration>
                <value value="30"/>
                <unit value="minutes"/>
                <system value="http://unitsofmeasure.org"/>
                <code value="mn"/>
              </timingDuration>
              <definitionCanonical
                                   value="http://questdiagnostics.com/ActivityDefinition/QDXFM456"/>
            </action>
          </PlanDefinition>
        </resource>
        <response>
          <status value="Created"/>
          <location
                    value="https://jade.phast.fr/resources-server/api/FHIR/PlanDefinition/QDXPD456/_history/1"/>
          <etag value="W/&quot;1&quot;"/>
        </response>
      </entry>
    </Bundle>