HL7.FHIR.UV.ORDER-CATALOG\Specimen requested for a PlanDefiniton top-level action

This page is part of the Order Catalog Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Extension: SpecimenRequested

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:

Use this Extension: Laboratory Service Definition

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

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:

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

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	Extension
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ExclusiveGroup	1..*	Extension	An exclusive group of specimen requested
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
Extension	I	0..*	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ExclusiveGroup	I	1..*	Extension	An exclusive group of specimen requested
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Material	I	1..*	Extension	An individual specimen in an exclusive group
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"Material"
value[x]	I	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

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

Structures

This structure refers to these other structures:

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

Differential View

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	Extension
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ExclusiveGroup	1..*	Extension	An exclusive group of specimen requested
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
Extension	I	0..*	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ExclusiveGroup	I	1..*	Extension	An exclusive group of specimen requested
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:Material	I	1..*	Extension	An individual specimen in an exclusive group
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"Material"
value[x]	I	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 extension: Schematron

Constraints

Id	Path	Details	Requirements
ele-1	Extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:ExclusiveGroup	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:ExclusiveGroup.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup.extension:Material	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:ExclusiveGroup.extension:Material	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup.extension:Material.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:ExclusiveGroup.extension:Material.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup.extension:Material.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:ExclusiveGroup.extension:Material.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:ExclusiveGroup.extension:Material.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:ExclusiveGroup.extension:Material.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())