Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide
1.0.0-ballot - CI Build
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
| Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: SpecimenRequested | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.25 | ||||
References the specimens requested for a PlanDefinition.action representing a laboratory service, assembling them with a combination of choices (pick one among several) and conjunctions (pick all listed). Each specimen appears as a reference to an instance of SpecimenDefinition
Context of Use
This extension may be used on the following element(s):
Usage info
Usages:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: References the specimens requested for a PlanDefinition.action representing a laboratory service, assembling them with a combination of choices (pick one among several) and conjunctions (pick all listed). Each specimen appears as a reference to an instance of SpecimenDefinition
Maturity: 2
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Extension | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:ExclusiveGroup |
1..* | Extension | An exclusive group of specimen requested | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:Material |
1..* | Extension | An individual specimen in an exclusive group | |
 url |
1..1 | uri | "Material" | |
  value[x] |
0..1 | Reference(Laboratory IVD Specimen Definition) | SpecimenDefinition reference | |
| url |
1..1 | uri | "ExclusiveGroup" | |
| value[x] |
0..0 | |||
 url |
1..1 | uri | "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
 id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ExclusiveGroup |
1..* | Extension | An exclusive group of specimen requested | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:Material |
1..* | Extension | An individual specimen in an exclusive group | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Material" | |
| value[x] |
0..1 | Reference(Laboratory IVD Specimen Definition) | SpecimenDefinition reference | |
| url |
1..1 | uri | "ExclusiveGroup" | |
| url |
1..1 | uri | "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: References the specimens requested for a PlanDefinition.action representing a laboratory service, assembling them with a combination of choices (pick one among several) and conjunctions (pick all listed). Each specimen appears as a reference to an instance of SpecimenDefinition
Maturity: 2
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ExclusiveGroup |
1..* | Extension | An exclusive group of specimen requested | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:Material |
1..* | Extension | An individual specimen in an exclusive group | |
| url |
1..1 | uri | "Material" | |
| value[x] |
0..1 | Reference(Laboratory IVD Specimen Definition) | SpecimenDefinition reference | |
| url |
1..1 | uri | "ExclusiveGroup" | |
| value[x] |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ExclusiveGroup |
1..* | Extension | An exclusive group of specimen requested | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:Material |
1..* | Extension | An individual specimen in an exclusive group | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url |
1..1 | uri | "Material" | |
| value[x] |
0..1 | Reference(Laboratory IVD Specimen Definition) | SpecimenDefinition reference | |
| url |
1..1 | uri | "ExclusiveGroup" | |
| url |
1..1 | uri | "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
IG © 2021+ HL7 International / Orders and Observations. Package hl7.fhir.uv.order-catalog#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-06-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change