Package org.hl7.fhir.dstu2.model

Class DiagnosticReport

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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:

  • Field Details

    • 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.

    • status

      protected Enumeration<DiagnosticReport.DiagnosticReportStatus> status
      The status of the diagnostic report as a whole.

    • 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.

    • code

      protected CodeableConcept code
      A code or name that describes this diagnostic report.

    • 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.)

    • request

      protected List<Reference> request
      Details concerning a test or procedure requested.

    • 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.)

    • image

      protected List<DiagnosticReport.DiagnosticReportImageComponent> image
      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).

    • conclusion

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

    • codedDiagnosis

      protected List<CodeableConcept> codedDiagnosis
      Codes for the conclusion.

    • 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_DATE

      public static final String SP_DATE
      See Also:

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      See Also:

    • SP_IMAGE

      public static final String SP_IMAGE
      See Also:

    • SP_REQUEST

      public static final String SP_REQUEST
      See Also:

    • SP_PERFORMER

      public static final String SP_PERFORMER
      See Also:

    • SP_CODE

      public static final String SP_CODE
      See Also:

    • SP_SUBJECT

      public static final String SP_SUBJECT
      See Also:

    • SP_DIAGNOSIS

      public static final String SP_DIAGNOSIS
      See Also:

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      See Also:

    • SP_RESULT

      public static final String SP_RESULT
      See Also:

    • SP_PATIENT

      public static final String SP_PATIENT
      See Also:

    • SP_SPECIMEN

      public static final String SP_SPECIMEN
      See Also:

    • SP_ISSUED

      public static final String SP_ISSUED
      See Also:

    • SP_CATEGORY

      public static final String SP_CATEGORY
      See Also:

    • SP_STATUS

      public static final String SP_STATUS
      See Also:

  • Constructor Details

  • Method Details

    • getIdentifier

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

    • hasIdentifier

      public boolean hasIdentifier()

    • 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.)

    • addIdentifier

      public DiagnosticReport addIdentifier(Identifier t)

    • getStatusElement

      public Enumeration<DiagnosticReport.DiagnosticReportStatus> getStatusElement()
      Returns:
      status (The status of the diagnostic report as a whole.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public DiagnosticReport setStatusElement(Enumeration<DiagnosticReport.DiagnosticReportStatus> value)
      Parameters:
      value - status (The status of the diagnostic report as a whole.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public DiagnosticReport.DiagnosticReportStatus getStatus()
      Returns:
      The status of the diagnostic report as a whole.

    • setStatus

      public DiagnosticReport setStatus(DiagnosticReport.DiagnosticReportStatus value)
      Parameters:
      value - The status of the diagnostic report as a whole.

    • 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.)

    • hasCategory

      public boolean hasCategory()

    • 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.)

    • getCode

      public CodeableConcept getCode()
      Returns:
      code (A code or name that describes this diagnostic report.)

    • hasCode

      public boolean hasCode()

    • setCode

      public DiagnosticReport setCode(CodeableConcept value)
      Parameters:
      value - code (A code or name that describes this diagnostic report.)

    • 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.)

    • hasSubject

      public boolean hasSubject()

    • 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.)

    • getEncounter

      public Reference getEncounter()
      Returns:
      encounter (The link to the health care event (encounter) when the order was made.)

    • hasEncounter

      public boolean hasEncounter()

    • setEncounter

      public DiagnosticReport setEncounter(Reference value)
      Parameters:
      value - encounter (The link to the health care event (encounter) when the order was made.)

    • 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

    • hasEffectiveDateTimeType

      public boolean hasEffectiveDateTimeType()

    • 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

    • hasEffectivePeriod

      public boolean hasEffectivePeriod()

    • hasEffective

      public boolean hasEffective()

    • 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

    • hasIssuedElement

      public boolean hasIssuedElement()

    • hasIssued

      public boolean hasIssued()

    • 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.

    • getPerformer

      public Reference getPerformer()
      Returns:
      performer (The diagnostic service that is responsible for issuing the report.)

    • hasPerformer

      public boolean hasPerformer()

    • setPerformer

      public DiagnosticReport setPerformer(Reference value)
      Parameters:
      value - performer (The diagnostic service that is responsible for issuing the report.)

    • 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.)

    • getRequest

      public List<Reference> getRequest()
      Returns:
      request (Details concerning a test or procedure requested.)

    • hasRequest

      public boolean hasRequest()

    • addRequest

      public Reference addRequest()
      Returns:
      request (Details concerning a test or procedure requested.)

    • addRequest

      public DiagnosticReport addRequest(Reference t)

    • getRequestTarget

      public List<Resource> getRequestTarget()
      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.)

    • getSpecimen

      public List<Reference> getSpecimen()
      Returns:
      specimen (Details about the specimens on which this diagnostic report is based.)

    • hasSpecimen

      public boolean hasSpecimen()

    • addSpecimen

      public Reference addSpecimen()
      Returns:
      specimen (Details about the specimens on which this diagnostic report is based.)

    • addSpecimen

      public DiagnosticReport addSpecimen(Reference t)

    • getSpecimenTarget

      public List<Specimen> getSpecimenTarget()
      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<Reference> getResult()
      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").)

    • hasResult

      public boolean hasResult()

    • 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").)

    • addResult

      public DiagnosticReport addResult(Reference t)

    • getResultTarget

      public List<Observation> getResultTarget()
      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<Reference> getImagingStudy()
      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.)

    • hasImagingStudy

      public boolean hasImagingStudy()

    • 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.)

    • addImagingStudy

      public DiagnosticReport addImagingStudy(Reference t)

    • getImagingStudyTarget

      public List<Resource> getImagingStudyTarget()
      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.)

    • getImage

      public List<DiagnosticReport.DiagnosticReportImageComponent> getImage()
      Returns:
      image (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).)

    • hasImage

      public boolean hasImage()

    • addImage

      public DiagnosticReport.DiagnosticReportImageComponent addImage()
      Returns:
      image (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).)

    • addImage

      public DiagnosticReport addImage(DiagnosticReport.DiagnosticReportImageComponent t)

    • 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

    • hasConclusionElement

      public boolean hasConclusionElement()

    • hasConclusion

      public boolean hasConclusion()

    • 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.

    • getCodedDiagnosis

      public List<CodeableConcept> getCodedDiagnosis()
      Returns:
      codedDiagnosis (Codes for the conclusion.)

    • hasCodedDiagnosis

      public boolean hasCodedDiagnosis()

    • addCodedDiagnosis

      public CodeableConcept addCodedDiagnosis()
      Returns:
      codedDiagnosis (Codes for the conclusion.)

    • addCodedDiagnosis

      public DiagnosticReport addCodedDiagnosis(CodeableConcept t)

    • getPresentedForm

      public List<Attachment> getPresentedForm()
      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.)

    • hasPresentedForm

      public boolean hasPresentedForm()

    • 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.)

    • addPresentedForm

      public DiagnosticReport addPresentedForm(Attachment t)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

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

    • copy

      public DiagnosticReport copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected DiagnosticReport typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource