Eyematics Core Data Set
2025.0.0-alpha - ci-build Unknown region code '276'

Eyematics Core Data Set - Local Development build (v2025.0.0-alpha) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Ophthalmic Diagnostic Report

Official URL: https://eyematics.org/fhir/eyematics-kds/StructureDefinition/OphthalmicDiagnosticReport Version: 2025.0.0-alpha
Draft as of 2025-06-25 Computable Name: MII_EyeMatics_OphthalmicDiagnosticReport

A general diagnostic report for ophthalmological findings.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!Σ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
Required Pattern: draft
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
.... category:exam SΣ 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

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/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... 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
... code SΣ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc SΣ 1..* Coding Code defined by a terminology 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://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for report
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter SΣ 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... conclusion S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern Value: draft
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.category:examexamplePattern Value: exam
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredLOINCDiagnosticReportCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/report-codes
From the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

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 S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... source S 0..1 uri Identifies where the resource comes from
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... status 1..1 code registered | partial | preliminary | final +
Required Pattern: draft
.... category:exam S 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
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/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
... code S 1..1 CodeableConcept Name/Code for this diagnostic report
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc S 1..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
... subject S 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter S 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] S 0..1 dateTime Clinically relevant time/time-period for report
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter S 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... conclusion S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm S 0..* Coding Code defined by a terminology system
...... system S 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm

doco Documentation for this format
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 SΣ 0..1 id Logical id of this artifact
... meta SΣ 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 SΣ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... 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 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.
Required Pattern: draft
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
.... category:exam SΣ 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

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/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... 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
... code SΣ 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
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc SΣ 1..* Coding Code defined by a terminology 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://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... 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 SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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
... subject SΣ 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for report
... issued Σ 0..1 instant DateTime this version was made
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter SΣ 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... 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 S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the 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
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm SΣ 0..* 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 SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... 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
... presentedForm 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
DiagnosticReport.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
DiagnosticReport.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.statusrequiredPattern Value: draft
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.category:examexamplePattern Value: exam
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredLOINCDiagnosticReportCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/report-codes
From the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

Summary

Mandatory: 7 elements
Must-Support: 22 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.category
  • The element 1 is sliced based on the value of DiagnosticReport.code.coding
  • The element 1 is sliced based on the value of DiagnosticReport.conclusionCode.coding

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
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!Σ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
Required Pattern: draft
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
.... category:exam SΣ 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

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/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... 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
... code SΣ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc SΣ 1..* Coding Code defined by a terminology 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://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for report
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter SΣ 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... conclusion S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern Value: draft
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.category:examexamplePattern Value: exam
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredLOINCDiagnosticReportCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/report-codes
From the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... source S 0..1 uri Identifies where the resource comes from
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... status 1..1 code registered | partial | preliminary | final +
Required Pattern: draft
.... category:exam S 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
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/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
... code S 1..1 CodeableConcept Name/Code for this diagnostic report
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc S 1..* Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
... subject S 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter S 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] S 0..1 dateTime Clinically relevant time/time-period for report
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter S 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... conclusion S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
.... Slices for coding S 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm S 0..* Coding Code defined by a terminology system
...... system S 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm

doco Documentation for this format

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 SΣ 0..1 id Logical id of this artifact
... meta SΣ 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 SΣ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... 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 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.
Required Pattern: draft
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
.... category:exam SΣ 1..1 CodeableConcept Category reused from Observation.category to indicate clinical exam context
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.

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/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... 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
... code SΣ 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
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:loinc SΣ 1..* Coding Code defined by a terminology 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://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 78573-3
...... display 1..1 string Representation defined by the system
Fixed Value: Ophthalmology Diagnostic study note
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... 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 SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... 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
... subject SΣ 1..1 Reference(Patient) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(Encounter) The encounter during which the ophthalmic findings were recorded
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for report
... issued Σ 0..1 instant DateTime this version was made
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization) Practitioner, team or organization responsible for the ophthalmic diagnostic report
... resultsInterpreter SΣ 0..* Reference(Practitioner | PractitionerRole) Person or role who interpreted the ophthalmic findings
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(Observation) References to individual ophthalmic observations that make up this report
... 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 S 0..1 string A brief summary of the ophthalmic findings and interpretation
... conclusionCode S 0..* CodeableConcept Conclusion presented with structured codes
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the 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
.... Slices for coding SΣ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:icd10-gm SΣ 0..* 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 SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/icd-10-gm
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... 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
... presentedForm 0..* Attachment Entire report as issued

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
DiagnosticReport.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
DiagnosticReport.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DiagnosticReport.statusrequiredPattern Value: draft
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
From the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.category:examexamplePattern Value: exam
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
From the FHIR Standard
DiagnosticReport.codepreferredLOINCDiagnosticReportCodes(a valid code from LOINC)
http://hl7.org/fhir/ValueSet/report-codes
From the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DiagnosticReport

Summary

Mandatory: 7 elements
Must-Support: 22 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.category
  • The element 1 is sliced based on the value of DiagnosticReport.code.coding
  • The element 1 is sliced based on the value of DiagnosticReport.conclusionCode.coding

 

Other representations of profile: CSV, Excel, Schematron