This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3
(No assigned work group) | Maturity Level: 1 | Informative | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/diagnosticreport-genetics
Describes how the DiagnosticReport resource is used to report structured genetic test results
This profile was published on Fri, Oct 9, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Genomics).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DiagnosticReport.
This structure is derived from DiagnosticReport.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
DiagnosticReport-geneticsAssessedCondition | I | 0..* | Reference(Condition) | AssessedCondition URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAssessedCondition |
DiagnosticReport-geneticsFamilyMemberHistory | I | 0..* | Reference(FamilyMemberHistory) | FamilyHistory URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsFamilyMemberHistory |
DiagnosticReport-geneticsAnalysis | I | 0..* | (Complex) | Analysis URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier for report |
basedOn | 0..* | Reference(CarePlan), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(ReferralRequest) | What was requested | |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) |
code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
subject | Σ | 0..1 | Reference(Patient), Reference(Group), Reference(Device), Reference(Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Health care event when test ordered |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
issued | Σ | 0..1 | instant | DateTime this version was released |
performer | ΣI | 0..* | BackboneElement | Participants in producing the 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 |
role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (example) |
actor | Σ | 1..1 | Reference(Practitioner), Reference(Organization) | Practitioner or Organization participant |
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |
result | 0..* | Reference(Observation) | Observations - simple, or complex nested groups | |
imagingStudy | 0..* | Reference(ImagingStudy), Reference(ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
image | ΣI | 0..* | 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 | |
presentedForm | 0..* | Attachment | Entire report as issued | |
Documentation for this format |
<!-- DiagnosticReport-Genetics --> <DiagnosticReport xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business identifier for report --></identifier> <basedOn><!-- 0..* Reference(CarePlan)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)|Reference(NutritionOrder)| Reference(ProcedureRequest)|Reference(ReferralRequest) What was requested --></basedOn> <status value="[code]"/><!-- 1..1 registered | partial | preliminary | final + --> <category><!-- 0..1 CodeableConcept Service category --></category> <code><!-- 1..1 CodeableConcept Name/Code for this diagnostic report --></code> <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) The subject of the report - usually, but not always, the patient --></subject> <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) Health care event when test ordered --></context> <effective[x]><!-- 0..1 dateTime|Period Clinically relevant time/time-period for report --></effective[x]> <issued value="[instant]"/><!-- 0..1 DateTime this version was released --> <performer> 0..* BackboneElement <!-- 0..* Participants in producing the report --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <role><!-- 0..1 CodeableConcept Type of performer --></role> <actor><!-- 1..1 Reference(Practitioner)|Reference(Organization) Practitioner or Organization participant --></actor> </performer> <specimen><!-- 0..* Reference(Specimen) Specimens this report is based on --></specimen> <result><!-- 0..* Reference(Observation) Observations - simple, or complex nested groups --></result> <imagingStudy><!-- 0..* Reference(ImagingStudy)|Reference(ImagingManifest) Reference to full details of imaging associated with the diagnostic report --></imagingStudy> <image> 0..* BackboneElement <!-- 0..* Key images associated with this report --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) --> <link><!-- 1..1 Reference(Media) Reference to the image source --></link> </image> <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of test results --> <codedDiagnosis><!-- 0..0 CodeableConcept Codes for the conclusion --></codedDiagnosis> <presentedForm><!-- 0..* Attachment Entire report as issued --></presentedForm> </DiagnosticReport>
{ // DiagnosticReport-Genetics // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified orderOpen { // AssessedCondition // C? // from Element: extension }, { // FamilyHistory // C? // from Element: extension }, { // Analysis // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business identifier for report // value[x]: What was requested. One of these 6: "basedOn" : [{ Reference(CarePlan) }], //What was requested "basedOn" : [{ Reference(ImmunizationRecommendation) }], //What was requested "basedOn" : [{ Reference(MedicationRequest) }], //What was requested "basedOn" : [{ Reference(NutritionOrder) }], //What was requested "basedOn" : [{ Reference(ProcedureRequest) }], //What was requested "basedOn" : [{ Reference(ReferralRequest) }], //What was requested "status" : "<code>", // R! registered | partial | preliminary | final + "category" : { CodeableConcept }, //Service category "code" : { CodeableConcept }, // R! Name/Code for this diagnostic report // value[x]: The subject of the report - usually, but not always, the patient. One of these 4: "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Group) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Device) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Location) }, //The subject of the report - usually, but not always, the patient // value[x]: Health care event when test ordered. One of these 2: "context" : { Reference(Encounter) }, //Health care event when test ordered "context" : { Reference(EpisodeOfCare) }, //Health care event when test ordered // value[x]: Clinically relevant time/time-period for report. One of these 2: "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report "issued" : "<instant>", //DateTime this version was released "performer" : [{ BackboneElement }] // C?Participants in producing the report "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on "result" : [{ Reference(Observation) }], //Observations - simple, or complex nested groups // value[x]: Reference to full details of imaging associated with the diagnostic report. One of these 2: "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report "imagingStudy" : [{ Reference(ImagingManifest) }], //Reference to full details of imaging associated with the diagnostic report "image" : [{ BackboneElement }], // C?Key images associated with this report "conclusion" : "<string>", //Clinical Interpretation of test results "presentedForm" : [{ Attachment }], //Entire report as issued }
This structure is derived from DiagnosticReport.
Differential View
This structure is derived from DiagnosticReport.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
DiagnosticReport-geneticsAssessedCondition | I | 0..* | Reference(Condition) | AssessedCondition URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAssessedCondition |
DiagnosticReport-geneticsFamilyMemberHistory | I | 0..* | Reference(FamilyMemberHistory) | FamilyHistory URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsFamilyMemberHistory |
DiagnosticReport-geneticsAnalysis | I | 0..* | (Complex) | Analysis URL: http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier for report |
basedOn | 0..* | Reference(CarePlan), Reference(ImmunizationRecommendation), Reference(MedicationRequest), Reference(NutritionOrder), Reference(ProcedureRequest), Reference(ReferralRequest) | What was requested | |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) |
category | Σ | 0..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) |
code | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (preferred) |
subject | Σ | 0..1 | Reference(Patient), Reference(Group), Reference(Device), Reference(Location) | The subject of the report - usually, but not always, the patient |
context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Health care event when test ordered |
effective[x] | Σ | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
issued | Σ | 0..1 | instant | DateTime this version was released |
performer | ΣI | 0..* | BackboneElement | Participants in producing the 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 |
role | Σ | 0..1 | CodeableConcept | Type of performer Binding: Procedure Performer Role Codes (example) |
actor | Σ | 1..1 | Reference(Practitioner), Reference(Organization) | Practitioner or Organization participant |
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |
result | 0..* | Reference(Observation) | Observations - simple, or complex nested groups | |
imagingStudy | 0..* | Reference(ImagingStudy), Reference(ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
image | ΣI | 0..* | 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 | |
presentedForm | 0..* | Attachment | Entire report as issued | |
Documentation for this format |
XML Template
<!-- DiagnosticReport-Genetics --> <DiagnosticReport xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 0..* Identifier Business identifier for report --></identifier> <basedOn><!-- 0..* Reference(CarePlan)|Reference(ImmunizationRecommendation)|Reference(MedicationRequest)|Reference(NutritionOrder)| Reference(ProcedureRequest)|Reference(ReferralRequest) What was requested --></basedOn> <status value="[code]"/><!-- 1..1 registered | partial | preliminary | final + --> <category><!-- 0..1 CodeableConcept Service category --></category> <code><!-- 1..1 CodeableConcept Name/Code for this diagnostic report --></code> <subject><!-- 0..1 Reference(Patient)|Reference(Group)|Reference(Device)|Reference(Location) The subject of the report - usually, but not always, the patient --></subject> <context><!-- 0..1 Reference(Encounter)|Reference(EpisodeOfCare) Health care event when test ordered --></context> <effective[x]><!-- 0..1 dateTime|Period Clinically relevant time/time-period for report --></effective[x]> <issued value="[instant]"/><!-- 0..1 DateTime this version was released --> <performer> 0..* BackboneElement <!-- 0..* Participants in producing the report --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <role><!-- 0..1 CodeableConcept Type of performer --></role> <actor><!-- 1..1 Reference(Practitioner)|Reference(Organization) Practitioner or Organization participant --></actor> </performer> <specimen><!-- 0..* Reference(Specimen) Specimens this report is based on --></specimen> <result><!-- 0..* Reference(Observation) Observations - simple, or complex nested groups --></result> <imagingStudy><!-- 0..* Reference(ImagingStudy)|Reference(ImagingManifest) Reference to full details of imaging associated with the diagnostic report --></imagingStudy> <image> 0..* BackboneElement <!-- 0..* Key images associated with this report --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) --> <link><!-- 1..1 Reference(Media) Reference to the image source --></link> </image> <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of test results --> <codedDiagnosis><!-- 0..0 CodeableConcept Codes for the conclusion --></codedDiagnosis> <presentedForm><!-- 0..* Attachment Entire report as issued --></presentedForm> </DiagnosticReport>
JSON Template
{ // DiagnosticReport-Genetics // from Element: extension "meta" : { Meta }, //Metadata about the resource "implicitRules" : "<uri>", //A set of rules under which this content was created "language" : "<code>", //Language of the resource content "text" : { Narrative }, //Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified orderOpen { // AssessedCondition // C? // from Element: extension }, { // FamilyHistory // C? // from Element: extension }, { // Analysis // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored "identifier" : [{ Identifier }], //Business identifier for report // value[x]: What was requested. One of these 6: "basedOn" : [{ Reference(CarePlan) }], //What was requested "basedOn" : [{ Reference(ImmunizationRecommendation) }], //What was requested "basedOn" : [{ Reference(MedicationRequest) }], //What was requested "basedOn" : [{ Reference(NutritionOrder) }], //What was requested "basedOn" : [{ Reference(ProcedureRequest) }], //What was requested "basedOn" : [{ Reference(ReferralRequest) }], //What was requested "status" : "<code>", // R! registered | partial | preliminary | final + "category" : { CodeableConcept }, //Service category "code" : { CodeableConcept }, // R! Name/Code for this diagnostic report // value[x]: The subject of the report - usually, but not always, the patient. One of these 4: "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Group) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Device) }, //The subject of the report - usually, but not always, the patient "subject" : { Reference(Location) }, //The subject of the report - usually, but not always, the patient // value[x]: Health care event when test ordered. One of these 2: "context" : { Reference(Encounter) }, //Health care event when test ordered "context" : { Reference(EpisodeOfCare) }, //Health care event when test ordered // value[x]: Clinically relevant time/time-period for report. One of these 2: "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report "issued" : "<instant>", //DateTime this version was released "performer" : [{ BackboneElement }] // C?Participants in producing the report "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on "result" : [{ Reference(Observation) }], //Observations - simple, or complex nested groups // value[x]: Reference to full details of imaging associated with the diagnostic report. One of these 2: "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report "imagingStudy" : [{ Reference(ImagingManifest) }], //Reference to full details of imaging associated with the diagnostic report "image" : [{ BackboneElement }], // C?Key images associated with this report "conclusion" : "<string>", //Clinical Interpretation of test results "presentedForm" : [{ Attachment }], //Entire report as issued }
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.performer.role | Procedure Performer Role Codes | example | Procedure Performer Role Codes |