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..1stringUnique 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..1stringUnique 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..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1Value of extension
....... valueBase64Binarybase64Binary
....... valueBooleanboolean
....... valueCanonicalcanonical(Any)
....... valueCodecode
....... valueDatedate
....... valueDateTimedateTime
....... valueDecimaldecimal
....... valueIdid
....... valueInstantinstant
....... valueIntegerinteger
....... valueInteger64integer64
....... valueMarkdownmarkdown
....... valueOidoid
....... valuePositiveIntpositiveInt
....... valueStringstring
....... valueTimetime
....... valueUnsignedIntunsignedInt
....... valueUriuri
....... valueUrlurl
....... valueUuiduuid
....... valueAddressAddress
....... valueAgeAge
....... valueAnnotationAnnotation
....... valueAttachmentAttachment
....... valueCodeableConceptCodeableConcept
....... valueCodeableReferenceCodeableReference
....... valueCodingCoding
....... valueContactPointContactPoint
....... valueCountCount
....... valueDistanceDistance
....... valueDurationDuration
....... valueHumanNameHumanName
....... valueIdentifierIdentifier
....... valueMoneyMoney
....... valuePeriodPeriod
....... valueQuantityQuantity
....... valueRangeRange
....... valueRatioRatio
....... valueRatioRangeRatioRange
....... valueReferenceReference(Any)
....... valueSampledDataSampledData
....... valueSignatureSignature
....... valueTimingTiming
....... valueContactDetailContactDetail
....... valueContributorContributor
....... valueDataRequirementDataRequirement
....... valueExpressionExpression
....... valueParameterDefinitionParameterDefinition
....... valueRelatedArtifactRelatedArtifact
....... valueTriggerDefinitionTriggerDefinition
....... valueUsageContextUsageContext
....... valueDosageDosage
....... valueMetaMeta
..... 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..1stringUnique 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..1stringUnique 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..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1Value of extension
....... valueBase64Binarybase64Binary
....... valueBooleanboolean
....... valueCanonicalcanonical(Any)
....... valueCodecode
....... valueDatedate
....... valueDateTimedateTime
....... valueDecimaldecimal
....... valueIdid
....... valueInstantinstant
....... valueIntegerinteger
....... valueInteger64integer64
....... valueMarkdownmarkdown
....... valueOidoid
....... valuePositiveIntpositiveInt
....... valueStringstring
....... valueTimetime
....... valueUnsignedIntunsignedInt
....... valueUriuri
....... valueUrlurl
....... valueUuiduuid
....... valueAddressAddress
....... valueAgeAge
....... valueAnnotationAnnotation
....... valueAttachmentAttachment
....... valueCodeableConceptCodeableConcept
....... valueCodeableReferenceCodeableReference
....... valueCodingCoding
....... valueContactPointContactPoint
....... valueCountCount
....... valueDistanceDistance
....... valueDurationDuration
....... valueHumanNameHumanName
....... valueIdentifierIdentifier
....... valueMoneyMoney
....... valuePeriodPeriod
....... valueQuantityQuantity
....... valueRangeRange
....... valueRatioRatio
....... valueRatioRangeRatioRange
....... valueReferenceReference(Any)
....... valueSampledDataSampledData
....... valueSignatureSignature
....... valueTimingTiming
....... valueContactDetailContactDetail
....... valueContributorContributor
....... valueDataRequirementDataRequirement
....... valueExpressionExpression
....... valueParameterDefinitionParameterDefinition
....... valueRelatedArtifactRelatedArtifact
....... valueTriggerDefinitionTriggerDefinition
....... valueUsageContextUsageContext
....... valueDosageDosage
....... valueMetaMeta
..... 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

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroupAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ExclusiveGroupMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroup.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ExclusiveGroup.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroup.extension:MaterialAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ExclusiveGroup.extension:MaterialMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroup.extension:Material.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ExclusiveGroup.extension:Material.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroup.extension:Material.extension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:ExclusiveGroup.extension:Material.extension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:ExclusiveGroup.extension:Material.extension.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:ExclusiveGroup.extension:Material.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())