FHIR Osiris Implementation Guide
2.1.0 - ci-build

FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Biological Sample

Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/onco-biological-sample Version: 2.1.0
Draft as of 2024-03-21 Computable Name: BiologicalSample

Description of a biological sample coming from an oncology Patient, with its storage condition.

Usage:

Formal Views of Profile Content

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

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... extension 1..*ExtensionExtension
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... value[x]:valueCodeableConcept 1..1CodeableConceptThe origin of the sample
... BasedOnCondition S0..1Reference(Tumor Pathology Event)Tumur Pathology Event concerned by the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition
.... value[x]:valueReference 0..1Reference(Tumor Pathology Event)Value of extension
... type S1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject S0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent S0..1Reference(Biological Sample)Identifier of the parent biological sample
... collection
.... Slices for collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
..... collected[x]:collectedDateTime S1..1dateTimeCollection date
.... quantity S0..1SimpleQuantityPercentage of tumor cells
..... value 0..1decimalNumerical value (with implicit precision)
..... unit 0..1stringUnit representation
Required Pattern: %
..... code 0..1codeCoded form of the unit
Required Pattern: C4055283
.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
... condition S0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... text 0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S1..1CodeableConceptThe origin of the sample
Binding: Biological Sample Origin Value Set (extensible)
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition"
.... Slices for value[x] 0..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S0..1Reference(Tumor Pathology Event)Value of extension
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ1..1IdentifierIdentifier of the biological sample
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject SΣC0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
ref-1: SHALL have a contained resource if a local reference is provided
... parent SC0..1Reference(Biological Sample)Identifier of the parent biological sample
ref-1: SHALL have a contained resource if a local reference is provided
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection date
.... quantity SC0..1SimpleQuantityPercentage of tumor cells
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... value Σ0..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
Required Pattern: %
..... system ΣC0..1uriSystem that defines coded unit form
..... code Σ0..1codeCoded form of the unit
Required Pattern: C4055283
.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
... condition SΣ0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConceptextensibleBiologicalSampleOrigin
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin
from this IG
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S1..1CodeableConceptThe origin of the sample
Binding: Biological Sample Origin Value Set (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Required Pattern: Origin of the sample
... BasedOnCondition S0..1Reference(Tumor Pathology Event)Tumur Pathology Event concerned by the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition"
.... Slices for value[x] 0..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S0..1Reference(Tumor Pathology Event)Value of extension
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ1..1IdentifierIdentifier of the biological sample
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject SΣC0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
ref-1: SHALL have a contained resource if a local reference is provided
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent SC0..1Reference(Biological Sample)Identifier of the parent biological sample
ref-1: SHALL have a contained resource if a local reference is provided
... request C0..*Reference(ServiceRequest)Why the specimen was collected
ref-1: SHALL have a contained resource if a local reference is provided
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣC0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
ref-1: SHALL have a contained resource if a local reference is provided
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection date
.... duration ΣC0..1DurationHow long it took to collect specimen
Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.

Additional BindingsPurpose
AllUCUMExpressionForTimeMax Binding

qty-3: If a code for the unit is present, the system SHALL also be present
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
.... quantity SC0..1SimpleQuantityPercentage of tumor cells
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ0..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
Required Pattern: %
..... system ΣC0..1uriSystem that defines coded unit form
..... code Σ0..1codeCoded form of the unit
Required Pattern: C4055283
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive C0..*Reference(Substance)Material used in the processing step
ref-1: SHALL have a contained resource if a local reference is provided
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity C0..1SimpleQuantityContainer volume or size
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... specimenQuantity C0..1SimpleQuantityQuantity of specimen within container
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition SΣ0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConceptextensibleBiologicalSampleOrigin
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin
from this IG
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.durationextensibleCommonUCUMCodesForDuration
Additional Bindings Purpose
AllUCUMExpressionForTime Max Binding
http://hl7.org/fhir/ValueSet/duration-units
from the FHIR Standard
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG

This structure is derived from Specimen

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Specimen.collection.collected[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... extension 1..*ExtensionExtension
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... value[x]:valueCodeableConcept 1..1CodeableConceptThe origin of the sample
... BasedOnCondition S0..1Reference(Tumor Pathology Event)Tumur Pathology Event concerned by the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition
.... value[x]:valueReference 0..1Reference(Tumor Pathology Event)Value of extension
... type S1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject S0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent S0..1Reference(Biological Sample)Identifier of the parent biological sample
... collection
.... Slices for collected[x] 1..1dateTimeCollection time
Slice: Unordered, Open by type:$this
..... collected[x]:collectedDateTime S1..1dateTimeCollection date
.... quantity S0..1SimpleQuantityPercentage of tumor cells
..... value 0..1decimalNumerical value (with implicit precision)
..... unit 0..1stringUnit representation
Required Pattern: %
..... code 0..1codeCoded form of the unit
Required Pattern: C4055283
.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
... condition S0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... text 0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S1..1CodeableConceptThe origin of the sample
Binding: Biological Sample Origin Value Set (extensible)
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition"
.... Slices for value[x] 0..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S0..1Reference(Tumor Pathology Event)Value of extension
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ1..1IdentifierIdentifier of the biological sample
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject SΣC0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
ref-1: SHALL have a contained resource if a local reference is provided
... parent SC0..1Reference(Biological Sample)Identifier of the parent biological sample
ref-1: SHALL have a contained resource if a local reference is provided
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection date
.... quantity SC0..1SimpleQuantityPercentage of tumor cells
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... value Σ0..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
Required Pattern: %
..... system ΣC0..1uriSystem that defines coded unit form
..... code Σ0..1codeCoded form of the unit
Required Pattern: C4055283
.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
... condition SΣ0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConceptextensibleBiologicalSampleOrigin
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin
from this IG
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... BiologicalSampleOrigin S1..1CodeableConceptThe origin of the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin
Binding: Biological Sample Origin Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BiologicalSampleOrigin"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept S1..1CodeableConceptThe origin of the sample
Binding: Biological Sample Origin Value Set (extensible)
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Required Pattern: Origin of the sample
... BasedOnCondition S0..1Reference(Tumor Pathology Event)Tumur Pathology Event concerned by the sample
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/BasedOnCondition"
.... Slices for value[x] 0..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S0..1Reference(Tumor Pathology Event)Value of extension
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ1..1IdentifierIdentifier of the biological sample
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ1..1CodeableConceptThe nature of the sample
Binding: Biological Sample Nature Value Set (preferred)
... subject SΣC0..1Reference(Oncology Patient)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
ref-1: SHALL have a contained resource if a local reference is provided
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent SC0..1Reference(Biological Sample)Identifier of the parent biological sample
ref-1: SHALL have a contained resource if a local reference is provided
... request C0..*Reference(ServiceRequest)Why the specimen was collected
ref-1: SHALL have a contained resource if a local reference is provided
... collection 0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣC0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
ref-1: SHALL have a contained resource if a local reference is provided
.... Slices for collected[x] Σ1..1dateTimeCollection time
Slice: Unordered, Closed by type:$this
..... collected[x]:collectedDateTime SΣ1..1dateTimeCollection date
.... duration ΣC0..1DurationHow long it took to collect specimen
Binding: CommonUCUMCodesForDuration (extensible): Appropriate units for Duration.

Additional BindingsPurpose
AllUCUMExpressionForTimeMax Binding

qty-3: If a code for the unit is present, the system SHALL also be present
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
.... quantity SC0..1SimpleQuantityPercentage of tumor cells
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ0..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
Required Pattern: %
..... system ΣC0..1uriSystem that defines coded unit form
..... code Σ0..1codeCoded form of the unit
Required Pattern: C4055283
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S1..1CodeableConceptTopography of the tumor sample
Binding: Topography Value Set (preferred)
.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive C0..*Reference(Substance)Material used in the processing step
ref-1: SHALL have a contained resource if a local reference is provided
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity C0..1SimpleQuantityContainer volume or size
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... specimenQuantity C0..1SimpleQuantityQuantity of specimen within container
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition SΣ0..1CodeableConceptStorage method
Binding: Storage temperature Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Storage temperature of the sample.
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.extension:BiologicalSampleOrigin.value[x]:valueCodeableConceptextensibleBiologicalSampleOrigin
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleOrigin
from this IG
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredBiologicalSampleNature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/BiologicalSampleNature
from this IG
Specimen.collection.durationextensibleCommonUCUMCodesForDuration
Additional Bindings Purpose
AllUCUMExpressionForTime Max Binding
http://hl7.org/fhir/ValueSet/duration-units
from the FHIR Standard
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySitepreferredTopography
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/Topography
from this IG
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
Specimen.conditionextensibleStorageTemperature
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/StorageTemperature
from this IG

This structure is derived from Specimen

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Specimen.collection.collected[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron