AU Base Implementation Guide
4.1.0-ballot - CI Build AU

This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Specimen

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-specimen Version: 4.1.0-ballot
Draft as of 2022-11-10 Maturity Level: 1 Computable Name: AUBaseSpecimen

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a specimen details structure that includes core localisation concepts for use in an Australian context.

The purpose of this profile is to provide national level agreement on core localised concepts.

This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage:

  • Refer to this Resource Profile:
  • Examples for this Resource Profile: Specimen/serum

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenA specimen in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... parent 0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1
Specimen.collection.methodpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1
Specimen.collection.bodySitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenA specimen in an Australian healthcare context
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... 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 Σ0..1CodeableConceptKind of material that forms the specimen
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred)
... subject Σ0..1Reference(Patient | Group | Device | Substance | 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 or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... 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
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (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 0..*ExtensionAdditional content defined by implementations
.... 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 0..*Reference(Substance)Material used in the processing step
.... 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 0..*ExtensionAdditional content defined by implementations
.... 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 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1
Specimen.collection.methodpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1
Specimen.collection.bodySitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

This structure is derived from Specimen

Summary

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenA specimen in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... parent 0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1
Specimen.collection.methodpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1
Specimen.collection.bodySitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenA specimen in an Australian healthcare context
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... 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 Σ0..1CodeableConceptKind of material that forms the specimen
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred)
... subject Σ0..1Reference(Patient | Group | Device | Substance | 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 or a device
... receivedTime Σ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... 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
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite 0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (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 0..*ExtensionAdditional content defined by implementations
.... 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 0..*Reference(Substance)Material used in the processing step
.... 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 0..*ExtensionAdditional content defined by implementations
.... 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 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1
Specimen.collection.methodpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1
Specimen.collection.bodySitepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/body-site-1
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedureexampleSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

This structure is derived from Specimen

Summary

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

not specified