Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Medtech Pathology DiagnosticReport

Official URL: https://fhir.medtechglobal.com/StructureDefinition/pathology-diagnosticreport Version: 0.0.1
Draft as of 2026-04-17 Computable Name: MedtechPathologyDiagnosticReport

DiagnosticReport FHIR resource for Medtech Pathology processes

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReport 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
... extension 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... display Σ 1..1 string Representation defined by the system
... issued Σ 1..1 instant DateTime this version was made
... performer Σ 1..* Reference(Organization) Responsible Diagnostic Service
.... 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).
Required Pattern: Organization
.... display Σ 1..1 string Text alternative for the resource
... resultsInterpreter Σ 0..1 Reference(Practitioner) Primary result interpreter
... result S 0..* Reference(Medtech Pathology Observation) Observations
... presentedForm 1..1 Attachment Entire report as issued
.... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
Example General: text/plain; charset=UTF-8, image/png
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG

Constraints

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 DiagnosticReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport DiagnosticReport
... meta
.... security 1..1 Coding Security Labels applied to this resource
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
... extension 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... identifier 1..1 Identifier Business identifier for report
.... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
.... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
.... value 1..1 string The value that is unique
... status S 1..1 code registered | partial | preliminary | final +
... category 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code
.... coding 1..1 Coding Code defined by a terminology system
..... display 1..1 string Representation defined by the system
... encounter 0..0 Health care event when test ordered
... issued 1..1 instant DateTime this version was made
... performer 1..* Reference(Organization) Responsible Diagnostic Service
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Organization
.... identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/hpi-facility-id
..... value 1..1 string The value that is unique
.... display 1..1 string Text alternative for the resource
... resultsInterpreter 0..1 Reference(Practitioner) Primary result interpreter
... specimen 0..0 Specimens this report is based on
... result S 0..* Reference(Medtech Pathology Observation) Observations
... imagingStudy 0..0 Reference to full details of imaging associated with the diagnostic report
... media 0..0 Key images associated with this report
... conclusion 0..0 Clinical conclusion (interpretation) of test results
... conclusionCode 0..0 Codes for the clinical conclusion of test results
... presentedForm 1..1 Attachment Entire report as issued
.... contentType 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 1..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business identifier for report
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) The subject of the report - usually, but not always, the patient
... effective[x] Σ 0..1 Clinically relevant time/time-period for report
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 1..1 instant DateTime this version was made
... performer Σ 1..* Reference(Organization) Responsible Diagnostic Service
.... 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 ΣC 0..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).
Required Pattern: Organization
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 1..1 string Text alternative for the resource
... resultsInterpreter Σ 0..1 Reference(Practitioner) Primary result interpreter
... result S 0..* Reference(Medtech Pathology Observation) Observations
... presentedForm 1..1 Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DiagnosticReport.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DiagnosticReport.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG
DiagnosticReport.presentedForm.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

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 DiagnosticReport

Summary

Mandatory: 13 elements(2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport 0..* DiagnosticReport 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
... extension 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... display Σ 1..1 string Representation defined by the system
... issued Σ 1..1 instant DateTime this version was made
... performer Σ 1..* Reference(Organization) Responsible Diagnostic Service
.... 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).
Required Pattern: Organization
.... display Σ 1..1 string Text alternative for the resource
... resultsInterpreter Σ 0..1 Reference(Practitioner) Primary result interpreter
... result S 0..* Reference(Medtech Pathology Observation) Observations
... presentedForm 1..1 Attachment Entire report as issued
.... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
Example General: text/plain; charset=UTF-8, image/png
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG

Constraints

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 DiagnosticReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DiagnosticReport DiagnosticReport
... meta
.... security 1..1 Coding Security Labels applied to this resource
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
... extension 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... identifier 1..1 Identifier Business identifier for report
.... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
.... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
.... value 1..1 string The value that is unique
... status S 1..1 code registered | partial | preliminary | final +
... category 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code
.... coding 1..1 Coding Code defined by a terminology system
..... display 1..1 string Representation defined by the system
... encounter 0..0 Health care event when test ordered
... issued 1..1 instant DateTime this version was made
... performer 1..* Reference(Organization) Responsible Diagnostic Service
.... type 0..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Organization
.... identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/hpi-facility-id
..... value 1..1 string The value that is unique
.... display 1..1 string Text alternative for the resource
... resultsInterpreter 0..1 Reference(Practitioner) Primary result interpreter
... specimen 0..0 Specimens this report is based on
... result S 0..* Reference(Medtech Pathology Observation) Observations
... imagingStudy 0..0 Reference to full details of imaging associated with the diagnostic report
... media 0..0 Key images associated with this report
... conclusion 0..0 Clinical conclusion (interpretation) of test results
... conclusionCode 0..0 Codes for the clinical conclusion of test results
... presentedForm 1..1 Attachment Entire report as issued
.... contentType 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 1..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: U
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 1..* (Complex) Extension
URL: http://alexapi.medtechglobal.com/fhir/StructureDefinition/pathology-diagnosticreport-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Business identifier for report
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: FILL
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
... category Σ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (preferred)
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) The subject of the report - usually, but not always, the patient
... effective[x] Σ 0..1 Clinically relevant time/time-period for report
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 1..1 instant DateTime this version was made
... performer Σ 1..* Reference(Organization) Responsible Diagnostic Service
.... 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 ΣC 0..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).
Required Pattern: Organization
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... display Σ 1..1 string Text alternative for the resource
... resultsInterpreter Σ 0..1 Reference(Practitioner) Primary result interpreter
... result S 0..* Reference(Medtech Pathology Observation) Observations
... presentedForm 1..1 Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 1..1 code Mime type of the content, with charset etc.
Binding: Mimetypes for RTF content (required)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Base64 content of the report to display in Patient Inbox
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DiagnosticReport.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DiagnosticReport.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DiagnosticReport.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.status Base required DiagnosticReportStatus 📍4.0.1 FHIR Std.
DiagnosticReport.category Base preferred Diagnostic Service Section Codes 📦4.0.1 FHIR Std.
DiagnosticReport.code Base preferred LOINC Diagnostic Report Codes 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DiagnosticReport.performer.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DiagnosticReport.presentedForm.​contentType Base required Mimetypes for RTF content 📦0.0.1 This IG
DiagnosticReport.presentedForm.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

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 DiagnosticReport

Summary

Mandatory: 13 elements(2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron