{ "resourceType": "StructureDefinition", "id": "DiagnosticReport", "text": { "status": "generated", "div": "

The narrative has been removed to reduce the size of the distribution of the Hl7.Fhir.Specification library

" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 3 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "oo" } ], "url": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "name": "DiagnosticReport", "status": "draft", "publisher": "Health Level Seven International (Orders and Observations)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/orders/index.cfm" } ] } ], "description": "Base StructureDefinition for DiagnosticReport Resource", "purpose": "To support reporting for any diagnostic report into a clinical data repository.", "fhirVersion": "3.0.0", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "type": "DiagnosticReport", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "snapshot": {}, "differential": { "element": [ { "id": "DiagnosticReport", "path": "DiagnosticReport", "short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports", "definition": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.", "comment": "This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.", "alias": [ "Report", "Test", "Result", "Results", "Labs", "Laboratory" ], "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "ORU -> OBR" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" }, { "identity": "w5", "map": "clinical.diagnostics" } ] }, { "id": "DiagnosticReport.identifier", "path": "DiagnosticReport.identifier", "short": "Business identifier for report", "definition": "Identifiers assigned to this report by the performer or other systems.", "comment": "Usually assigned by the Information System of the diagnostic service provider (filler id).", "requirements": "Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context.", "alias": [ "ReportID", "Filler ID", "Placer ID" ], "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "v2", "map": "OBR-51" }, { "identity": "rim", "map": "id" }, { "identity": "w5", "map": "id" } ] }, { "id": "DiagnosticReport.basedOn", "path": "DiagnosticReport.basedOn", "short": "What was requested", "definition": "Details concerning a test or procedure requested.", "comment": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.", "requirements": "This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon.", "alias": [ "Request" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest" } ], "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC? OBR-2/3?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=FLFS].target" } ] }, { "id": "DiagnosticReport.status", "path": "DiagnosticReport.status", "short": "registered | partial | preliminary | final +", "definition": "The status of the diagnostic report as a whole.", "comment": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.", "requirements": "Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosticReportStatus" } ], "strength": "required", "description": "The status of the diagnostic report as a whole.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/diagnostic-report-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "v2", "map": "OBR-25 (not 1:1 mapping)" }, { "identity": "rim", "map": "statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\"" }, { "identity": "w5", "map": "status" } ] }, { "id": "DiagnosticReport.category", "path": "DiagnosticReport.category", "short": "Service category", "definition": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", "comment": "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code.", "alias": [ "Department", "Sub-department", "Service", "Discipline" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosticServiceSection" } ], "strength": "example", "description": "Codes for diagnostic service sections.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" } }, "mapping": [ { "identity": "v2", "map": "OBR-24" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code" }, { "identity": "w5", "map": "class" } ] }, { "id": "DiagnosticReport.code", "path": "DiagnosticReport.code", "short": "Name/Code for this diagnostic report", "definition": "A code or name that describes this diagnostic report.", "alias": [ "Type" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosticReportCodes" } ], "strength": "preferred", "description": "Codes that describe Diagnostic Reports.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/report-codes" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "v2", "map": "OBR-4 (HL7 v2 doesn't provide an easy way to indicate both the ordered test and the performed panel)" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "what" } ] }, { "id": "DiagnosticReport.subject", "path": "DiagnosticReport.subject", "short": "The subject of the report - usually, but not always, the patient", "definition": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.", "requirements": "SHALL know the subject context.", "alias": [ "Patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Location" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "v2", "map": "PID-3 (no HL7 v2 mapping for Group or Device)" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "DiagnosticReport.context", "path": "DiagnosticReport.context", "short": "Health care event when test ordered", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.", "comment": "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).", "requirements": "Links the request to the Encounter context.", "alias": [ "Encounter" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "id": "DiagnosticReport.effective[x]", "path": "DiagnosticReport.effective[x]", "short": "Clinically relevant time/time-period for report", "definition": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", "comment": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.", "requirements": "Need to know where in the patient history to file/present this report.", "alias": [ "Observation time", "Effective Time", "Occurrence" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "v2", "map": "OBR-7" }, { "identity": "rim", "map": "effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "id": "DiagnosticReport.issued", "path": "DiagnosticReport.issued", "short": "DateTime this version was released", "definition": "The date and time that this version of the report was released from the source diagnostic service.", "comment": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.", "requirements": "Clinicians need to be able to check the date that the report was released.", "alias": [ "Date Created", "Date published", "Date Issued" ], "min": 0, "max": "1", "type": [ { "code": "instant" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBR-22" }, { "identity": "rim", "map": "participation[typeCode=VRF or AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "DiagnosticReport.performer", "path": "DiagnosticReport.performer", "short": "Participants in producing the report", "definition": "Indicates who or what participated in producing the report.", "alias": [ "Laboratory", "Service", "Practitioner", "Department", "Company" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "PRT-8 (where this PRT-4-Participation = \"PO\")" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" }, { "identity": "w5", "map": "who.witness" } ] }, { "id": "DiagnosticReport.performer.role", "path": "DiagnosticReport.performer.role", "short": "Type of performer", "definition": "Describes the type of participation (e.g. a responsible party, author, or verifier).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Role" } ], "strength": "example", "description": "Indicate a role of diagnostic report performer", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/performer-role" } }, "mapping": [ { "identity": "workflow", "map": "Event.performer.role" }, { "identity": "v2", "map": "PRT-8 (where this PRT-4-Participation = \"PO\")" }, { "identity": "rim", "map": ".functionCode" } ] }, { "id": "DiagnosticReport.performer.actor", "path": "DiagnosticReport.performer.actor", "short": "Practitioner or Organization participant", "definition": "The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report.", "comment": "This is not necessarily the source of the atomic data items. It is the entity that takes responsibility for the clinical report.", "requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "v2", "map": "PRT-8 (where this PRT-4-Participation = \"PO\")" }, { "identity": "rim", "map": ".role" } ] }, { "id": "DiagnosticReport.specimen", "path": "DiagnosticReport.specimen", "short": "Specimens this report is based on", "definition": "Details about the specimens on which this diagnostic report is based.", "comment": "If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group.", "requirements": "Need to be able to report information about the collected specimens on which the report is based.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Specimen" } ], "mapping": [ { "identity": "v2", "map": "SPM" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" } ] }, { "id": "DiagnosticReport.result", "path": "DiagnosticReport.result", "short": "Observations - simple, or complex nested groups", "definition": "Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. \"atomic\" results), or they can be grouping observations that include references to other members of the group (e.g. \"panels\").", "requirements": "Need to support individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations.", "alias": [ "Data", "Atomic Value", "Result", "Atomic result", "Data", "Test", "Analyte", "Battery", "Organizer" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation" } ], "mapping": [ { "identity": "v2", "map": "OBXs" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ] }, { "id": "DiagnosticReport.imagingStudy", "path": "DiagnosticReport.imagingStudy", "short": "Reference to full details of imaging associated with the diagnostic report", "definition": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.", "comment": "ImagingStudy and ImageManifest and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However each caters to different types of displays for different types of purposes. Neither, either, or both may be provided.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ImagingManifest" } ], "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]" } ] }, { "id": "DiagnosticReport.image", "path": "DiagnosticReport.image", "short": "Key images associated with this report", "definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", "requirements": "Many diagnostic services include images in the report as part of their service.", "alias": [ "DICOM", "Slides", "Scans" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ] }, { "id": "DiagnosticReport.image.comment", "path": "DiagnosticReport.image.comment", "short": "Comment about the image (e.g. explanation)", "definition": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.", "comment": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.", "requirements": "The provider of the report should make a comment about each image included in the report.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ] }, { "id": "DiagnosticReport.image.link", "path": "DiagnosticReport.image.link", "short": "Reference to the image source", "definition": "Reference to the image source.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Media" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".value.reference" } ] }, { "id": "DiagnosticReport.conclusion", "path": "DiagnosticReport.conclusion", "short": "Clinical Interpretation of test results", "definition": "Concise and clinically contextualized impression / summary of the diagnostic report.", "requirements": "Need to be able to provide a conclusion that is not lost among the basic result data.", "alias": [ "Report" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)" } ] }, { "id": "DiagnosticReport.codedDiagnosis", "path": "DiagnosticReport.codedDiagnosis", "short": "Codes for the conclusion", "definition": "Codes for the conclusion.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdjunctDiagnosis" } ], "strength": "example", "description": "Diagnosis codes provided as adjuncts to the report.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/clinical-findings" } }, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)" } ] }, { "id": "DiagnosticReport.presentedForm", "path": "DiagnosticReport.presentedForm", "short": "Entire report as issued", "definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", "comment": "\"application/pdf\" is recommended as the most reliable and interoperable in this context.", "requirements": "Gives laboratory the ability to provide its own fully formatted report for clinical fidelity.", "min": 0, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "text (type=ED)" } ] } ] } }