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

Resource Profile: LabSpecimenDefinition Profile

Defining URL:http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition
Version:current
Name:LabSpecimenDefinition
Title:Laboratory IVD Specimen Definition
Status:Draft as of 2022-10-21 03:52:32+0000
Definition:

The LabSpecimenDefinition profile constrains the SpecimenDefinition resource to represent definitions of IVD specimens attached to laboratory procedures described in catalogs of laboratory services using these procedures and specimens.

Publisher:HL7 International - Orders and Observations Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from SpecimenDefinition

Summary

Must-Support: 2 elements

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... typeTested S0..*BackboneElementSpecimen in container intended for testing by lab
.... type S0..1CodeableConceptType of intended specimen

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical canonical URL to reference this SpecimenDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier
... version Σ0..1stringBusiness version of the SpecimenDefinition
... title Σ0..1stringName for this SpecimenDefinition (Human friendly)
... derivedFromCanonical Σ0..*canonical(SpecimenDefinition)Based on FHIR definition of another SpecimenDefinition
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource.

... experimental Σ0..1booleanIf this SpecimenDefinition is not for real usage
... subject[x] Σ0..1Type of subject for specimen collection
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the SpecimenDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SpecimenDefinition
... useContext 0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this SpecimenDefinition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used.


... purpose 0..1markdownWhy this SpecimenDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen SpecimenDefinition was approved by publisher
... lastReviewDate 0..1dateThe date on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the SpecimenDefinition
... typeCollected Σ0..1CodeableConceptKind of material to collect
Binding: hl7VS-specimenType (example): The type of the specimen to be collected.

... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Binding: PreparePatient (example): SCT descendants of 703763000 |Precondition value (qualifier value)|


... timeAspect Σ0..1stringTime aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ0..*CodeableConceptSpecimen collection procedure
Binding: SpecimenCollection (example): SCT actions and procedures for specimen collection


... typeTested S0..*BackboneElementSpecimen in container intended for testing by lab
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... isDerived 0..1booleanPrimary or secondary specimen
Example General: false
.... type S0..1CodeableConceptType of intended specimen
Binding: hl7VS-specimenType (example): The type of specimen conditioned in a container for lab testing.

.... preference 1..1codepreferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.


Example General: preferred, alternate
.... container 0..1BackboneElementThe specimen's container
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... material 0..1CodeableConceptThe material type used for the container
Binding: ContainerMaterials (example): SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal|

..... type 0..1CodeableConceptKind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)|

..... cap 0..1CodeableConceptColor of container cap
Binding: ContainerCap (example): Color of the container cap.

..... description 0..1stringThe description of the kind of container
Example General: Blue top tube with citrate
..... capacity 0..1SimpleQuantityThe capacity of this kind of container
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantityQuantity(SimpleQuantity)
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... additive[x] 1..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(SubstanceDefinition)
..... preparation 0..1stringSpecial processing applied to the container for this specimen type
.... requirement 0..1stringRequirements for specimen delivery and special handling
.... retentionTime 0..1DurationThe usual time for retaining this kind of specimen
.... singleUse 0..1booleanSpecimen for single use only
.... rejectionCriterion 0..*CodeableConceptCriterion specified for specimen rejection
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.


.... handling 0..*BackboneElementSpecimen handling before testing
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... temperatureQualifier 0..1CodeableConceptQualifies the interval of temperature
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.

..... temperatureRange 0..1RangeTemperature range for these handling instructions
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
Example General: freeze within 4 hours
.... testingDestination 0..*CodeableConceptWhere the specimen will be tested
Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested.



doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... typeTested 0..*BackboneElementSpecimen in container intended for testing by lab
.... type 0..1CodeableConceptType of intended specimen
Binding: hl7VS-specimenType (example): The type of specimen conditioned in a container for lab testing.


doco Documentation for this format

This structure is derived from SpecimenDefinition

Summary

Must-Support: 2 elements

Differential View

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... typeTested S0..*BackboneElementSpecimen in container intended for testing by lab
.... type S0..1CodeableConceptType of intended specimen

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical canonical URL to reference this SpecimenDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier
... version Σ0..1stringBusiness version of the SpecimenDefinition
... title Σ0..1stringName for this SpecimenDefinition (Human friendly)
... derivedFromCanonical Σ0..*canonical(SpecimenDefinition)Based on FHIR definition of another SpecimenDefinition
... derivedFromUri Σ0..*uriBased on external definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource.

... experimental Σ0..1booleanIf this SpecimenDefinition is not for real usage
... subject[x] Σ0..1Type of subject for specimen collection
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the SpecimenDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SpecimenDefinition
... useContext 0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this SpecimenDefinition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used.


... purpose 0..1markdownWhy this SpecimenDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen SpecimenDefinition was approved by publisher
... lastReviewDate 0..1dateThe date on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the SpecimenDefinition
... typeCollected Σ0..1CodeableConceptKind of material to collect
Binding: hl7VS-specimenType (example): The type of the specimen to be collected.

... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Binding: PreparePatient (example): SCT descendants of 703763000 |Precondition value (qualifier value)|


... timeAspect Σ0..1stringTime aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ0..*CodeableConceptSpecimen collection procedure
Binding: SpecimenCollection (example): SCT actions and procedures for specimen collection


... typeTested S0..*BackboneElementSpecimen in container intended for testing by lab
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... isDerived 0..1booleanPrimary or secondary specimen
Example General: false
.... type S0..1CodeableConceptType of intended specimen
Binding: hl7VS-specimenType (example): The type of specimen conditioned in a container for lab testing.

.... preference 1..1codepreferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.


Example General: preferred, alternate
.... container 0..1BackboneElementThe specimen's container
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... material 0..1CodeableConceptThe material type used for the container
Binding: ContainerMaterials (example): SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal|

..... type 0..1CodeableConceptKind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)|

..... cap 0..1CodeableConceptColor of container cap
Binding: ContainerCap (example): Color of the container cap.

..... description 0..1stringThe description of the kind of container
Example General: Blue top tube with citrate
..... capacity 0..1SimpleQuantityThe capacity of this kind of container
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantityQuantity(SimpleQuantity)
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... additive[x] 1..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(SubstanceDefinition)
..... preparation 0..1stringSpecial processing applied to the container for this specimen type
.... requirement 0..1stringRequirements for specimen delivery and special handling
.... retentionTime 0..1DurationThe usual time for retaining this kind of specimen
.... singleUse 0..1booleanSpecimen for single use only
.... rejectionCriterion 0..*CodeableConceptCriterion specified for specimen rejection
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.


.... handling 0..*BackboneElementSpecimen handling before testing
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... temperatureQualifier 0..1CodeableConceptQualifies the interval of temperature
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.

..... temperatureRange 0..1RangeTemperature range for these handling instructions
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
Example General: freeze within 4 hours
.... testingDestination 0..*CodeableConceptWhere the specimen will be tested
Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested.



doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
SpecimenDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
SpecimenDefinition.statusrequiredPublicationStatus
SpecimenDefinition.jurisdictionextensibleJurisdiction ValueSet
SpecimenDefinition.typeCollectedexampleHl7VSSpecimenType
SpecimenDefinition.patientPreparationexamplePreparePatient
SpecimenDefinition.collectionexampleSpecimenCollection
SpecimenDefinition.typeTested.typeexampleHl7VSSpecimenType
SpecimenDefinition.typeTested.preferencerequiredSpecimenContainedPreference
SpecimenDefinition.typeTested.container.materialexampleContainerMaterials
SpecimenDefinition.typeTested.container.typeexampleSpecimenContainerType
SpecimenDefinition.typeTested.container.capexampleContainerCap
SpecimenDefinition.typeTested.container.additive.additive[x]exampleHl7VSAdditivePreservative
SpecimenDefinition.typeTested.rejectionCriterionexampleRejectionCriterion
SpecimenDefinition.typeTested.handling.temperatureQualifierexampleHandlingConditionSet
SpecimenDefinition.typeTested.testingDestinationexampleDiagnosticServiceSectionCodes

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()