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.3.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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: NZPS-DiagnosticReport

This profile constrains the DiagnosticReport resource to represent diagnostic test and procedure reports in a patient summary.

Usage:

• Use this Resource Profile: NZPS-Bundle
• Refer to this Resource Profile: NZPS-Composition

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DiagnosticReportUvIps

Name	Flags	Card.	Type	Description & Constraints
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
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: DiagnosticReportStatus (required): The status of the diagnostic report. Fixed Value: final
category	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject	SΣ	1..1	Reference(Patient (IPS) | Group)	The subject of the report - usually, but not always, the patient
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]	SΣ	1..1		Clinically relevant time/time-period for report
effective[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
performer	SΣ	0..*	Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam)	Responsible Diagnostic Service
Slices for result	S	0..*	Reference(Observation)	Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve()
result:observation-results	S	0..*	Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (IPS))	Observations
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DiagnosticReport.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard
DiagnosticReport.category	example	DiagnosticServiceSectionCodes http://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard
DiagnosticReport.code	preferred	LOINCDiagnosticReportCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard

Constraints

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()

Name	Flags	Card.	Type	Description & Constraints
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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: DiagnosticReportStatus (required): The status of the diagnostic report. Fixed Value: final
category	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject	SΣ	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	SΣ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
effective[x]	SΣ	1..1		Clinically relevant time/time-period for report
effective[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
issued	Σ	0..1	instant	DateTime this version was made
performer	SΣ	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	S	0..*	Reference(Observation)	Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve()
result:observation-results	S	0..*	Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DiagnosticReport.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DiagnosticReport.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard
DiagnosticReport.category	example	DiagnosticServiceSectionCodes http://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard
DiagnosticReport.code	preferred	LOINCDiagnosticReportCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard
DiagnosticReport.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
DiagnosticReport.conclusionCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Constraints

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

Summary

Differential View

This structure is derived from DiagnosticReportUvIps

Name	Flags	Card.	Type	Description & Constraints
DiagnosticReport		0..*	DiagnosticReportUvIps	A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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: DiagnosticReportStatus (required): The status of the diagnostic report. Fixed Value: final
category	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject	SΣ	1..1	Reference(Patient (IPS) | Group)	The subject of the report - usually, but not always, the patient
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
effective[x]	SΣ	1..1		Clinically relevant time/time-period for report
effective[x]All Types				Content/Rules for all Types
Slices for extension				Content/Rules for all slices
data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
performer	SΣ	0..*	Reference(Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS) | CareTeam)	Responsible Diagnostic Service
Slices for result	S	0..*	Reference(Observation)	Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve()
result:observation-results	S	0..*	Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (IPS))	Observations
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DiagnosticReport.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard
DiagnosticReport.category	example	DiagnosticServiceSectionCodes http://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard
DiagnosticReport.code	preferred	LOINCDiagnosticReportCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard

Constraints

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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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: DiagnosticReportStatus (required): The status of the diagnostic report. Fixed Value: final
category	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
code	S	1..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject	SΣ	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	SΣ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
effective[x]	SΣ	1..1		Clinically relevant time/time-period for report
effective[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
effectiveDateTime			dateTime
effectivePeriod			Period
issued	Σ	0..1	instant	DateTime this version was made
performer	SΣ	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	S	0..*	Reference(Observation)	Observation results included in the diagnostic report. Slice: Unordered, Open by profile:resolve()
result:observation-results	S	0..*	Reference(Observation Results: laboratory (IPS) | Observation Results: pathology (IPS) | Observation Results: radiology (IPS) | Observation Results (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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DiagnosticReport.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DiagnosticReport.status	required	Fixed Value: final http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard
DiagnosticReport.category	example	DiagnosticServiceSectionCodes http://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard
DiagnosticReport.code	preferred	LOINCDiagnosticReportCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard
DiagnosticReport.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
DiagnosticReport.conclusionCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard

Constraints

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

Summary

Other representations of profile: CSV, Excel, Schematron