STARS Implementation Guide
0.5.1 - release

STARS Implementation Guide - Downloaded Version 0.5.1 See the Directory of published versions

## Resource Profile: CSIRO STARS Specimen Profile

Official URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-specimen | Version: 0.5.1
Active as of 2025-10-15 | Computable Name: CsiroStarsSpecimenProfile

A specimen / sample

Usages:

- Refer to this Profile: CSIRO STARS ServiceRequest Profile and CSIRO STARS Specimen Profile
- Examples for this Profile: Specimen/specimen-example-bat and Specimen/specimen-example

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | External Identifier
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject | Σ | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
collection |  | 0..1 | BackboneElement | Collection details
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 |  | Collection time Slice: Unordered, Open by type:$this
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
processing | S | 0..* | BackboneElement | Processing and processing step details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.identifier.​use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std.
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std.
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
identifier | S | 0..* | Identifier | External Identifier
type |  | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject |  | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
receivedTime |  | 0..0 |  |
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
collection |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
collector |  | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] |  | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this
collected[x]:collectedDateTime | S | 0..1 | dateTime | Collection time
processing | S | 0..* | BackboneElement | Processing and processing step details
condition | S | 0..* | CodeableConcept | State of the specimen
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | External Identifier
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject | Σ | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
combined | Σ | 0..1 | code | grouped | pooled Binding: SpecimenCombined (required): Codes for the combined status of a specimen.
role |  | 0..* | CodeableConcept | The role the specimen serves Binding: SpecimenRole (preferred): Codes describing specimen role.
feature |  | 0..* | BackboneElement | The physical feature of a specimen
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Highlighted feature Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
description |  | 1..1 | string | Information about the feature
collection |  | 0..1 | BackboneElement | Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 |  | Collection time Slice: Unordered, Open by type:$this
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity |  | 0..1 | SimpleQuantity(5.0.0) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
device |  | 0..1 | CodeableReference(Device) | Device used to perform collection Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
procedure |  | 0..1 | Reference(Procedure) | The procedure that collects the specimen
bodySite |  | 0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept |  |  | CodeableConcept |
fastingStatusDuration |  |  | Duration |
processing | S | 0..* | BackboneElement | Processing and processing step details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Textual description of procedure
method |  | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingMethod (example): Type indicating the technique used to process the specimen.
additive |  | 0..* | Reference(Substance) | Material used in the processing step
time[x] |  | 0..1 |  | Date and time of specimen processing
timeDateTime |  |  | dateTime |
timePeriod |  |  | Period |
container |  | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
device |  | 1..1 | Reference(Device) | Device resource for the container
location |  | 0..1 | Reference(Location) | Where the container is
specimenQuantity |  | 0..1 | SimpleQuantity(5.0.0) | Quantity of specimen within container
condition | S Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
Specimen.identifier.​use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std.
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std.
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG
Specimen.combined | Base | required | Specimen Combined | 📍5.0.0 | FHIR Std.
Specimen.role | Base | preferred | Specimen Role | 📍5.0.0 | FHIR Std.
Specimen.feature.type | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.
Specimen.collection.​method | Base | example | FHIR Specimen Collection Method | 📍5.0.0 | FHIR Std.
Specimen.collection.​device | Base | example |  | Not Stated | Unknown
Specimen.collection.​bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.
Specimen.collection.​fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦2.0.0 | THO v6.5
Specimen.processing.​method | Base | example | Specimen Processing Method | 📍5.0.0 | FHIR Std.
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Summary

Must-Support: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- CSIRO STARS Patient Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient)
- CSIRO STARS Specimen Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-specimen)
- CSIRO STARS ServiceRequest Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-servicerequest)
- CSIRO STARS Practitioner Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-practitioner)

Extensions

This structure refers to these extensions:

- https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Specimen.collection.collected[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | External Identifier
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject | Σ | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
collection |  | 0..1 | BackboneElement | Collection details
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 |  | Collection time Slice: Unordered, Open by type:$this
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
processing | S | 0..* | BackboneElement | Processing and processing step details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
condition | S Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.identifier.​use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std.
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std.
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
identifier | S | 0..* | Identifier | External Identifier
type |  | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject |  | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
receivedTime |  | 0..0 |  |
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
collection |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
collector |  | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] |  | 0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this
collected[x]:collectedDateTime | S | 0..1 | dateTime | Collection time
processing | S | 0..* | BackboneElement | Processing and processing step details
condition | S | 0..* | CodeableConcept | State of the specimen
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | External Identifier
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: STARS Identifier Type (required)
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: STARS Specimen Type (required)
subject | Σ | 0..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | 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, a biologically-derived product, or a device
parent |  | 0..* | Reference(CSIRO STARS Specimen Profile) | Specimen from which this specimen originated
request |  | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | Why the specimen was collected
combined | Σ | 0..1 | code | grouped | pooled Binding: SpecimenCombined (required): Codes for the combined status of a specimen.
role |  | 0..* | CodeableConcept | The role the specimen serves Binding: SpecimenRole (preferred): Codes describing specimen role.
feature |  | 0..* | BackboneElement | The physical feature of a specimen
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Highlighted feature Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
description |  | 1..1 | string | Information about the feature
collection |  | 0..1 | BackboneElement | Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:location | S | 0..1 | Reference(CSIRO STARS Location Profile) | Specimen Collection Location URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(CSIRO STARS Practitioner Profile) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 |  | Collection time Slice: Unordered, Open by type:$this
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity |  | 0..1 | SimpleQuantity(5.0.0) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
device |  | 0..1 | CodeableReference(Device) | Device used to perform collection Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
procedure |  | 0..1 | Reference(Procedure) | The procedure that collects the specimen
bodySite |  | 0..1 | CodeableReference(BodyStructure) | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept |  |  | CodeableConcept |
fastingStatusDuration |  |  | Duration |
processing | S | 0..* | BackboneElement | Processing and processing step details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Textual description of procedure
method |  | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingMethod (example): Type indicating the technique used to process the specimen.
additive |  | 0..* | Reference(Substance) | Material used in the processing step
time[x] |  | 0..1 |  | Date and time of specimen processing
timeDateTime |  |  | dateTime |
timePeriod |  |  | Period |
container |  | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
device |  | 1..1 | Reference(Device) | Device resource for the container
location |  | 0..1 | Reference(Location) | Where the container is
specimenQuantity |  | 0..1 | SimpleQuantity(5.0.0) | Quantity of specimen within container
condition | S Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note | S | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.language | Base | required | All Languages | 📍5.0.0 | FHIR Std.
Specimen.identifier.​use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std.
Specimen.identifier.​type | Base | required | STARS Identifier Type | 📦0.5.1 | This IG
Specimen.status | Base | required | Specimen Status | 📍5.0.0 | FHIR Std.
Specimen.type | Base | required | STARS Specimen Type | 📦0.5.1 | This IG
Specimen.combined | Base | required | Specimen Combined | 📍5.0.0 | FHIR Std.
Specimen.role | Base | preferred | Specimen Role | 📍5.0.0 | FHIR Std.
Specimen.feature.type | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.
Specimen.collection.​method | Base | example | FHIR Specimen Collection Method | 📍5.0.0 | FHIR Std.
Specimen.collection.​device | Base | example |  | Not Stated | Unknown
Specimen.collection.​bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std.
Specimen.collection.​fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦2.0.0 | THO v6.5
Specimen.processing.​method | Base | example | Specimen Processing Method | 📍5.0.0 | FHIR Std.
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Summary

Must-Support: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

- CSIRO STARS Patient Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient)
- CSIRO STARS Specimen Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-specimen)
- CSIRO STARS ServiceRequest Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-servicerequest)
- CSIRO STARS Practitioner Profile (https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-practitioner)

Extensions

This structure refers to these extensions:

- https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/specimen-collection-location

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Specimen.collection.collected[x]

Other representations of profile: CSV, Excel, Schematron