FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-diagnostic-report | Version: 0.7.0 | |||
| Active as of 2026-05-04 | Computable Name: NZPSDiagnosticReport | |||
This profile constrains the DiagnosticReport resource to represent diagnostic test and procedure reports in a patient summary.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | Diagnostics Report Status Codes - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 DiagnosticReportUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DiagnosticReport |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportUvIps | 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 | ||||||||||||
| 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 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 | ||||||||||||
 basedOn |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||||||||||
| status |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
| category |
Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
 subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
 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 |
SOΣ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 | ||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||||||||||
 Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
 effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
  effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||||||||||
| performer |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||||||||||
| specimen |
0..* | Reference(Specimen (IPS)) | Specimens this report is based on | |||||||||||||
| Slices for result |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
| result:observation-results |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | 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: 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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostics Report Status Codes - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| 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.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 DiagnosticReportUvIps
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| status |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
| performer |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
 Slices for result |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
 result:observation-results |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | Observations
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | Diagnostics Report Status Codes - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from DiagnosticReportUvIps
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReportUvIps | 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 | ||||||||||||
| 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 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 | ||||||||||||
| basedOn |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||||||||||
| status |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
| category |
Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
| subject |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
| 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 |
SOΣ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 | ||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||||||||||
| Slices for effective[x] |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
| effectiveDateTime |
dateTime | |||||||||||||||
| effectivePeriod |
Period | |||||||||||||||
| effective[x]:effectiveDateTime |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||||||||||
| performer |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||||||||||
| specimen |
0..* | Reference(Specimen (IPS)) | Specimens this report is based on | |||||||||||||
| Slices for result |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
| result:observation-results |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | 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: 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.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostics Report Status Codes - IPS | 📦2.0.0 | International Patient Summary Implementation Guide v2.0 |
| 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.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 DiagnosticReportUvIps
Other representations of profile: CSV, Excel, Schematron