FHIR New Zealand Patient Summary IG
0.7.0 - ci-build
NZ
FHIR New Zealand Patient Summary IG - Local Development build (v0.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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-04-10 |
Realm: |
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 | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/diagnostics-report-status-uv-ips | |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
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: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
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 | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for report | ||||||||||||
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
![]() ![]() |
Σ | 0..1 | instant | DateTime this version was made | ||||||||||||
![]() ![]() |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||||||||||
![]() ![]() |
0..* | Reference(Specimen (IPS)) | Specimens this report is based on | |||||||||||||
![]() ![]() |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | Observations
| ||||||||||||
![]() ![]() |
0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||||||||||
![]() ![]() |
Σ | 0..* | BackboneElement | Key images associated with this report | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Comment about the image (e.g. explanation) | |||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Media) | Reference to the image source | ||||||||||||
![]() ![]() |
0..1 | string | Clinical conclusion (interpretation) of test results | |||||||||||||
![]() ![]() |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||||||||||
![]() ![]() |
0..* | Attachment | Entire report as issued | |||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/diagnostics-report-status-uv-ips | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
![]() ![]() |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
![]() ![]() |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | Observations
| ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/diagnostics-report-status-uv-ips | |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
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: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
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 | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for report | ||||||||||||
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||||||||||
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: Diagnostics Report Status Codes - IPS (required) | ||||||||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | CodeableConceptIPS | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
| ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(Patient (IPS) | Group) | The subject of the report - usually, but not always, the patient
| ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||||||
![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||||||||||
![]() ![]() |
SOΣ | 1..1 | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this
| |||||||||||||
![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | Clinically relevant time/time-period for report
| ||||||||||||
![]() ![]() |
Σ | 0..1 | instant | DateTime this version was made | ||||||||||||
![]() ![]() |
SOΣ | 0..* | Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam) | Responsible Diagnostic Service
| ||||||||||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||||||||||
![]() ![]() |
0..* | Reference(Specimen (IPS)) | Specimens this report is based on | |||||||||||||
![]() ![]() |
0..* | Reference(Observation) | Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve() | |||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(Observation Results - Laboratory/Pathology (IPS) | Observation Results - Radiology (IPS)) | Observations
| ||||||||||||
![]() ![]() |
0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||||||||||
![]() ![]() |
Σ | 0..* | BackboneElement | Key images associated with this report | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Comment about the image (e.g. explanation) | |||||||||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Media) | Reference to the image source | ||||||||||||
![]() ![]() |
0..1 | string | Clinical conclusion (interpretation) of test results | |||||||||||||
![]() ![]() |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||||||||||
![]() ![]() |
0..* | Attachment | Entire report as issued | |||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatusUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/diagnostics-report-status-uv-ips | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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