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![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Specimen | Australian context specimen information |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | External Identifier |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Identifier assigned by the lab |
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() | Σ | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |
![]() ![]() ![]() | 0..* | Reference(ProcedureRequest) | Why the specimen was collected | |
![]() ![]() ![]() | I | 0..1 | BackboneElement | Collection details |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner) | Who collected the specimen |
![]() ![]() ![]() ![]() | Σ | 0..1 | Collection time | |
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | The quantity of specimen collected | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Collection Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Body Site (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | I | 0..* | BackboneElement | Processing and processing step details |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of procedure | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example) | |
![]() ![]() ![]() ![]() | 0..* | Reference(Substance) | Material used in the processing step | |
![]() ![]() ![]() ![]() | 0..1 | Date and time of specimen processing | ||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | I | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 0..* | Identifier | Id for the container |
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of the container | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Container Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-container-type-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | Container volume or size | |
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | Quantity of specimen within container | |
![]() ![]() ![]() ![]() | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example) | ||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | Reference(Substance) | |||
![]() ![]() ![]() | 0..* | Annotation | Comments | |
![]() |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Specimen | Australian context specimen information |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | External Identifier |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Identifier assigned by the lab |
![]() ![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required) |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: v2 Specimen Type (example) |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() | Σ | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |
![]() ![]() ![]() | 0..* | Reference(ProcedureRequest) | Why the specimen was collected | |
![]() ![]() ![]() | I | 0..1 | BackboneElement | Collection details |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner) | Who collected the specimen |
![]() ![]() ![]() ![]() | Σ | 0..1 | Collection time | |
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | The quantity of specimen collected | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIR Specimen Collection Method (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Collection Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMED CT Body Structures (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Body Site (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | I | 0..* | BackboneElement | Processing and processing step details |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of procedure | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example) | |
![]() ![]() ![]() ![]() | 0..* | Reference(Substance) | Material used in the processing step | |
![]() ![]() ![]() ![]() | 0..1 | Date and time of specimen processing | ||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | I | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 0..* | Identifier | Id for the container |
![]() ![]() ![]() ![]() | 0..1 | string | Textual description of the container | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainer (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Specimen Container Type (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-container-type-1 (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | Container volume or size | |
![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | Quantity of specimen within container | |
![]() ![]() ![]() ![]() | 0..1 | Additive associated with container Binding: v2 Additive/Preservative (example) | ||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | Reference(Substance) | |||
![]() ![]() ![]() | 0..* | Annotation | Comments | |
![]() |
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