This page is part of the Genetic Reporting Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR v3.3.0. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/diagnosticreport
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 40 elements
Fixed Value: 2 elements
Prohibited: 1 element
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 | I | 0..* | Genetics Diagnostic Report | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
dr-relatedArtifact | SI | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, UsageContext, Dosage | Citations and supporting info URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-relatedArtifact |
dr-recommendedAction | SI | 0..* | Reference(Task | ServiceRequest | MedicationRequest | RequestGroup | CarePlan | DeviceRequest | NutritionOrder | SupplyRequest) | Tasks relevant to report URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-recommendedAction |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-recommendedAction" | |
valueReference | S | 1..1 | Reference(Task) | Recommended action tasks relevant to report |
dr-supportingInfo | SI | 0..* | Reference() | Other resources that support report URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-supportingInfo |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-supportingInfo" | |
valueReference | S | 1..1 | Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference) | Family history with relevance to report |
diagnosticReport-risk | SI | 0..* | Reference(RiskAssessment) | Extension URL: http://hl7.org/fhir/StructureDefinition/diagnosticReport-risk |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/diagnosticReport-risk" | |
valueReference | S | 1..1 | Reference(RiskAssessment) | Value of extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Business identifier for report |
basedOn | S | 0..* | Reference(ServiceRequest) | What was requested |
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | SΣ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0074","code":"GE"}]} |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Master HL7 genetic variant reporting panel Fixed Value: 81247-9 |
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Σ | 0..1 | Reference(Patient | Group | Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Health care event when test ordered |
effective[x] | SΣ | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
issued | SΣ | 0..1 | instant | DateTime this version was made |
performer | SΣ | 0..1 | Reference(Organization) | Responsible Diagnostic Service |
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
specimen | S | 0..* | Reference(Specimen) | Specimens this report is based on |
result | S | Reference(Observation) | Observations - simple, or complex nested groups Slice: Unordered, Open by pattern:resolve().code | |
result | S | 0..* | Reference(Genomics Panel) | Genetic panel |
result | S | 0..1 | Reference(Genetic analysis overall interpretation) | Assessment of overall results |
result | S | 0..1 | Reference(Deletion-duplication overall interpretation) | Assessment of deletion/duplication results |
result | S | 0..1 | Reference(Chromosome analysis overall interpretation) | Assessment of chromosomal abnormalities |
result | S | 0..* | Reference(Inherited Disease Pathogenicity) | Inherited Disease Pathology |
result | S | 0..* | Reference(Somatic Diagnostic Impact) | Somatic Diagnostic |
result | S | 0..* | Reference(Somatic Prognostic Impact) | Somatic Prognostic |
result | S | 0..* | Reference(Somatic Predictive Impact) | Somatic Predictive |
result | S | 0..* | Reference(Genotype medication metabolism impact) | Metabolism Impact |
result | S | 0..* | Reference(Genotype medication efficacy impact) | Efficacy Impact |
result | S | 0..* | Reference(High Risk Allele) | High-Risk Medication Impact |
result | S | 0..* | Reference(Chromosome analysis G-banding panel) | Chromosome G-Band results |
result | S | 0..* | Reference(Chromosome Analysis FISH panel) | Chromosome FISH-test results |
result | S | 0..* | Reference(Cytogenic Notation) | Cytogenic Notation |
result | S | 0..* | Reference(Genotype) | Genotype |
result | S | 0..* | Reference(Haplotype) | Haplotype |
result | S | 0..* | Reference(Complex variation) | Complex Variant |
result | S | 0..* | Reference(Described Variant (Discrete or Structural)) | Described Variant |
media | ΣI | 0..1 | BackboneElement | Key images associated with this report |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (example) | |
presentedForm | S | 0..* | Attachment | Entire report as issued |
Documentation for this format |
This structure is derived from DiagnosticReport
Summary
Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 40 elements
Fixed Value: 2 elements
Prohibited: 1 element
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 | I | 0..* | Genetics Diagnostic Report | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
dr-relatedArtifact | SI | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, UsageContext, Dosage | Citations and supporting info URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-relatedArtifact |
dr-recommendedAction | SI | 0..* | Reference(Task | ServiceRequest | MedicationRequest | RequestGroup | CarePlan | DeviceRequest | NutritionOrder | SupplyRequest) | Tasks relevant to report URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-recommendedAction |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-recommendedAction" | |
valueReference | S | 1..1 | Reference(Task) | Recommended action tasks relevant to report |
dr-supportingInfo | SI | 0..* | Reference() | Other resources that support report URL: http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-supportingInfo |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/dr-supportingInfo" | |
valueReference | S | 1..1 | Reference(FamilyMemberHistory | RiskAssessment | Observation | DocumentReference) | Family history with relevance to report |
diagnosticReport-risk | SI | 0..* | Reference(RiskAssessment) | Extension URL: http://hl7.org/fhir/StructureDefinition/diagnosticReport-risk |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/diagnosticReport-risk" | |
valueReference | S | 1..1 | Reference(RiskAssessment) | Value of extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Business identifier for report |
basedOn | S | 0..* | Reference(ServiceRequest) | What was requested |
status | ?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | SΣ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0074","code":"GE"}]} |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Master HL7 genetic variant reporting panel Fixed Value: 81247-9 |
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Σ | 0..1 | Reference(Patient | Group | Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Health care event when test ordered |
effective[x] | SΣ | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
issued | SΣ | 0..1 | instant | DateTime this version was made |
performer | SΣ | 0..1 | Reference(Organization) | Responsible Diagnostic Service |
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
specimen | S | 0..* | Reference(Specimen) | Specimens this report is based on |
result | S | Reference(Observation) | Observations - simple, or complex nested groups Slice: Unordered, Open by pattern:resolve().code | |
result | S | 0..* | Reference(Genomics Panel) | Genetic panel |
result | S | 0..1 | Reference(Genetic analysis overall interpretation) | Assessment of overall results |
result | S | 0..1 | Reference(Deletion-duplication overall interpretation) | Assessment of deletion/duplication results |
result | S | 0..1 | Reference(Chromosome analysis overall interpretation) | Assessment of chromosomal abnormalities |
result | S | 0..* | Reference(Inherited Disease Pathogenicity) | Inherited Disease Pathology |
result | S | 0..* | Reference(Somatic Diagnostic Impact) | Somatic Diagnostic |
result | S | 0..* | Reference(Somatic Prognostic Impact) | Somatic Prognostic |
result | S | 0..* | Reference(Somatic Predictive Impact) | Somatic Predictive |
result | S | 0..* | Reference(Genotype medication metabolism impact) | Metabolism Impact |
result | S | 0..* | Reference(Genotype medication efficacy impact) | Efficacy Impact |
result | S | 0..* | Reference(High Risk Allele) | High-Risk Medication Impact |
result | S | 0..* | Reference(Chromosome analysis G-banding panel) | Chromosome G-Band results |
result | S | 0..* | Reference(Chromosome Analysis FISH panel) | Chromosome FISH-test results |
result | S | 0..* | Reference(Cytogenic Notation) | Cytogenic Notation |
result | S | 0..* | Reference(Genotype) | Genotype |
result | S | 0..* | Reference(Haplotype) | Haplotype |
result | S | 0..* | Reference(Complex variation) | Complex Variant |
result | S | 0..* | Reference(Described Variant (Discrete or Structural)) | Described Variant |
media | ΣI | 0..1 | BackboneElement | Key images associated with this report |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (example) | |
presentedForm | S | 0..* | Attachment | Entire report as issued |
Documentation for this format |
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
DiagnosticReport.language | Common Languages | extensible | Common Languages |
DiagnosticReport.status | DiagnosticReportStatus | required | DiagnosticReportStatus |
DiagnosticReport.category | Diagnostic Service Section Codes | example | Diagnostic Service Section Codes |
DiagnosticReport.code | LOINC Diagnostic Report Codes | preferred | LOINC Diagnostic Report Codes |
DiagnosticReport.codedDiagnosis | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
Id | Path | Details | Requirements |
dom-2 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | 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.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists()) | |
ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DiagnosticReport.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | DiagnosticReport.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DiagnosticReport.media | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |