Australian Base Implementation Guide (AU Base 1.1.1)

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

DRAFT
ONLY

1.0 StructureDefinition-au-diagnosticreport

AU Base Diagnostic Report [FMM Level 0]

This profile is intended to support all diagnostic reports including, pathology, diagnostic imaging and other diagnostic reports such as electrocardiograms, electroencephalograms, pulmonary function tests, colonoscopies, etc.

Forthcoming work around this profile is expected to result in a value set representing the Standard for Pathology Informatics in Australia (SPIA) - Reporting codes bound as a slice on the code element.

Identifiers

These definitions represent common data held in the DiagnosticReport.identifier element:

Extensions

Extensions used in this profile:

  • DiagnosticReport: performer-party [1]
  • DiagnosticReport: category-additional [1]

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

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

This profile builds on DiagnosticReport.

This profile was published on Mon Jun 24 09:07:00 AEST 2019 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
.. DiagnosticReport I0..*DiagnosticReportA diagnostic report in an Australian healthcare context
inv-diagrep-0: Additional category shall not be present if a category is absent
... performer-party 0..*Reference(PractitionerRole | CareTeam)Performing practitioner role or care team
URL: http://hl7.org.au/fhir/StructureDefinition/performer-party
... category-additional 0..*CodingAdditional category
URL: http://hl7.org.au/fhir/StructureDefinition/category-additional
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type
.... identifier:fillerIdentifier 0..*IdentifierFiller report identifier
..... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
...... coding 1..1CodingRequired Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... system 1..1uriFiller identifier system namespace
..... value 1..1stringFiller identifier
... category 0..1CodeableConceptBinding: Diagnostic Service Section Codes (preferred)
... code 1..1CodeableConcept
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system, value:code
..... coding:snomedImagingProcedures 0..1CodingDiagnostic Imaging Procedures (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required)
... performer 0..1BackboneElement
.... role 0..1CodeableConcept
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:anzscoRole 0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... coding:snomedRole 0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
... specimen 0..*Reference(AU Base Specimen)
... codedDiagnosis 0..*CodeableConcept
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedFinding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*DiagnosticReportA diagnostic report in an Australian healthcare context
inv-diagrep-0: Additional category shall not be present if a category is absent
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... performer-party I0..*Reference(PractitionerRole | CareTeam)Performing practitioner role or care team
URL: http://hl7.org.au/fhir/StructureDefinition/performer-party
... category-additional I0..*CodingAdditional category
URL: http://hl7.org.au/fhir/StructureDefinition/category-additional
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)Business identifier for report
Slice: Unordered, Open by pattern:type
.... identifier:fillerIdentifier Σ0..*IdentifierFiller report identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringxml:id (or equivalent in JSON)
........ extension0..*ExtensionAdditional Content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... text Σ0..1stringPlain text representation of the concept
..... system Σ1..1uriFiller identifier system namespace
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringFiller identifier
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (preferred)
... code Σ1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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, value:code
..... coding:snomedImagingProcedures Σ0..1CodingDiagnostic Imaging Procedures (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter | EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1Clinically relevant time/time-period for report
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDateTime this version was released
... performer ΣI0..1BackboneElementParticipants in producing the report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptType of performer
Binding: Procedure Performer Role Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional 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:anzscoRole Σ0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... coding:snomedRole Σ0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... actor Σ1..1Reference(Practitioner | Organization)Practitioner or Organization participant
... specimen 0..*Reference(AU Base Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations - simple, or complex nested groups
... imagingStudy 0..*Reference(ImagingStudy | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical Interpretation of test results
... codedDiagnosis 0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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:snomedFinding Σ0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... presentedForm 0..*AttachmentEntire report as issued

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*DiagnosticReportA diagnostic report in an Australian healthcare context
inv-diagrep-0: Additional category shall not be present if a category is absent
... performer-party 0..*Reference(PractitionerRole | CareTeam)Performing practitioner role or care team
URL: http://hl7.org.au/fhir/StructureDefinition/performer-party
... category-additional 0..*CodingAdditional category
URL: http://hl7.org.au/fhir/StructureDefinition/category-additional
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type
.... identifier:fillerIdentifier 0..*IdentifierFiller report identifier
..... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
...... coding 1..1CodingRequired Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... system 1..1uriFiller identifier system namespace
..... value 1..1stringFiller identifier
... category 0..1CodeableConceptBinding: Diagnostic Service Section Codes (preferred)
... code 1..1CodeableConcept
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system, value:code
..... coding:snomedImagingProcedures 0..1CodingDiagnostic Imaging Procedures (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required)
... performer 0..1BackboneElement
.... role 0..1CodeableConcept
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:anzscoRole 0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... coding:snomedRole 0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
... specimen 0..*Reference(AU Base Specimen)
... codedDiagnosis 0..*CodeableConcept
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedFinding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*DiagnosticReportA diagnostic report in an Australian healthcare context
inv-diagrep-0: Additional category shall not be present if a category is absent
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... performer-party I0..*Reference(PractitionerRole | CareTeam)Performing practitioner role or care team
URL: http://hl7.org.au/fhir/StructureDefinition/performer-party
... category-additional I0..*CodingAdditional category
URL: http://hl7.org.au/fhir/StructureDefinition/category-additional
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)Business identifier for report
Slice: Unordered, Open by pattern:type
.... identifier:fillerIdentifier Σ0..*IdentifierFiller report identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringxml:id (or equivalent in JSON)
........ extension0..*ExtensionAdditional Content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... text Σ0..1stringPlain text representation of the concept
..... system Σ1..1uriFiller identifier system namespace
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringFiller identifier
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (preferred)
... code Σ1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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, value:code
..... coding:snomedImagingProcedures Σ0..1CodingDiagnostic Imaging Procedures (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter | EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1Clinically relevant time/time-period for report
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDateTime this version was released
... performer ΣI0..1BackboneElementParticipants in producing the report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptType of performer
Binding: Procedure Performer Role Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional 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:anzscoRole Σ0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... coding:snomedRole Σ0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
..... text Σ0..1stringPlain text representation of the concept
.... actor Σ1..1Reference(Practitioner | Organization)Practitioner or Organization participant
... specimen 0..*Reference(AU Base Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations - simple, or complex nested groups
... imagingStudy 0..*Reference(ImagingStudy | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical Interpretation of test results
... codedDiagnosis 0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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:snomedFinding Σ0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... presentedForm 0..*AttachmentEntire report as issued

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-diagnosticreport

none defined