AU Base Implementation Guide
4.1.2-preview - Preview
This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-pathologyreport | Version: 4.1.2-preview | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUBasePathologyReport | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This profile defines a diagnostic report structure to represent a pathology report issued by a diagnostic service provider in an Australian context. This profile is intended to be capable of supporting reporting for all pathology disciplines (e.g. including microbiology, histopathology, cytology, blood transfusion) with the exception of genomics.
This profile does not provide full support for structured pathology reporting. It is expected that this support is best handled by a set of profiles that represent the structured reporting requirements for each specific protocol (see for example RCPA’s structured pathology reporting of cancer); this is not in the scope of this implementation guide at this time.
Profile specific implementation guidance:
DiagnosticReport.presentedForm
.DiagnosticResult.result
. Each referenced Observation resource represents an individual pathology test and result value or component result values, or a study / panel which references other Observations in Observation.hasMember
.Observation.hasMember
and not directly referenced in DiagnosticReport.result
DiagnosticReport.code
and the study / panel Observation Observation.code
should be the same concept if the report contains only the results of that study / paneleffective[x]
is the earliest specimen collection date time.DiagnosticReport.performer
.DiagnosticReport.performer
.DiagnosticReport.code
:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Path | Conformance | ValueSet |
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Path | Conformance | ValueSet |
DiagnosticReport.status | required | DiagnosticReportStatus |
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A pathology report in an Australian healthcare context | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 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, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber | Business identifier for report | |||||
basedOn | 0..* | Reference(ServiceRequest | AU Base Diagnostic Request | CarePlan) | Pathology order | |||||
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
category | Σ | 1..* | CodeableConcept | Service category Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 (extensible) | ||||
code | Σ | 1..1 | CodeableConcept | Pathology test or test group Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (preferred) | ||||
subject | Σ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | Σ | 1..1 | Time of specimen collection | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(AU Base Specimen) | Specimens this report is based on | |||||
result | 0..* | Reference(AU Base Diagnostic Result | AU Base Pathology Result) | Observations | |||||
imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 conclusion (interpretation) of test results | |||||
conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |||||
presentedForm | 0..* | Attachment | Entire report as issued | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
DiagnosticReport.language | preferred | CommonLanguages
| ||||
DiagnosticReport.status | required | DiagnosticReportStatus | ||||
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from DiagnosticReport
Path | Conformance | ValueSet |
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Key Elements View
Path | Conformance | ValueSet |
DiagnosticReport.status | required | DiagnosticReportStatus |
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 |
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 |
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A pathology report in an Australian healthcare context | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 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, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber | Business identifier for report | |||||
basedOn | 0..* | Reference(ServiceRequest | AU Base Diagnostic Request | CarePlan) | Pathology order | |||||
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
category | Σ | 1..* | CodeableConcept | Service category Binding: https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 (extensible) | ||||
code | Σ | 1..1 | CodeableConcept | Pathology test or test group Binding: https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 (preferred) | ||||
subject | Σ | 1..1 | Reference(Patient) | The subject of the report - usually, but not always, the patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | Σ | 1..1 | Time of specimen collection | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(AU Base Specimen) | Specimens this report is based on | |||||
result | 0..* | Reference(AU Base Diagnostic Result | AU Base Pathology Result) | Observations | |||||
imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 conclusion (interpretation) of test results | |||||
conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |||||
presentedForm | 0..* | Attachment | Entire report as issued | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
DiagnosticReport.language | preferred | CommonLanguages
| ||||
DiagnosticReport.status | required | DiagnosticReportStatus | ||||
DiagnosticReport.category | extensible | https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1 | ||||
DiagnosticReport.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1 | ||||
DiagnosticReport.conclusionCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron