Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Pathology Report

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-diagnosticreport-path-1 Version: 0.1.4
Draft as of 2024-09-12 Computable Name: ADHADiagnosticReportPath

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to represent a pathology report issued by a diagnostic service provider to support the electronic exchange of the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. 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 identifies the additional constraints, extensions, and value sets that build on and extend DiagnosticReport that are supported.

This profile is designed to set a DiagnosticReport standard for:

  • Query for pathology reports for a patient
  • Record or update pathology reports belonging to a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • DiagnosticReport.category provides an efficient way of supporting system interactions, e.g. restricting searches to pathology reports. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • Results that are free text or report form are represented using ‘DiagnosticReport.presentedForm`.
  • The DiagnosticReport resource can represent the clinical conclusion as a text summary with DiagnosticReport.conclusion or a set of codes with DiagnosticReport.conclusionCode.
    • Although both are marked as must support, sending systems are not required to support both a text and a set of codes, but they SHALL support at least one of these elements.
    • A receiving or persisting system SHALL support both elements.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ADHADiagnosticReportCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
... Slices for category 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab 1..1 CodeableConcept Report generated by laboratories
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... effective[x] 1..1 dateTime, Period Time of specimen collection

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
inv-dh-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
... status ?!SΣ 1..1 code partial | preliminary | final +
Binding: DiagnosticReportStatus Report Available . (required)
... Slices for category SΣ 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab SΣ 1..1 CodeableConcept Report generated by laboratories
Binding: DiagnosticServiceSectionCodes (extensible)

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣC 1..1 Reference(ADHA Core Patient) The subject of the report - usually, but not always, the patient
inv-dh-dir-02: At least reference or a valid identifier shall be present
... effective[x] SΣC 1..1 Time of specimen collection
inv-dh-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣC 1..* Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) Responsible Diagnostic Service
inv-dh-dir-03: At least reference or a valid identifier shall be present
... result SC 0..* Reference(ADHA Pathology Result Observation) Observations
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... media SΣ 0..* BackboneElement Key images associated with this report
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 1..1 Reference(ADHA Core Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.category:LabextensiblePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
inv-dh-dir-01: The report shall at least have a result or a presentedForm
... 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
... 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 S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
... basedOn S 0..* Reference(ADHA Core ServiceRequest) Diagnostic investigation order
... status ?!SΣ 1..1 code partial | preliminary | final +
Binding: DiagnosticReportStatus Report Available . (required)
... Slices for category SΣ 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab SΣ 1..1 CodeableConcept Report generated by laboratories
Binding: DiagnosticServiceSectionCodes (extensible)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... 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
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣC 1..1 Reference(ADHA Core Patient) The subject of the report - usually, but not always, the patient
inv-dh-dir-02: At least reference or a valid identifier shall be present
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] SΣC 1..1 Time of specimen collection
inv-dh-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣC 1..* Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) Responsible Diagnostic Service
inv-dh-dir-03: At least reference or a valid identifier shall be present
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(AU Base Specimen) Specimens this report is based on
... result SC 0..* Reference(ADHA Pathology Result Observation) Observations
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media SΣ 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(ADHA Core Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.category:LabextensiblePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
DiagnosticReport.result.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

This structure is derived from ADHADiagnosticReportCore

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.category

Differential View

This structure is derived from ADHADiagnosticReportCore

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
... Slices for category 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab 1..1 CodeableConcept Report generated by laboratories
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... effective[x] 1..1 dateTime, Period Time of specimen collection

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
inv-dh-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
... status ?!SΣ 1..1 code partial | preliminary | final +
Binding: DiagnosticReportStatus Report Available . (required)
... Slices for category SΣ 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab SΣ 1..1 CodeableConcept Report generated by laboratories
Binding: DiagnosticServiceSectionCodes (extensible)

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣC 1..1 Reference(ADHA Core Patient) The subject of the report - usually, but not always, the patient
inv-dh-dir-02: At least reference or a valid identifier shall be present
... effective[x] SΣC 1..1 Time of specimen collection
inv-dh-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣC 1..* Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) Responsible Diagnostic Service
inv-dh-dir-03: At least reference or a valid identifier shall be present
... result SC 0..* Reference(ADHA Pathology Result Observation) Observations
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... media SΣ 0..* BackboneElement Key images associated with this report
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... link Σ 1..1 Reference(ADHA Core Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.category:LabextensiblePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* ADHADiagnosticReportCore A pathology report in an Australian healthcare context
inv-dh-dir-01: The report shall at least have a result or a presentedForm
... 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
... 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 S 1..* Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumber Business identifier for report
... basedOn S 0..* Reference(ADHA Core ServiceRequest) Diagnostic investigation order
... status ?!SΣ 1..1 code partial | preliminary | final +
Binding: DiagnosticReportStatus Report Available . (required)
... Slices for category SΣ 1..* CodeableConcept Classification of the report as laboratory + more specific discipline where available
Slice: Unordered, Open by pattern:$this
Binding: Pathology Diagnostic Service Category . (extensible)
.... category:Lab SΣ 1..1 CodeableConcept Report generated by laboratories
Binding: DiagnosticServiceSectionCodes (extensible)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... 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
... code SΣ 1..1 CodeableConcept Diagnostic examination name / study name / group name
Binding: RCPA SPIA Pathology Reporting . (extensible)
... subject SΣC 1..1 Reference(ADHA Core Patient) The subject of the report - usually, but not always, the patient
inv-dh-dir-02: At least reference or a valid identifier shall be present
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] SΣC 1..1 Time of specimen collection
inv-dh-dir-04: Date shall be at least to day
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣ 1..1 instant Diagnostic report date time
... performer SΣC 1..* Reference(ADHA Authoring PractitionerRole | ADHA Core Organization) Responsible Diagnostic Service
inv-dh-dir-03: At least reference or a valid identifier shall be present
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(AU Base Specimen) Specimens this report is based on
... result SC 0..* Reference(ADHA Pathology Result Observation) Observations
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media SΣ 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(ADHA Core Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode S 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: Clinical Finding . (preferred)
... presentedForm SC 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatusReportAvailable .
https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensiblePathologyDiagnosticServiceCategory .
https://healthterminologies.gov.au/fhir/ValueSet/pathology-diagnostic-service-category-1
DiagnosticReport.category:LabextensiblePattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleRCPASPIAPathologyReporting .
https://healthterminologies.gov.au/fhir/ValueSet/spia-pathology-reporting-1
DiagnosticReport.result.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.conclusionCodepreferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

This structure is derived from ADHADiagnosticReportCore

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.category

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
identifier token SHALL An identifier for the report DiagnosticReport.identifier
category token SHALL Which diagnostic discipline/department created the report DiagnosticReport.category
subject:identifier token SHALL The subject of the report if a patient DiagnosticReport.subject.identifier
code token SHALL The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result DiagnosticReport.code
date date SHALL The clinically relevant time of the report DiagnosticReport.effective
status token SHOULD The status of the report DiagnosticReport.status

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for all diagnostic reports for a patient using the subject:identifier search parameter:

    GET [base]/DiagnosticReport?subject:identifier={system|}[code]

    Example:

     GET [base]/DiagnosticReport?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient (how to search by :identifier)

  2. SHALL support searching using the identifier search parameter:

    GET [base]/DiagnosticReport?identifier={system|}[code]

    Example:

     GET [base]/DiagnosticReport?identifier=http://doombenpathlabs.example.com/reports|1032702

    Implementation Notes: Fetches a bundle containing any DiagnosticReport resources matching the identifier (how to search by token)

  3. SHALL support searching using the combination subject:identifier and category search parameter:

    GET [base]/DiagnosticReport?subject:identifier={system|}[code]&category[code]

    Example:

     GET [base]/DiagnosticReport?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=http://terminology.hl7.org/CodeSystem/v2-0074|CH

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources with the category of "Chemistry" for the specified patient (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination subject:identifier and code search parameter:

    GET [base]/DiagnosticReport?subject:identifier={system|}[code]&code={system|}[code]

    Example:

     GET [base]/DiagnosticReport?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&code=http://loinc.org|14683-7

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources with the code of an 14683-7 (Creatinine urine) for the specified patient (how to search by :identifier and how to search by token)

  5. SHALL support searching using the combination of the subject:identifier and date search parameters:

    GET [base]/DiagnosticReport?subject:identifier={system|}[code]&date=[date]

    Example:

     GET [base]/DiagnosticReport?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&date=ge2013-03-14

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)