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
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.
These definitions represent common data held in the DiagnosticReport.identifier element:
Extensions used in this profile:
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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | DiagnosticReport | A diagnostic report in an Australian healthcare context inv-diagrep-0: Additional category shall not be present if a category is absent |
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 | Extension Slice: Unordered, Open by value:url | |
performer-party | I | 0..* | Reference(PractitionerRole | CareTeam) | Performing practitioner role or care team URL: http://hl7.org.au/fhir/StructureDefinition/performer-party |
category-additional | I | 0..* | Coding | Additional category URL: http://hl7.org.au/fhir/StructureDefinition/category-additional |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | (Slice Definition) | Business identifier for report Slice: Unordered, Open by pattern:type |
identifier:fillerIdentifier | Σ | 0..* | Identifier | Filler report identifier |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (required) |
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 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
text | Σ | 0..1 | string | Plain text representation of the concept |
system | Σ | 1..1 | uri | Filler identifier system namespace Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Filler identifier Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | What was requested | |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (preferred) |
code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
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, value:code |
coding:snomedImagingProcedures | Σ | 0..1 | Coding | Diagnostic Imaging Procedures (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Health care event when test ordered |
effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | Σ | 0..1 | instant | DateTime this version was released |
performer | ΣI | 0..1 | BackboneElement | Participants in producing the report |
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 |
role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (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:anzscoRole | Σ | 0..1 | Coding | Australian and New Zealand Standard Classification of Occupations Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required) |
coding:snomedRole | Σ | 0..1 | Coding | Practitioner Role (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
actor | Σ | 1..1 | Reference(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 | ΣI | 0..* | BackboneElement | Key images associated with this report |
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 |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | Σ | 1..1 | Reference(Media) | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (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:snomedFinding | Σ | 0..1 | Coding | Clinical Finding (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
presentedForm | 0..* | Attachment | Entire report as issued | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | DiagnosticReport | A diagnostic report in an Australian healthcare context inv-diagrep-0: Additional category shall not be present if a category is absent |
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 | Extension Slice: Unordered, Open by value:url | |
performer-party | I | 0..* | Reference(PractitionerRole | CareTeam) | Performing practitioner role or care team URL: http://hl7.org.au/fhir/StructureDefinition/performer-party |
category-additional | I | 0..* | Coding | Additional category URL: http://hl7.org.au/fhir/StructureDefinition/category-additional |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | (Slice Definition) | Business identifier for report Slice: Unordered, Open by pattern:type |
identifier:fillerIdentifier | Σ | 0..* | Identifier | Filler report identifier |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (required) |
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 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
text | Σ | 0..1 | string | Plain text representation of the concept |
system | Σ | 1..1 | uri | Filler identifier system namespace Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Filler identifier Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | What was requested | |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (preferred) |
code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
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, value:code |
coding:snomedImagingProcedures | Σ | 0..1 | Coding | Diagnostic Imaging Procedures (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Health care event when test ordered |
effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | Σ | 0..1 | instant | DateTime this version was released |
performer | ΣI | 0..1 | BackboneElement | Participants in producing the report |
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 |
role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (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:anzscoRole | Σ | 0..1 | Coding | Australian and New Zealand Standard Classification of Occupations Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required) |
coding:snomedRole | Σ | 0..1 | Coding | Practitioner Role (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
actor | Σ | 1..1 | Reference(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 | ΣI | 0..* | BackboneElement | Key images associated with this report |
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 |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | Σ | 1..1 | Reference(Media) | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (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:snomedFinding | Σ | 0..1 | Coding | Clinical Finding (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required) |
text | Σ | 0..1 | string | Plain text representation of the concept |
presentedForm | 0..* | Attachment | Entire report as issued | |
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-diagnosticreport
none defined