Package ca.uhn.fhir.model.dstu2.resource

Class DiagnosticReport

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.DiagnosticReport
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
public class DiagnosticReport extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR DiagnosticReport Resource (clinical.diagnostics)

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.

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

Profile Definition: http://hl7.org/fhir/profiles/DiagnosticReport

See Also:

  • Field Details

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

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

      See Also:

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

      public static final String SP_ISSUED
      Search parameter constant for issued

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

      See Also:

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

      public static final String SP_SUBJECT
      Search parameter constant for subject

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

      See Also:

    • 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

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter constant for performer

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

      See Also:

    • 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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

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

      See Also:

    • 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

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter constant for category

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

      See Also:

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

      public static final String SP_DATE
      Search parameter constant for date

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

      See Also:

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

      public static final String SP_SPECIMEN
      Search parameter constant for specimen

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

      See Also:

    • 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

    • SP_CODE

      public static final String SP_CODE
      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

      See Also:

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

      public static final String SP_RESULT
      Search parameter constant for result

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

      See Also:

    • 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

    • SP_DIAGNOSIS

      public static final String SP_DIAGNOSIS
      Search parameter constant for diagnosis

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

      See Also:

    • 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 constant for image

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

      See Also:

    • 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

    • SP_REQUEST

      public static final String SP_REQUEST
      Search parameter constant for request

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

      See Also:

    • 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

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

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

      See Also:

    • 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

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

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

      See Also:

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

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

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

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

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

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

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

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

  • Constructor Details

  • Method Details

    • isEmpty

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

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getIdentifier

      public List<IdentifierDt> getIdentifier()
      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider

    • setIdentifier

      public DiagnosticReport setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider

    • addIdentifier

      public IdentifierDt addIdentifier()
      Adds and returns a new value for identifier (id)

      Definition: 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(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider

      Parameters:
      theValue - The identifier to add (must not be null)

    • getIdentifierFirstRep

      public IdentifierDt getIdentifierFirstRep()
      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticReportStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the diagnostic report as a whole

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the diagnostic report as a whole

    • setStatus

      public DiagnosticReport setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticReportStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the diagnostic report as a whole

    • setStatus

      public DiagnosticReport setStatus(DiagnosticReportStatusEnum theValue)
      Sets the value(s) for status (status)

      Definition: The status of the diagnostic report as a whole

    • getCategory

      public CodeableConceptDt getCategory()
      Gets the value(s) for category (class). creating it if it does not exist. Will not return null.

      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.

    • setCategory

      public DiagnosticReport setCategory(CodeableConceptDt theValue)
      Sets the value(s) for category (class)

      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.

    • getCode

      public CodeableConceptDt getCode()
      Gets the value(s) for code (what). creating it if it does not exist. Will not return null.

      Definition: A code or name that describes this diagnostic report

    • setCode

      public DiagnosticReport setCode(CodeableConceptDt theValue)
      Sets the value(s) for code (what)

      Definition: A code or name that describes this diagnostic report

    • getSubject

      public ResourceReferenceDt getSubject()
      Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

      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.

    • setSubject

      public DiagnosticReport setSubject(ResourceReferenceDt theValue)
      Sets the value(s) for subject (who.focus)

      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.

    • getEncounter

      public ResourceReferenceDt getEncounter()
      Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

      Definition: The link to the health care event (encounter) when the order was made.

    • setEncounter

      public DiagnosticReport setEncounter(ResourceReferenceDt theValue)
      Sets the value(s) for encounter (context)

      Definition: The link to the health care event (encounter) when the order was made.

    • getEffective

      public ca.uhn.fhir.model.api.IDatatype getEffective()
      Gets the value(s) for effective[x] (when.done). creating it if it does not exist. Will not return null.

      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.

    • setEffective

      public DiagnosticReport setEffective(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for effective[x] (when.done)

      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.

    • getIssuedElement

      public ca.uhn.fhir.model.primitive.InstantDt getIssuedElement()
      Gets the value(s) for issued (when.recorded). creating it if it does not exist. Will not return null.

      Definition: The date and time that this version of the report was released from the source diagnostic service

    • getIssued

      public Date getIssued()
      Gets the value(s) for issued (when.recorded). creating it if it does not exist. This method may return null.

      Definition: The date and time that this version of the report was released from the source diagnostic service

    • setIssued

      public DiagnosticReport setIssued(ca.uhn.fhir.model.primitive.InstantDt theValue)
      Sets the value(s) for issued (when.recorded)

      Definition: The date and time that this version of the report was released from the source diagnostic service

    • setIssuedWithMillisPrecision

      public DiagnosticReport setIssuedWithMillisPrecision(Date theDate)
      Sets the value for issued (when.recorded)

      Definition: The date and time that this version of the report was released from the source diagnostic service

    • setIssued

      public DiagnosticReport setIssued(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for issued (when.recorded)

      Definition: The date and time that this version of the report was released from the source diagnostic service

    • getPerformer

      public ResourceReferenceDt getPerformer()
      Gets the value(s) for performer (who.witness). creating it if it does not exist. Will not return null.

      Definition: The diagnostic service that is responsible for issuing the report

    • setPerformer

      public DiagnosticReport setPerformer(ResourceReferenceDt theValue)
      Sets the value(s) for performer (who.witness)

      Definition: The diagnostic service that is responsible for issuing the report

    • getRequest

      public List<ResourceReferenceDt> getRequest()
      Gets the value(s) for request (). creating it if it does not exist. Will not return null.

      Definition: Details concerning a test or procedure requested.

    • setRequest

      public DiagnosticReport setRequest(List<ResourceReferenceDt> theValue)
      Sets the value(s) for request ()

      Definition: Details concerning a test or procedure requested.

    • addRequest

      public ResourceReferenceDt addRequest()
      Adds and returns a new value for request ()

      Definition: Details concerning a test or procedure requested.

    • getSpecimen

      public List<ResourceReferenceDt> getSpecimen()
      Gets the value(s) for specimen (). creating it if it does not exist. Will not return null.

      Definition: Details about the specimens on which this diagnostic report is based

    • setSpecimen

      public DiagnosticReport setSpecimen(List<ResourceReferenceDt> theValue)
      Sets the value(s) for specimen ()

      Definition: Details about the specimens on which this diagnostic report is based

    • addSpecimen

      public ResourceReferenceDt addSpecimen()
      Adds and returns a new value for specimen ()

      Definition: Details about the specimens on which this diagnostic report is based

    • getResult

      public List<ResourceReferenceDt> getResult()
      Gets the value(s) for result (). creating it if it does not exist. Will not return null.

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

    • setResult

      public DiagnosticReport setResult(List<ResourceReferenceDt> theValue)
      Sets the value(s) for result ()

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

    • addResult

      public ResourceReferenceDt addResult()
      Adds and returns a new value for result ()

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

    • getImagingStudy

      public List<ResourceReferenceDt> getImagingStudy()
      Gets the value(s) for imagingStudy (). creating it if it does not exist. Will not return null.

      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.

    • setImagingStudy

      public DiagnosticReport setImagingStudy(List<ResourceReferenceDt> theValue)
      Sets the value(s) for imagingStudy ()

      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.

    • addImagingStudy

      public ResourceReferenceDt addImagingStudy()
      Adds and returns a new value for imagingStudy ()

      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.

    • getImage

      public List<DiagnosticReport.Image> getImage()
      Gets the value(s) for image (). creating it if it does not exist. Will not return null.

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

    • setImage

      public DiagnosticReport setImage(List<DiagnosticReport.Image> theValue)
      Sets the value(s) for image ()

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

    • addImage

      public DiagnosticReport.Image addImage()
      Adds and returns a new value for image ()

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

    • addImage

      public DiagnosticReport addImage(DiagnosticReport.Image theValue)
      Adds a given new value for image ()

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

      Parameters:
      theValue - The image to add (must not be null)

    • getImageFirstRep

      public DiagnosticReport.Image getImageFirstRep()
      Gets the first repetition for image (), creating it if it does not already exist.

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

    • getConclusionElement

      public ca.uhn.fhir.model.primitive.StringDt getConclusionElement()
      Gets the value(s) for conclusion (). creating it if it does not exist. Will not return null.

      Definition: Concise and clinically contextualized narrative interpretation of the diagnostic report

    • getConclusion

      public String getConclusion()
      Gets the value(s) for conclusion (). creating it if it does not exist. This method may return null.

      Definition: Concise and clinically contextualized narrative interpretation of the diagnostic report

    • setConclusion

      public DiagnosticReport setConclusion(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for conclusion ()

      Definition: Concise and clinically contextualized narrative interpretation of the diagnostic report

    • setConclusion

      public DiagnosticReport setConclusion(String theString)
      Sets the value for conclusion ()

      Definition: Concise and clinically contextualized narrative interpretation of the diagnostic report

    • getCodedDiagnosis

      public List<CodeableConceptDt> getCodedDiagnosis()
      Gets the value(s) for codedDiagnosis (). creating it if it does not exist. Will not return null.

      Definition:

    • setCodedDiagnosis

      public DiagnosticReport setCodedDiagnosis(List<CodeableConceptDt> theValue)
      Sets the value(s) for codedDiagnosis ()

      Definition:

    • addCodedDiagnosis

      public CodeableConceptDt addCodedDiagnosis()
      Adds and returns a new value for codedDiagnosis ()

      Definition:

    • addCodedDiagnosis

      public DiagnosticReport addCodedDiagnosis(CodeableConceptDt theValue)
      Adds a given new value for codedDiagnosis ()

      Definition:

      Parameters:
      theValue - The codedDiagnosis to add (must not be null)

    • getCodedDiagnosisFirstRep

      public CodeableConceptDt getCodedDiagnosisFirstRep()
      Gets the first repetition for codedDiagnosis (), creating it if it does not already exist.

      Definition:

    • getPresentedForm

      public List<AttachmentDt> getPresentedForm()
      Gets the value(s) for presentedForm (). creating it if it does not exist. Will not return null.

      Definition: Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

    • setPresentedForm

      public DiagnosticReport setPresentedForm(List<AttachmentDt> theValue)
      Sets the value(s) for presentedForm ()

      Definition: 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 AttachmentDt addPresentedForm()
      Adds and returns a new value for presentedForm ()

      Definition: 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(AttachmentDt theValue)
      Adds a given new value for presentedForm ()

      Definition: Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

      Parameters:
      theValue - The presentedForm to add (must not be null)

    • getPresentedFormFirstRep

      public AttachmentDt getPresentedFormFirstRep()
      Gets the first repetition for presentedForm (), creating it if it does not already exist.

      Definition: Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

    • getResourceName

      public String getResourceName()
      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource

    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource