Data Model Libraries
    Preparing search index...

    Class DiagnosticReport

    DiagnosticReport Class

    The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances.

    To support reporting for any diagnostic report into a clinical data repository.

    FHIR Specification

    • 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, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances.
    • 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.
    • FHIR Version: 5.0.0

    FHIR DiagnosticReport

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? diagnosticReportStatusEnum status category? code subject? encounter? effective? issued? performer? resultsInterpreter? specimen? result? note? study? supportingInfo? media? composition? conclusion? conclusionCode? presentedForm?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getCode setCode hasCode getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getEffective setEffective hasEffective getEffectiveDateTimeType hasEffectiveDateTimeType getEffectivePeriod hasEffectivePeriod getIssuedElement setIssuedElement hasIssuedElement getIssued setIssued hasIssued getPerformer setPerformer addPerformer hasPerformer getResultsInterpreter setResultsInterpreter addResultsInterpreter hasResultsInterpreter getSpecimen setSpecimen addSpecimen hasSpecimen getResult setResult addResult hasResult getNote setNote addNote hasNote getStudy setStudy addStudy hasStudy getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getMedia setMedia addMedia hasMedia getComposition setComposition hasComposition getConclusionElement setConclusionElement hasConclusionElement getConclusion setConclusion hasConclusion getConclusionCode setConclusionCode addConclusionCode hasConclusionCode getPresentedForm setPresentedForm addPresentedForm hasPresentedForm fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initCategory initPerformer initResultsInterpreter initSpecimen initResult initNote initStudy initSupportingInfo initMedia initConclusionCode initPresentedForm

    Constructors

    Properties

    identifier?: Identifier[]

    DiagnosticReport.identifier Element

    FHIR Specification

    • 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.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    DiagnosticReport.basedOn Element

    FHIR Specification

    diagnosticReportStatusEnum: DiagnosticReportStatusEnum

    FHIR CodeSystem: DiagnosticReportStatus

    DiagnosticReportStatusEnum

    status: null | EnumCodeType

    DiagnosticReport.status Element

    FHIR Specification

    • Short: registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown
    • Definition: The status of the diagnostic report.
    • Requirements: Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: DiagnosticReportStatusEnum

    category?: CodeableConcept[]

    DiagnosticReport.category Element

    FHIR Specification

    • 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: Multiple categories are allowed using various categorization schemes. 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code: null | CodeableConcept

    DiagnosticReport.code Element

    FHIR Specification

    • Short: Name/Code for this diagnostic report
    • Definition: A code or name that describes this diagnostic report.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject?: Reference

    DiagnosticReport.subject Element

    FHIR Specification

    encounter?: Reference

    DiagnosticReport.encounter Element

    FHIR Specification

    • Short: Health care event when test ordered
    • Definition: The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport 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 but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).
    • Requirements: Links the request to the Encounter context.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    effective?: IDataType

    DiagnosticReport.effective[x] Element

    @ChoiceDataTypesMeta('DiagnosticReport.effective[x]', ['dateTime','Period',]

    FHIR Specification

    • 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.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    issued?: InstantType

    DiagnosticReport.issued Element

    FHIR Specification

    • Short: DateTime this version was made
    • Definition: The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
    • 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.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: Reference[]

    DiagnosticReport.performer Element

    FHIR Specification

    resultsInterpreter?: Reference[]

    DiagnosticReport.resultsInterpreter Element

    FHIR Specification

    specimen?: Reference[]

    DiagnosticReport.specimen Element

    FHIR Specification

    • 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    result?: Reference[]

    DiagnosticReport.result Element

    FHIR Specification

    • Short: Observations
    • Definition: Observations that are part of this diagnostic report.
    • Comment: Observations can contain observations.
    • Requirements: Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    DiagnosticReport.note Element

    FHIR Specification

    • Short: Comments about the diagnostic report
    • Definition: Comments about the diagnostic report.
    • Comment: May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation.
    • Requirements: Need to be able to provide free text additional information.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    study?: Reference[]

    DiagnosticReport.study Element

    FHIR Specification

    • Short: Reference to full details of an analysis associated with the diagnostic report
    • Definition: One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. 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. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.
    • Comment: For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supportingInfo?: DiagnosticReportSupportingInfoComponent[]

    DiagnosticReport.supportingInfo Element

    FHIR Specification

    • Short: Additional information supporting the diagnostic report
    • Definition: This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    media?: DiagnosticReportMediaComponent[]

    DiagnosticReport.media Element

    FHIR Specification

    • Short: Key images or data associated with this report
    • Definition: A list of key images or data associated with this report. The images or data 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 or data in the report as part of their service.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    composition?: Reference

    DiagnosticReport.composition Element

    FHIR Specification

    • Short: Reference to a Composition resource for the DiagnosticReport structure
    • Definition: Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.
    • Comment: The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    conclusion?: MarkdownType

    DiagnosticReport.conclusion Element

    FHIR Specification

    • Short: Clinical conclusion (interpretation) of test results
    • Definition: Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
    • Requirements: Need to be able to provide a conclusion that is not lost among the basic result data.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    conclusionCode?: CodeableConcept[]

    DiagnosticReport.conclusionCode Element

    FHIR Specification

    • Short: Codes for the clinical conclusion of test results
    • Definition: One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    presentedForm?: Attachment[]

    DiagnosticReport.presentedForm Element

    FHIR Specification

    • 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.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided DiagnosticReport JSON to instantiate the DiagnosticReport data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR DiagnosticReport

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DiagnosticReport

      Returns undefined | DiagnosticReport

      DiagnosticReport data model or undefined for DiagnosticReport

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the basedOn property.

      Parameters

      • value: undefined | Reference[]

        the basedOn array value

      Returns this

      this

      @ReferenceTargets('DiagnosticReport.basedOn', ['CarePlan','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the basedOn array property.

      Parameters

      • value: undefined | Reference

        the basedOn value

      Returns this

      this

      @ReferenceTargets('DiagnosticReport.basedOn', ['CarePlan','ImmunizationRecommendation','MedicationRequest','NutritionOrder','ServiceRequest',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('DiagnosticReport.subject', ['Patient','Group','Device','Location','Organization','Practitioner','Medication','Substance','BiologicallyDerivedProduct',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the resultsInterpreter property.

      Parameters

      • value: undefined | Reference[]

        the resultsInterpreter array value

      Returns this

      this

      @ReferenceTargets('DiagnosticReport.resultsInterpreter', ['Practitioner','PractitionerRole','Organization','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the resultsInterpreter array property.

      Parameters

      • value: undefined | Reference

        the resultsInterpreter value

      Returns this

      this

      @ReferenceTargets('DiagnosticReport.resultsInterpreter', ['Practitioner','PractitionerRole','Organization','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnaddBasedOnhasBasedOngetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetCodesetCodehasCodegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetEffectivesetEffectivehasEffectivegetEffectiveDateTimeTypehasEffectiveDateTimeTypegetEffectivePeriodhasEffectivePeriodgetIssuedElementsetIssuedElementhasIssuedElementgetIssuedsetIssuedhasIssuedgetPerformersetPerformeraddPerformerhasPerformergetResultsInterpretersetResultsInterpreteraddResultsInterpreterhasResultsInterpretergetSpecimensetSpecimenaddSpecimenhasSpecimengetResultsetResultaddResulthasResultgetNotesetNoteaddNotehasNotegetStudysetStudyaddStudyhasStudygetSupportingInfosetSupportingInfoaddSupportingInfohasSupportingInfogetMediasetMediaaddMediahasMediagetCompositionsetCompositionhasCompositiongetConclusionElementsetConclusionElementhasConclusionElementgetConclusionsetConclusionhasConclusiongetConclusionCodesetConclusionCodeaddConclusionCodehasConclusionCodegetPresentedFormsetPresentedFormaddPresentedFormhasPresentedFormfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitCategoryinitPerformerinitResultsInterpreterinitSpecimeninitResultinitNoteinitStudyinitSupportingInfoinitMediainitConclusionCodeinitPresentedForm