This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
AU Base Specimen Profile [FMM Level 2]
This profile defines a specimen details structure that includes core localisation concepts for use in an Australian context.
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 Mon Oct 08 00:00:00 AEDT 2018 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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | I | 0..* | Specimen | Australian context specimen information |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Identifier |
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenType | Σ | 0..1 | Coding | Specimen Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |
request | 0..* | Reference(ProcedureRequest) | Why the specimen was collected | |
collection | I | 0..1 | BackboneElement | Collection details |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
collector | Σ | 0..1 | Reference(Practitioner) | Who collected the specimen |
collected[x] | Σ | 0..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenCollectionProcedure | Σ | 0..1 | Coding | Specimen Collection Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedBodySite | Σ | 0..1 | Coding | Body Site (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
processing | I | 0..* | BackboneElement | Processing and processing step details |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Textual description of procedure | |
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example) | |
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 | I | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenContainerType | Σ | 0..1 | Coding | Specimen Container Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-container-type-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example) | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(Substance) | |||
note | 0..* | Annotation | Comments | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | I | 0..* | Specimen | Australian context specimen information |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Identifier |
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenType | Σ | 0..1 | Coding | Specimen Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 1..1 | Reference(Patient | Group | Device | Substance) | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |
request | 0..* | Reference(ProcedureRequest) | Why the specimen was collected | |
collection | I | 0..1 | BackboneElement | Collection details |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
collector | Σ | 0..1 | Reference(Practitioner) | Who collected the specimen |
collected[x] | Σ | 0..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenCollectionProcedure | Σ | 0..1 | Coding | Specimen Collection Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedBodySite | Σ | 0..1 | Coding | Body Site (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
processing | I | 0..* | BackboneElement | Processing and processing step details |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Textual description of procedure | |
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example) | |
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 | I | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:snomedSpecimenContainerType | Σ | 0..1 | Coding | Specimen Container Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-container-type-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example) | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(Substance) | |||
note | 0..* | Annotation | Comments | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-specimen
not specified