Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-specimen

AU Base Specimen Profile [FMM Level 0]

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

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-specimen

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

This profile builds on Specimen.

This profile was published on Thu Feb 13 00:00:00 AEDT 2020 as a draft by Health Level Seven Australia (Orders and Observations WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SpecimenAustralian context specimen information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Identifier
... accessionIdentifier ΣI0..1IdentifierIdentifier assigned by the lab
... status ?!ΣI0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type ΣI0..1CodeableConceptKind of material that forms the specimen
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred)
... subject ΣI0..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 ΣI0..1dateTimeThe time when specimen was received for processing
... parent I0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... request I0..*Reference(ServiceRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣI0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] ΣI0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration ΣI0..1DurationHow long it took to collect specimen
.... quantity I0..1SimpleQuantityThe quantity of specimen collected
.... method I0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite I0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... fastingStatus[x] ΣI0..1Whether or how long patient abstained from food and/or drink
Binding: v2 Relevant Clincial Information (extensible)
..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I0..1stringTextual description of procedure
.... procedure I0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive I0..*Reference(Substance)Material used in the processing step
.... time[x] I0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI0..*IdentifierId for the container
.... description I0..1stringTextual description of the container
.... type I0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example)
.... capacity I0..1SimpleQuantityContainer volume or size
.... specimenQuantity I0..1SimpleQuantityQuantity of specimen within container
.... additive[x] I0..1Additive associated with container
Binding: v2 Additive (example)
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition ΣI0..*CodeableConceptState of the specimen
Binding: v2 Specimen Condition (extensible)
... note I0..*AnnotationComments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen I0..*SpecimenAustralian context specimen information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Identifier
... accessionIdentifier ΣI0..1IdentifierIdentifier assigned by the lab
... status ?!ΣI0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required)
... type ΣI0..1CodeableConceptKind of material that forms the specimen
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred)
... subject ΣI0..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 ΣI0..1dateTimeThe time when specimen was received for processing
... parent I0..*Reference(AU Base Specimen)Specimen from which this specimen originated
... request I0..*Reference(ServiceRequest)Why the specimen was collected
... collection I0..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector ΣI0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] ΣI0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration ΣI0..1DurationHow long it took to collect specimen
.... quantity I0..1SimpleQuantityThe quantity of specimen collected
.... method I0..1CodeableConceptTechnique used to perform collection
Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred)
.... bodySite I0..1CodeableConceptAnatomical collection site
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
.... fastingStatus[x] ΣI0..1Whether or how long patient abstained from food and/or drink
Binding: v2 Relevant Clincial Information (extensible)
..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing I0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I0..1stringTextual description of procedure
.... procedure I0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example)
.... additive I0..*Reference(Substance)Material used in the processing step
.... time[x] I0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container I0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier ΣI0..*IdentifierId for the container
.... description I0..1stringTextual description of the container
.... type I0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example)
.... capacity I0..1SimpleQuantityContainer volume or size
.... specimenQuantity I0..1SimpleQuantityQuantity of specimen within container
.... additive[x] I0..1Additive associated with container
Binding: v2 Additive (example)
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(Substance)
... condition ΣI0..*CodeableConceptState of the specimen
Binding: v2 Specimen Condition (extensible)
... note I0..*AnnotationComments

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-specimen

not specified