Order Catalog Implementation Guide
1.0.0 - STU 1

Order Catalog Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Lab compendium test created - JSON Representation

Raw json | Download

    {
      "resourceType" : "Bundle",
      "id" : "example-lab-test-creation-transaction-response",
      "meta" : {
        "profile" : [
          🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionResponse"
        ]
      },
      "type" : "transaction-response",
      "entry" : [
        {
          "fullUrl" : "https://jade.phast.fr/resources-server/api/FHIR/SpecimenDefinition/QDXSpec3",
          "resource" : {
            "resourceType" : "SpecimenDefinition",
            "id" : "QDXSpec3",
            "meta" : {
              "versionId" : "1",
              "lastUpdated" : "2020-07-09T09:28:00.392383+02:00",
              "profile" : [
                🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition"
              ]
            },
            "text" : {
              "status" : "generated",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"SpecimenDefinition_QDXSpec3\"> </a>\n                        <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>\n                    </div>"
            },
            "status" : "active",
            "typeCollected" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "code" : "122555007",
                  "display" : "Venous blood specimen"
                }
              ]
            },
            "patientPreparation" : [
              {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "263678003",
                    "display" : "At rest"
                  }
                ]
              }
            ],
            "timeAspect" : "preferrably morning time",
            "typeTested" : [
              {
                "type" : {
                  "coding" : [
                    {
                      "system" : "http://snomed.info/sct",
                      "code" : "119364003",
                      "display" : "Serum specimen"
                    }
                  ]
                },
                "preference" : "preferred",
                "container" : {
                  "type" : {
                    "coding" : [
                      {
                        "system" : "http://snomed.info/sct",
                        "code" : "702281005",
                        "display" : "Evacuated blood collection tube, thrombin/clot activator/gel separator"
                      }
                    ]
                  },
                  "cap" : {
                    "coding" : [
                      {
                        "system" : "http://terminology.hl7.org/CodeSystem/container-cap",
                        "code" : "dark-yellow",
                        "display" : "dark yellow cap"
                      }
                    ]
                  },
                  "minimumVolumeQuantity" : {
                    "value" : 2,
                    "unit" : "ml",
                    "system" : "http://unitsofmeasure.org",
                    "code" : "mL"
                  }
                },
                "handling" : [
                  {
                    "temperatureQualifier" : {
                      "coding" : [
                        {
                          "system" : "http://terminology.hl7.org/CodeSystem/handling-condition",
                          "code" : "room",
                          "display" : "room temperature"
                        }
                      ],
                      "text" : "Ambient temperature"
                    },
                    "temperatureRange" : {
                      "low" : {
                        "value" : 15,
                        "unit" : "°C",
                        "system" : "http://unitsofmeasure.org",
                        "code" : "Cel"
                      },
                      "high" : {
                        "value" : 25,
                        "unit" : "°C",
                        "system" : "http://unitsofmeasure.org",
                        "code" : "Cel"
                      }
                    },
                    "maxDuration" : {
                      "value" : 60,
                      "unit" : "minute",
                      "system" : "http://unitsofmeasure.org",
                      "code" : "min"
                    }
                  },
                  {
                    "temperatureQualifier" : {
                      "coding" : [
                        {
                          "system" : "http://terminology.hl7.org/CodeSystem/handling-condition",
                          "code" : "refrigerated",
                          "display" : "refrigerated"
                        }
                      ]
                    },
                    "temperatureRange" : {
                      "low" : {
                        "value" : 2,
                        "unit" : "°C",
                        "system" : "http://unitsofmeasure.org",
                        "code" : "Cel"
                      },
                      "high" : {
                        "value" : 8,
                        "unit" : "°C",
                        "system" : "http://unitsofmeasure.org",
                        "code" : "Cel"
                      }
                    },
                    "maxDuration" : {
                      "value" : 8,
                      "unit" : "hour",
                      "system" : "http://unitsofmeasure.org",
                      "code" : "h"
                    }
                  }
                ]
              }
            ]
          },
          "response" : {
            "status" : "Created",
            "location" : "https://jade.phast.fr/resources-server/api/FHIR/SpecimenDefinition/QDXFMSpec3/_history/1",
            "etag" : "W/\"1\""
          }
        },
        {
          "fullUrl" : "https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000",
          "resource" : {
            "resourceType" : "ObservationDefinition",
            "id" : "QDXFM90000000",
            "meta" : {
              "versionId" : "1",
              "lastUpdated" : "2020-07-09T09:28:01.640399+02:00",
              "profile" : [
                🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition"
              ]
            },
            "language" : "en-US",
            "text" : {
              "status" : "additional",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en-US\" lang=\"en-US\"><a name=\"ObservationDefinition_QDXFM90000000\"> </a>\n                        <p>Laboratory observation: potassium level in blood</p>\n                    </div>"
            },
            "status" : "active",
            "category" : [
              {
                "coding" : [
                  {
                    "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
                    "code" : "laboratory",
                    "display" : "Laboratory"
                  }
                ]
              }
            ],
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "2823-3",
                  "display" : "Potassium [Moles/volume] in Serum or Plasma"
                }
              ]
            },
            "permittedDataType" : [
              "Quantity",
              "string"
            ],
            "multipleResultsAllowed" : false,
            "method" : {
              "text" : "Ion Selective Electrode (ISE)"
            },
            "preferredReportName" : "Potassium",
            "permittedUnit" : [
              {
                "system" : "http://unitsofmeasure.org",
                "code" : "mmol/L"
              },
              {
                "system" : "http://unitsofmeasure.org",
                "code" : "g/L"
              }
            ],
            "qualifiedValue" : [
              {
                "context" : {
                  "coding" : [
                    {
                      "system" : "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                      "code" : "normal",
                      "display" : "Normal Range"
                    }
                  ]
                },
                "age" : {
                  "low" : {
                    "value" : 2,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "a"
                  },
                  "high" : {
                    "value" : 19,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "a"
                  }
                },
                "rangeCategory" : "reference",
                "range" : {
                  "low" : {
                    "value" : 3.8,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "mmol/L"
                  },
                  "high" : {
                    "value" : 5.1,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "mmol/L"
                  }
                }
              },
              {
                "context" : {
                  "coding" : [
                    {
                      "system" : "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                      "code" : "normal",
                      "display" : "Normal Range"
                    }
                  ]
                },
                "age" : {
                  "low" : {
                    "value" : 20,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "a"
                  }
                },
                "rangeCategory" : "reference",
                "range" : {
                  "low" : {
                    "value" : 3.5,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "mmol/L"
                  },
                  "high" : {
                    "value" : 5.3,
                    "system" : "http://unitsofmeasure.org",
                    "code" : "mmol/L"
                  }
                }
              }
            ]
          },
          "response" : {
            "status" : "Created",
            "location" : "https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000/_history/1",
            "etag" : "W/\"1\""
          }
        },
        {
          "fullUrl" : "https://jade.phast.fr/resources-server/api/FHIR/ActivityDefinition/QDXFM456",
          "resource" : {
            "resourceType" : "ActivityDefinition",
            "id" : "QDXFM456",
            "meta" : {
              "versionId" : "1",
              "lastUpdated" : "2020-07-09T09:28:02.217606+02:00",
              "profile" : [
                🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabProcedureDefinition"
              ]
            },
            "language" : "en-US",
            "text" : {
              "status" : "additional",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en-US\" lang=\"en-US\"><a name=\"ActivityDefinition_QDXFM456\"> </a>\n                        <p>Potassium measurement on blood serum</p>\n                    </div>"
            },
            "url" : "http://questdiagnostics.com/ActivityDefinition/QDXFM456",
            "identifier" : [
              {
                "use" : "official",
                "value" : "K_serum_test"
              }
            ],
            "name" : "PotassiumSerumMeasurementProcedure",
            "title" : "Procedure - potassium measurement on in vitro blood serum",
            "status" : "draft",
            "experimental" : true,
            "date" : "2020-01-24T14:00:00+02:00",
            "publisher" : "HL7 International",
            "contact" : [
              {
                "name" : "HL7 Orders and Observations Work Group",
                "telecom" : [
                  {
                    "system" : "other",
                    "value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
                  }
                ]
              }
            ],
            "description" : "Potassium measurement procedure on in-vitro serum specimen",
            "purpose" : "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" : "2020-04-01",
              "end" : "2020-12-25"
            },
            "topic" : [
              {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "166312007",
                    "display" : "Blood chemistry"
                  }
                ]
              }
            ],
            "kind" : "ServiceRequest",
            "code" : {
              "coding" : [
                {
                  "system" : "http://loinc.org",
                  "code" : "2823-3",
                  "display" : "Potassium [Moles/volume] in Serum or Plasma"
                }
              ]
            },
            "priority" : "routine",
            "timingDuration" : {
              "value" : 30,
              "unit" : "minutes",
              "system" : "http://unitsofmeasure.org",
              "code" : "mn"
            },
            "observationResultRequirement" : [
              "https://jade.phast.fr/resources-server/api/FHIR/ObservationDefinition/QDXFM90000000"
            ]
          },
          "response" : {
            "status" : "Created",
            "location" : "https://jade.phast.fr/resources-server/api/FHIR/ActivityDefinition/QDXFM456/_history/1",
            "etag" : "W/\"1\""
          }
        },
        {
          "fullUrl" : "https://jade.phast.fr/resources-server/api/FHIR/PlanDefinition/QDXPD456",
          "resource" : {
            "resourceType" : "PlanDefinition",
            "id" : "QDXPD456",
            "meta" : {
              "versionId" : "1",
              "lastUpdated" : "2020-07-09T09:28:02.6544126+02:00",
              "profile" : [
                🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabServiceDefinition"
              ]
            },
            "language" : "en-US",
            "text" : {
              "status" : "additional",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en-US\" lang=\"en-US\"><a name=\"PlanDefinition_QDXPD456\"> </a>\n                        <p>Potassium measurement on blood serum</p>\n                    </div>"
            },
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference",
                "valueReference" : {
                  🔗 "reference" : "Composition/example-lab-compendium-header"
                }
              },
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode",
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "http://hl7.org/fhir/uv/order-catalog/CodeSystem/example-cpt",
                      "code" : "CPTfakecode",
                      "display" : "Potassium, serum"
                    }
                  ]
                }
              },
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ServiceBillingCode",
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "http://hl7.org/fhir/uv/order-catalog/CodeSystem/example-cpt",
                      "code" : "1608",
                      "display" : "BLOOD: POTASSIUM (K)"
                    }
                  ]
                }
              },
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/BillingSummary",
                "extension" : [
                  {
                    "url" : "textualSummary",
                    "valueMarkdown" : "no notable particularity for billing"
                  },
                  {
                    "url" : "reimbursabilitySummary",
                    "valueCode" : "normal"
                  }
                ]
              },
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ScheduleSummary",
                "valueString" : "Set up: Mon-Sat (Day shift or Night shift), Sun (Day shift); Report available: 1 day"
              },
              {
                "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LimitationSummary",
                "valueString" : "No specific limitation for this test"
              }
            ],
            "name" : "PotassiumSerumMeasurement",
            "title" : "Potassium measurement on in vitro blood serum",
            "type" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/uv/order-catalog/CodeSystem/laboratory-service-definition-type",
                  "code" : "test",
                  "display" : "unitary measurement performed on an in vitro biologic specimen"
                }
              ]
            },
            "status" : "draft",
            "experimental" : true,
            "date" : "2020-02-05T20:00:00+02:00",
            "publisher" : "HL7 International",
            "description" : "Potassium measurement on serum specimen",
            "useContext" : [
              {
                "code" : {
                  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
                  "code" : "task"
                },
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                      "code" : "LABOE",
                      "display" : "laboratory test order entry task"
                    }
                  ]
                }
              }
            ],
            "topic" : [
              {
                "coding" : [
                  {
                    "system" : "http://loinc.org",
                    "code" : "18719-5",
                    "display" : "Chemistry studies (set)"
                  }
                ]
              },
              {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "166312007",
                    "display" : "Blood chemistry"
                  }
                ]
              }
            ],
            "relatedArtifact" : [
              {
                "type" : "documentation",
                "citation" : "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" : "https://en.wikipedia.org/wiki/Potassium"
                }
              }
            ],
            "action" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested",
                    "extension" : [
                      {
                        "url" : "ExclusiveGroup",
                        "extension" : [
                          {
                            "url" : "Material",
                            "valueReference" : {
                              "reference" : "SpecimenDefinition/QDXSpec3"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ],
                "code" : {
                  "coding" : [
                    //   20200731: Proprietary codes excluded from the examples, to avoid additional QA slicing info messages
                    {
                      "system" : "https://testdirectory.questdiagnostics.com/",
                      "code" : "733",
                      "display" : "Potassium, Serum"
                    },
                    {
                      "system" : "http://loinc.org",
                      "code" : "2823-3",
                      "display" : "Potassium [Moles/volume] in Serum or Plasma"
                    }
                  ]
                },
                "timingDuration" : {
                  "value" : 30,
                  "unit" : "minutes",
                  "system" : "http://unitsofmeasure.org",
                  "code" : "mn"
                },
                "definitionCanonical" : "http://questdiagnostics.com/ActivityDefinition/QDXFM456"
              }
            ]
          },
          "response" : {
            "status" : "Created",
            "location" : "https://jade.phast.fr/resources-server/api/FHIR/PlanDefinition/QDXPD456/_history/1",
            "etag" : "W/\"1\""
          }
        }
      ]
    }