Breast Screening NZ FHIR Implementation Guide
1.1.5 - Release
Breast Screening NZ FHIR Implementation Guide
1.1.5 - Release
Breast Screening NZ FHIR Implementation Guide - Local Development build (v1.1.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaDiagnosticReport | Version: 1.1.5 | |||
| Active as of 2026-10-07 | Computable Name: BSADiagnosticReport | |||
Describes a participant's BSA screening outcomes and radiologist assessment reports
DiagnosticReport - Breast Screening
This profile defines constraints on the DiagnosticReport resource for representing a participant's BSA screening outcomes and radiologist assessment reports
The participant's NHI is usually used to get their Care Plan details, although there are options to include a status parameter to narrow down the results, e.g. draft, active, ended
There is an option to return all plans between a date range or by status. Where a status is used then multiple different status can be entered but must be comma separated. These types of calls will return a large result set.
Diagnostic reports are usually searched by the NHI. Only one NHI is allowed per search. Searches by NHI and Status and by Date Range are allowed.
Searching on just the Status is allowed, with options to search by Final, or Preliminary being supported. This is likely to return a large number of reports.
| Te Puna Status | FHIR Status | Description |
|---|---|---|
| DRAFT_NOT_STARTED | registered | The existence of the report is registered, but there is nothing yet available. |
| DRAFT_IN_PROGRESS | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. |
| DOUBLE_READ_IN_PROGRESS | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. |
| PENDING_DOUBLE_READ | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. |
| COMPLETED | partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. |
| COMPLETED_REPORT_SENT | final | The report is complete and verified by an authorized person. |
| ADDENDUM_IN_PROGRESS | amended | Subsequent to being final, the report has been modified. This includes any change in the results, diagnosis, narrative text, or other content of a report that has been issued. |
Use Cases
Search Radiologist report by NHI
Search Radiologist report by NHI and Date Range
Search Radiologist report by NHI and Status
Screening Use Case Summary
Care Plan - the participant's overall participation in the BreastScreen Aotearoa programme.
Dagnostic Report - a participant's Radiologist report
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 status |
1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
 code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | |
 subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
 effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| basedOn |
0..0 | What was requested | ||
| subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
| encounter |
0..0 | Health care event when test ordered | ||
| effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| resultsInterpreter |
0..0 | Primary result interpreter | ||
| imagingStudy |
0..0 | Reference to full details of imaging associated with the diagnostic report | ||
| conclusion |
0..0 | Clinical conclusion (interpretation) of test results | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| 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 | Business identifier for report | |
| status |
1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
| category |
0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | |
| subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
| effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| issued |
0..1 | instant | DateTime this version was made | |
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | |
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |
| result |
0..* | Reference(Observation) | Observations | |
 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 | |
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |
| presentedForm |
0..* | Attachment | Entire report as issued | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DiagnosticReport
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | |
| subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
| effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| basedOn |
0..0 | What was requested | ||
| subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
| encounter |
0..0 | Health care event when test ordered | ||
| effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| resultsInterpreter |
0..0 | Primary result interpreter | ||
| imagingStudy |
0..0 | Reference to full details of imaging associated with the diagnostic report | ||
| conclusion |
0..0 | Clinical conclusion (interpretation) of test results | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| 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 | Business identifier for report | |
| status |
1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
| category |
0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | |
| subject |
0..1 | Reference(Patient) | NHI Id of Patient enrolled in breast screening | |
| effective[x] |
0..1 | dateTime | Date of the screening event that the report relates to | |
| issued |
0..1 | instant | DateTime this version was made | |
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | |
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |
| result |
0..* | Reference(Observation) | Observations | |
| 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 | |
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |
| presentedForm |
0..* | Attachment | Entire report as issued | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from DiagnosticReport
Other representations of profile: CSV, Excel, Schematron