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

Extension: SpecimenRequested 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

The official URL for this extension is:

http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested

Status: draft
Extension maintained by: HL7 International - Orders and Observations Work Group

Context of Use

This extension may be used on the following element(s):

  • PlanDefinition.action

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 2 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ExclusiveGroup 1..*ExtensionAn exclusive group of specimen requested
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Material 1..*ExtensionAn individual specimen in an exclusive group
..... url 1..1uri"Material"
..... value[x] 0..1Reference(Laboratory IVD Specimen Definition)SpecimenDefinition reference
.... url 1..1uri"ExclusiveGroup"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ExclusiveGroup 1..*ExtensionAn exclusive group of specimen requested
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Material 1..*ExtensionAn individual specimen in an exclusive group
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"Material"
..... value[x] 0..1Reference(Laboratory IVD Specimen Definition)SpecimenDefinition reference
.... url 1..1uri"ExclusiveGroup"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ExclusiveGroup 1..*ExtensionAn exclusive group of specimen requested
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Material 1..*ExtensionAn individual specimen in an exclusive group
..... url 1..1uri"Material"
..... value[x] 0..1Reference(Laboratory IVD Specimen Definition)SpecimenDefinition reference
.... url 1..1uri"ExclusiveGroup"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:ExclusiveGroup 1..*ExtensionAn exclusive group of specimen requested
.... id 0..1idUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:Material 1..*ExtensionAn individual specimen in an exclusive group
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"Material"
..... value[x] 0..1Reference(Laboratory IVD Specimen Definition)SpecimenDefinition reference
.... url 1..1uri"ExclusiveGroup"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()