Class DiagnosticReport

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class DiagnosticReport
    extends DomainResource
    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.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.
      • category

        protected CodeableConcept category
        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.
      • subject

        protected Reference subject
        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.
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (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.)
      • encounter

        protected Reference encounter
        The link to the health care event (encounter) when the order was made.
      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (The link to the health care event (encounter) when the order was made.)
      • effective

        protected Type effective
        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.
      • issued

        protected InstantType issued
        The date and time that this version of the report was released from the source diagnostic service.
      • performer

        protected Reference performer
        The diagnostic service that is responsible for issuing the report.
      • performerTarget

        protected Resource performerTarget
        The actual object that is the target of the reference (The diagnostic service that is responsible for issuing the report.)
      • requestTarget

        protected List<Resource> requestTarget
        The actual objects that are the target of the reference (Details concerning a test or procedure requested.)
      • specimen

        protected List<Reference> specimen
        Details about the specimens on which this diagnostic report is based.
      • specimenTarget

        protected List<Specimen> specimenTarget
        The actual objects that are the target of the reference (Details about the specimens on which this diagnostic report is based.)
      • result

        protected List<Reference> result
        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").
      • resultTarget

        protected List<Observation> resultTarget
        The actual objects that are the target of the reference (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").)
      • imagingStudy

        protected List<Reference> imagingStudy
        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.
      • imagingStudyTarget

        protected List<Resource> imagingStudyTarget
        The actual objects that are the target of the reference (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.)
      • conclusion

        protected StringType conclusion
        Concise and clinically contextualized narrative interpretation of the diagnostic report.
      • presentedForm

        protected List<Attachment> presentedForm
        Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
      • SP_RESULT

        public static final String SP_RESULT
        Search parameter: result

        Description: Link to an atomic result (observation resource)
        Type: reference
        Path: DiagnosticReport.result

        See Also:
        Constant Field Values
      • RESULT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESULT
        Fluent Client search parameter constant for result

        Description: Link to an atomic result (observation resource)
        Type: reference
        Path: DiagnosticReport.result

      • INCLUDE_RESULT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RESULT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:result".
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The status of the report
        Type: token
        Path: DiagnosticReport.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The status of the report
        Type: token
        Path: DiagnosticReport.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: The subject of the report
        Type: reference
        Path: DiagnosticReport.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: The subject of the report
        Type: reference
        Path: DiagnosticReport.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:subject".
      • SP_ISSUED

        public static final String SP_ISSUED
        Search parameter: issued

        Description: When the report was issued
        Type: date
        Path: DiagnosticReport.issued

        See Also:
        Constant Field Values
      • ISSUED

        public static final ca.uhn.fhir.rest.gclient.DateClientParam ISSUED
        Fluent Client search parameter constant for issued

        Description: When the report was issued
        Type: date
        Path: DiagnosticReport.issued

      • SP_DIAGNOSIS

        public static final String SP_DIAGNOSIS
        Search parameter: diagnosis

        Description: A coded diagnosis on the report
        Type: token
        Path: DiagnosticReport.codedDiagnosis

        See Also:
        Constant Field Values
      • DIAGNOSIS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam DIAGNOSIS
        Fluent Client search parameter constant for diagnosis

        Description: A coded diagnosis on the report
        Type: token
        Path: DiagnosticReport.codedDiagnosis

      • SP_IMAGE

        public static final String SP_IMAGE
        Search parameter: image

        Description: A reference to the image source.
        Type: reference
        Path: DiagnosticReport.image.link

        See Also:
        Constant Field Values
      • IMAGE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam IMAGE
        Fluent Client search parameter constant for image

        Description: A reference to the image source.
        Type: reference
        Path: DiagnosticReport.image.link

      • INCLUDE_IMAGE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_IMAGE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:image".
      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: The Encounter when the order was made
        Type: reference
        Path: DiagnosticReport.encounter

        See Also:
        Constant Field Values
      • ENCOUNTER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
        Fluent Client search parameter constant for encounter

        Description: The Encounter when the order was made
        Type: reference
        Path: DiagnosticReport.encounter

      • INCLUDE_ENCOUNTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:encounter".
      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
        Type: token
        Path: DiagnosticReport.code

        See Also:
        Constant Field Values
      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
        Type: token
        Path: DiagnosticReport.code

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The clinically relevant time of the report
        Type: date
        Path: DiagnosticReport.effective[x]

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: The clinically relevant time of the report
        Type: date
        Path: DiagnosticReport.effective[x]

      • SP_CATEGORY

        public static final String SP_CATEGORY
        Search parameter: category

        Description: Which diagnostic discipline/department created the report
        Type: token
        Path: DiagnosticReport.category

        See Also:
        Constant Field Values
      • CATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
        Fluent Client search parameter constant for category

        Description: Which diagnostic discipline/department created the report
        Type: token
        Path: DiagnosticReport.category

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The subject of the report if a patient
        Type: reference
        Path: DiagnosticReport.subject

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The subject of the report if a patient
        Type: reference
        Path: DiagnosticReport.subject

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:patient".
      • SP_REQUEST

        public static final String SP_REQUEST
        Search parameter: request

        Description: Reference to the test or procedure request.
        Type: reference
        Path: DiagnosticReport.request

        See Also:
        Constant Field Values
      • REQUEST

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUEST
        Fluent Client search parameter constant for request

        Description: Reference to the test or procedure request.
        Type: reference
        Path: DiagnosticReport.request

      • INCLUDE_REQUEST

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:request".
      • SP_SPECIMEN

        public static final String SP_SPECIMEN
        Search parameter: specimen

        Description: The specimen details
        Type: reference
        Path: DiagnosticReport.specimen

        See Also:
        Constant Field Values
      • SPECIMEN

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SPECIMEN
        Fluent Client search parameter constant for specimen

        Description: The specimen details
        Type: reference
        Path: DiagnosticReport.specimen

      • INCLUDE_SPECIMEN

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SPECIMEN
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:specimen".
      • SP_PERFORMER

        public static final String SP_PERFORMER
        Search parameter: performer

        Description: Who was the source of the report (organization)
        Type: reference
        Path: DiagnosticReport.performer

        See Also:
        Constant Field Values
      • PERFORMER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
        Fluent Client search parameter constant for performer

        Description: Who was the source of the report (organization)
        Type: reference
        Path: DiagnosticReport.performer

      • INCLUDE_PERFORMER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticReport:performer".
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: An identifier for the report
        Type: token
        Path: DiagnosticReport.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: An identifier for the report
        Type: token
        Path: DiagnosticReport.identifier

    • Method Detail

      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        identifier (The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.)
      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.)
      • getCategory

        public CodeableConcept getCategory()
        Returns:
        category (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.)
      • setCategory

        public DiagnosticReport setCategory​(CodeableConcept value)
        Parameters:
        value - category (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.)
      • hasCode

        public boolean hasCode()
      • getSubject

        public Reference getSubject()
        Returns:
        subject (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.)
      • setSubject

        public DiagnosticReport setSubject​(Reference value)
        Parameters:
        value - subject (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.)
      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
      • setSubjectTarget

        public DiagnosticReport setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
      • getEncounterTarget

        public Encounter getEncounterTarget()
        Returns:
        encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The link to the health care event (encounter) when the order was made.)
      • setEncounterTarget

        public DiagnosticReport setEncounterTarget​(Encounter value)
        Parameters:
        value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The link to the health care event (encounter) when the order was made.)
      • getEffective

        public Type getEffective()
        Returns:
        effective (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.)
      • getEffectiveDateTimeType

        public DateTimeType getEffectiveDateTimeType()
                                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        effective (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getEffectivePeriod

        public Period getEffectivePeriod()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        effective (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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setEffective

        public DiagnosticReport setEffective​(Type value)
        Parameters:
        value - effective (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.)
      • getIssuedElement

        public InstantType getIssuedElement()
        Returns:
        issued (The date and time that this version of the report was released from the source diagnostic service.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
      • setIssuedElement

        public DiagnosticReport setIssuedElement​(InstantType value)
        Parameters:
        value - issued (The date and time that this version of the report was released from the source diagnostic service.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value
      • getIssued

        public Date getIssued()
        Returns:
        The date and time that this version of the report was released from the source diagnostic service.
      • setIssued

        public DiagnosticReport setIssued​(Date value)
        Parameters:
        value - The date and time that this version of the report was released from the source diagnostic service.
      • getPerformerTarget

        public Resource getPerformerTarget()
        Returns:
        performer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The diagnostic service that is responsible for issuing the report.)
      • setPerformerTarget

        public DiagnosticReport setPerformerTarget​(Resource value)
        Parameters:
        value - performer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The diagnostic service that is responsible for issuing the report.)
      • getRequestTarget

        public List<ResourcegetRequestTarget()
        Returns:
        request (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Details concerning a test or procedure requested.)
      • getSpecimenTarget

        public List<SpecimengetSpecimenTarget()
        Returns:
        specimen (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Details about the specimens on which this diagnostic report is based.)
      • addSpecimenTarget

        public Specimen addSpecimenTarget()
        Returns:
        specimen (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Details about the specimens on which this diagnostic report is based.)
      • getResult

        public List<ReferencegetResult()
        Returns:
        result (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").)
      • addResult

        public Reference addResult()
        Returns:
        result (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").)
      • getResultTarget

        public List<ObservationgetResultTarget()
        Returns:
        result (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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").)
      • addResultTarget

        public Observation addResultTarget()
        Returns:
        result (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. 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").)
      • getImagingStudy

        public List<ReferencegetImagingStudy()
        Returns:
        imagingStudy (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.)
      • addImagingStudy

        public Reference addImagingStudy()
        Returns:
        imagingStudy (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.)
      • getImagingStudyTarget

        public List<ResourcegetImagingStudyTarget()
        Returns:
        imagingStudy (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
      • getConclusionElement

        public StringType getConclusionElement()
        Returns:
        conclusion (Concise and clinically contextualized narrative interpretation of the diagnostic report.). This is the underlying object with id, value and extensions. The accessor "getConclusion" gives direct access to the value
      • setConclusionElement

        public DiagnosticReport setConclusionElement​(StringType value)
        Parameters:
        value - conclusion (Concise and clinically contextualized narrative interpretation of the diagnostic report.). This is the underlying object with id, value and extensions. The accessor "getConclusion" gives direct access to the value
      • getConclusion

        public String getConclusion()
        Returns:
        Concise and clinically contextualized narrative interpretation of the diagnostic report.
      • setConclusion

        public DiagnosticReport setConclusion​(String value)
        Parameters:
        value - Concise and clinically contextualized narrative interpretation of the diagnostic report.
      • getPresentedForm

        public List<AttachmentgetPresentedForm()
        Returns:
        presentedForm (Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.)
      • addPresentedForm

        public Attachment addPresentedForm()
        Returns:
        presentedForm (Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource