STARS Implementation Guide
0.6.1 - release

This page is part of the Csiro Stars (v0.6.1: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Bundle - DiagnosticReport

Overview

Used to deliver results of diagnostic investigations. Customisations have been made to the standard FHIR resources, known as Profiles.

The DiagnosticReport Bundle will typically contain:

You will find some examples of the full bundle on Artifacts under the QA Bundle for DiagnosticReport Bundle name.

DiagnosticReport CSV Model

DiagnosticReport CSV ModelDiagnosticReportBundlemessageheader_idmessageheader_eventmessageheader_receivermessageheader_sendermessageheader_author_identifiermessageheader_author_fullnamemessageheader_author_emaildiagnosticreport_identifierdiagnosticreport_requisitiondiagnosticreport_statusdiagnosticreport_issueddiagnosticreport_resultsinterpreter_fullnamediagnosticreport_media_titlediagnosticreport_media_docstatusdiagnosticreport_conclusionobservations_analysis_identifierobservations_sender_identifierobservations_receiver_identifierobservations_statusobservations_issuedobservations_codeobservation_effectiveobservation_dataabsentreasonobservation_interpretationobservation_noteobservation_valueobservation_valuequantity_unitobservation_valuequantity_comparatorLegend:required field
List of fields that exist in a DiagnosticReport CSV file.

Field List for CSV model

A CSV file can be submitted via the STARS Client to produce a CsiroStarsServiceRequestProfile.

The CSV must follow a predefined structure, with each column representing a specific field required to build the ServiceRequest resource. A full list of Required fields is provided below.

Each row in the CSV represents a single sample. This means that if multiple samples are included in the file, each one must be provided on its own row, with all required fields populated accordingly.

Required Fields

Name (Required) Definition Value
messageheader_event Message type: Must be "ServiceRequest" for sending specimen ValueSet: MessageTypeValueSet
messageheader_receiver receiver node node username
messageheader_sender sender node node username or senders username
messageheader_author_identifier   stars username
messageheader_author_fullname   Free-text
messageheader_author_email   Free-text
diagnosticreport_identifier   Free-text
diagnosticreport_requisition Which submissions or job requisitions the report relates to. Free-text
diagnosticreport_status   ValueSet: []
diagnosticreport_issued   DateTime
diagnosticreport_resultsinterpreter_fullname   Free-text
observation_analysis_identifier   ValueSet: AnalysisValueSet
observation_sender_identifier Senders sample reference. ie the lab that performed the testing. Free-text
observation_status   ValueSet: []
observation_code   ValueSet: []

Optional Fields

Name (Optional) Definition Value
messageheader_id Message Identifier: UUID Free-text (UUID)
diagnosticreport_media_title Filename of the attached report. Free-text
diagnosticreport_media_docstatus Status of the attached report. ValueSet: CompositionStatus
diagnosticreport_conclusion   Free-text
observation_receiver_identifier Receivers sample reference. ie the lab that submitted the samples for testing. Free-text
observation_issued Timestamp when the test was authorised DateTime
observation_effective Timestamp when the test was completed DateTime
observation_dataabsentreason "Reason for the test not being complted. "Insufficient sample size received to complete the test" Free-text
observation_interpretation   Free-Text
observation_note   Free-text
observation_value Result value. Either string or decimal Free-text
observation_valuequantity_unit Display name of the unit's code. eg "Cycle Threshold". If value is decimal then unit may be specified ValueSet: UcumValueSet
observation_valuequantity_comparator If value is decimal then comparator may be specified ValueSet: ComparatorValueSet

Mapping DiagnosticReport from Legacy ResultSend

New Field Old Field
messageheader_id MESSAGE.STARS_ID
messageheader_event MESSAGE.MESSAGE_TYPE
messageheader_receiver MESSAGE.DEST_NODE
messageheader_sender MESSAGE.SOURCE_NODE
messageheader_author_identifier MESSAGE.USER_ID
messageheader_author_fullname (new)
messageheader_author_email MESSAGE.EMAIL
diagnosticreport_identifier  
diagnosticreport_requisition JOB.CUST_JOB_REF
diagnosticreport_status  
diagnosticreport_issued MESSAGE.DATE_SENT
diagnosticreport_resultsinterpreter_fullname JOB.REPORTED_BY
diagnosticreport_media_title OBJECT.FILE_NAME
diagnosticreport_media_docstatus (new)
diagnosticreport_conclusion JOB.SUMMARY
observation_analysis_identifier RESULT.TEST_ORDER_NUMBER
observation_sender_identifier SAMPLE.TESTING_JOB_SAMP_REF
observation_receiver_identifier SAMPLE.CUST_JOB_SAMP_REF
observation_status (new)
observation_issued (new)
observation_code RESULT.TEST_REF
observation_effective TEST.DATE_TESTED
observation_dataabsentreason (new)
observation_interpretation (new)
observation_note TEST.TEST_SUMMARY
observation_value RESULT.VALUE
observation_valuequantity_unit (new)
observation_valuequantity_comparator (new)

DiagnosticReport Basic Model (Intermediary Format)

This data structure is used internally as an intermediary format when converting between CSV and FHIR messages and may help to understand the structure of the complete FHIR Profiles. See the Artifact - Resource Profiles for more detailed information.

DiagnosticReport Basic ModelMessageHeadermessageheader_idmessageheader_eventmessageheader_receivermessageheader_sendermessageheader_author_identifiermessageheader_author_fullnamemessageheader_author_emaildiagnosticreport []DiagnosticReportidentifierrequisitionstatusissuedresultsinterpreter_fullnamemedia_titlemedia_docstatusconclusionobservations []Observationanalysis_identifiersender_identifierreceiver_identifierstatusissuedcodeeffectivedataabsentreasoninterpretationnotevalueValuevaluevaluequantity_unitvaluequantity_comparatorLegend:required field
DiagnosticReport basic model used to convert between CSV and FHIR.