This page is part of the Genetic Reporting Implementation Guide (v2.0.0: STU 2) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-report |
Version: | 2.0.0 |
Name: | GenomicsReport |
Title: | Genomics Report |
Status: | Active as of 2022-05-09 04:59:16+0000 |
Definition: | Genomics profile of DiagnosticReport. |
Publisher: | HL7 Clinical Genomics Working Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-report
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
genomics-artifact | 0..* | RelatedArtifact | Genomics Artifact URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-artifact | |||||
genomics-file | 0..* | Reference(Genomics DocumentReference) | Genomics File URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-file | |||||
recommended-action | 0..* | Reference(Medication Recommendation | Followup Recommendation) | Recommended Action URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/recommended-action | |||||
genomics-risk-assessment | 0..* | Reference(RiskAssessment) | Genomics Risk Assessment URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-risk-assessment | |||||
genomic-report-note | 0..* | CodedAnnotation | Comments about the report that also contain a coded type URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-report-note | |||||
workflow-supportingInfo | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo | |||||
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. | ||||
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:coding Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:Genetics | Σ | 1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
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 | |||||
coding | Σ | 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://terminology.hl7.org/CodeSystem/v2-0074 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GE | |||||
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 | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | Σ | 0..1 | dateTime | Clinically relevant time/time-period for report | ||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |||||
result:overall | 0..1 | Reference(Overall Interpretation) | Assessment of overall results | |||||
result:diagnostic-implication | 0..* | Reference(Diagnostic Implication) | Diagnostic Implication | |||||
result:therapeutic-implication | 0..* | Reference(Therapeutic Implication) | Therapeutic Implication | |||||
result:variant | 0..* | Reference(Variant) | Variant | |||||
result:sequence-phase-relation | 0..* | Reference(Sequence Phase Relationship) | Sequence Phase Relationship | |||||
result:region-studied | 0..* | Reference(Region Studied) | Region Studied | |||||
result:genotype | 0..* | Reference(Genotype) | Genotype | |||||
result:haplotype | 0..* | Reference(Haplotype) | Haplotype | |||||
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
Documentation for this format |
This structure is derived from DiagnosticReport
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DiagnosticReport
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
genomics-artifact | 0..* | RelatedArtifact | Genomics Artifact URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-artifact | |||||
genomics-file | 0..* | Reference(Genomics DocumentReference) | Genomics File URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-file | |||||
recommended-action | 0..* | Reference(Medication Recommendation | Followup Recommendation) | Recommended Action URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/recommended-action | |||||
genomics-risk-assessment | 0..* | Reference(RiskAssessment) | Genomics Risk Assessment URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomics-risk-assessment | |||||
genomic-report-note | 0..* | CodedAnnotation | Comments about the report that also contain a coded type URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-report-note | |||||
workflow-supportingInfo | 0..* | Reference(Resource) | Other information that may be relevant to this event. URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo | |||||
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. | ||||
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by pattern:coding Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:Genetics | Σ | 1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
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 | |||||
coding | Σ | 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://terminology.hl7.org/CodeSystem/v2-0074 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GE | |||||
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 | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
effective[x] | Σ | 0..1 | dateTime | Clinically relevant time/time-period for report | ||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
Slices for result | 0..* | Reference(Observation) | Observations Slice: Unordered, Open by profile:resolve() | |||||
result:overall | 0..1 | Reference(Overall Interpretation) | Assessment of overall results | |||||
result:diagnostic-implication | 0..* | Reference(Diagnostic Implication) | Diagnostic Implication | |||||
result:therapeutic-implication | 0..* | Reference(Therapeutic Implication) | Therapeutic Implication | |||||
result:variant | 0..* | Reference(Variant) | Variant | |||||
result:sequence-phase-relation | 0..* | Reference(Sequence Phase Relationship) | Sequence Phase Relationship | |||||
result:region-studied | 0..* | Reference(Region Studied) | Region Studied | |||||
result:genotype | 0..* | Reference(Genotype) | Genotype | |||||
result:haplotype | 0..* | Reference(Haplotype) | Haplotype | |||||
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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
DiagnosticReport.language | preferred | CommonLanguages Max Binding: AllLanguages |
DiagnosticReport.status | required | DiagnosticReportStatus |
DiagnosticReport.category | example | DiagnosticServiceSectionCodes |
DiagnosticReport.category:Genetics | example | DiagnosticServiceSectionCodes |
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes |
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
Id | Grade | Path | 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 | DiagnosticReport.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:genomics-artifact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:genomics-artifact | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:genomics-file | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:genomics-file | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:recommended-action | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:recommended-action | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:genomics-risk-assessment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:genomics-risk-assessment | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:coded-note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:coded-note | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.extension:supporting-info | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.extension:supporting-info | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.category:Genetics | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.category:Genetics.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.category:Genetics.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.category:Genetics.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.category:Genetics.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.issued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.resultsInterpreter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.specimen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:overall | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:diagnostic-implication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:therapeutic-implication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:variant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:sequence-phase-relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:region-studied | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:genotype | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.result:haplotype | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.imagingStudy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.media | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.media.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.media.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.media.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | DiagnosticReport.media.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | DiagnosticReport.media.comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.media.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.conclusion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.conclusionCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | DiagnosticReport.presentedForm | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |