AU Core Implementation Guide
0.2.2-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core DiagnosticReport

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-diagnosticreport Version: 0.2.2-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreDiagnosticReport

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a DiagnosticReport resource to record, search, and fetch diagnostic reports associated with a patient. It is based on the AU Base Diagnostic Report profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the DiagnosticReport when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a specific diagnostic report such as an electrocardiogram (ECG) or full blood count (FBC)
  • Query for category of diagnostic report (e.g. all cardiology reports)
  • Record or update a diagnostic report for a patient

Comparison with other national and international specifications

A resource conforming to this profile:

No equivalent IPA profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Summary or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • DiagnosticReport.category provides an efficient way of supporting system interactions, e.g. restricting searches. 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`.
  • References to a Media resource are preferred to be contained but may be an external resource
  • 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, servers are not required to support both a text and a set of codes, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • The DiagnosticReport resource can represent the result as a text summary with DiagnosticReport.conclusion or a set of codes with DiagnosticReport.conclusionCode.
    • Although both are marked as must support, servers are not required to support both a text and a set of codes, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • Source system identifiers that identify the business process (order ids) SHOULD be included as AU Local Order Identifier in addition to reporting identifiers (e.g. accession, lab number) to support workflow.
    • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.
  • When constructing a pathology report see the AU Base Pathology Report profile in AU Base.

  • When constructing a pathology report see the AU Base Diagnostic Imaging Report profile in AU Base.

    Composition, DocumentReference, and DiagnosticReport resources support support the exchange of clinical notes. Specific feedback is sought on resource selection.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseDiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... basedOn S0..*Reference(AU Core ServiceRequest)Diagnostic investigation order
... status S1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... code S1..1CodeableConceptDiagnostic examination name / study name / group name
... subject S1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... effective[x] SC1..1dateTime, PeriodClinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued S1..1instantDiagnostic report date time
... performer S1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Responsible Diagnostic Service
... result SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... media S0..*BackboneElementKey images associated with this report
.... link S1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... status ?!SΣ1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... category SΣ1..*CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ1..1CodeableConceptDiagnostic examination name / study name / group name
Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... effective[x] SΣC1..1Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ1..1instantDiagnostic report date time
... performer SΣ1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Responsible Diagnostic Service
... result SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... media SΣ0..*BackboneElementKey images associated with this report
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link SΣ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
DiagnosticReport.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.conclusionCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... basedOn S0..*Reference(AU Core ServiceRequest)Diagnostic investigation order
... status ?!SΣ1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... category SΣ1..*CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ1..1CodeableConceptDiagnostic examination name / study name / group name
Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] SΣC1..1Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ1..1instantDiagnostic report date time
... performer SΣ1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)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 SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣ0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link SΣ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
DiagnosticReport.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.result.typeextensibleResourceType
DiagnosticReport.conclusionCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10

Differential View

This structure is derived from AUBaseDiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... basedOn S0..*Reference(AU Core ServiceRequest)Diagnostic investigation order
... status S1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... code S1..1CodeableConceptDiagnostic examination name / study name / group name
... subject S1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... effective[x] SC1..1dateTime, PeriodClinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
... issued S1..1instantDiagnostic report date time
... performer S1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Responsible Diagnostic Service
... result SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... media S0..*BackboneElementKey images associated with this report
.... link S1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... status ?!SΣ1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... category SΣ1..*CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ1..1CodeableConceptDiagnostic examination name / study name / group name
Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... effective[x] SΣC1..1Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ1..1instantDiagnostic report date time
... performer SΣ1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)Responsible Diagnostic Service
... result SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... media SΣ0..*BackboneElementKey images associated with this report
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link SΣ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
DiagnosticReport.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.conclusionCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C0..*AUBaseDiagnosticReportA diagnostic report in an Australian healthcare context
au-core-dir-01: The report shall at least have a result or a presentedForm
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Identifier, AULocalOrderIdentifier, AULocalReportIdentifier, AUAccessionNumberBusiness identifier for report
... basedOn S0..*Reference(AU Core ServiceRequest)Diagnostic investigation order
... status ?!SΣ1..1codepartial | preliminary | final +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1 (required)
... category SΣ1..*CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (extensible)
... code SΣ1..1CodeableConceptDiagnostic examination name / study name / group name
Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] SΣC1..1Clinically relevant time/time-period for report
au-core-dir-04: Date shall be at least to day
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued SΣ1..1instantDiagnostic report date time
... performer SΣ1..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization)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 SC0..*Reference(AU Core Diagnostic Result Observation | AU Core Diagnostic Imaging Result Observation | AU Core Pathology Result Observation)Observations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣ0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link SΣ1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical conclusion (interpretation) of test results
... conclusionCode S0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... presentedForm SC0..*AttachmentEntire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.statusrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/diagnosticreportstatus-report-available-1
DiagnosticReport.categoryextensibleDiagnosticServiceSectionCodes
DiagnosticReport.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
DiagnosticReport.result.typeextensibleResourceType
DiagnosticReport.conclusionCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-dir-01errorDiagnosticReportThe report shall at least have a result or a presentedForm
: result.exists() or presentedForm.exists()
au-core-dir-04errorDiagnosticReport.effective[x]Date shall be at least to day
: $this is DateTime implies $this.toString().length() >= 10

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
_id SHALL token
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+category SHALL reference+token
patient+category+date SHALL reference+token+date
identifier SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
patient+category+status SHOULD reference+token+token
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
patient+code SHOULD reference+token
patient+code+date SHOULD reference+token+date
patient+status SHOULD reference+token
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

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

  1. SHOULD support fetching a DiagnosticReport using the _id search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/DiagnosticReport/[id] or GET [base]/DiagnosticReport?_id=[id]

    Example:

    1. GET [base]/DiagnosticReport/2169591
    2. GET [base]/DiagnosticReport?_id=2169591

    Implementation Notes: Fetches a single DiagnosticReport (how to search by the logical id of the resource)

  2. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/DiagnosticReport?patient={Type/}[id] or optionally GET [base]/DiagnosticReport?patient.identifier=[system|][code]

    Example:

    1. GET [base]/DiagnosticReport?patient=5678
    2. GET [base]/DiagnosticReport?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/DiagnosticReport?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

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

  3. SHALL support searching using the combination of the patient and category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/DiagnosticReport?patient={Type/}[id]&category={system|}[code]

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB

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

  4. SHALL support searching using the combination of the patient and category and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/DiagnosticReport?patient={Type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and date and category (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

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

  1. SHOULD support searching using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

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

    Example:

    1. GET [base]/DiagnosticReport?identifier=http://laboratory.example.org|1032333
    2. GET [base]/DiagnosticReport?identifier=http://laboratory.example.org|1032333&_revinclude=Provenance:target

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

  2. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/DiagnosticReport?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&status=final

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and category and status (how to search by reference and how to search by token)

  3. SHOULD support searching using the combination of the patient and code search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/DiagnosticReport?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&code=http://loinc.org|94309-2,http://loinc.org|2164-2

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and diagnostic report code(s). The DiagnosticReport code parameter searches DiagnosticReport.code only. (how to search by reference and how to search by token)

  4. SHOULD support searching using the combination of the patient and code and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/DiagnosticReport?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&code=http://loinc.org|94309-2,http://loinc.org|2164-2&date=ge2020-01-01T00:00:00Z
    2. GET [base]/DiagnosticReport?patient.identifier=http://example.org/fhir/mrn|12345&code=http://loinc.org|94309-2,http://loinc.org|2164-2&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and date and report code(s) (how to search by reference and how to search by token and how to search by date)

  5. SHOULD support searching using the combination of the patient and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/DiagnosticReport?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/DiagnosticReport?patient=5678&status=final

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