Package org.linuxforhealth.fhir.model.resource

Class DiagnosticReport.Builder

    • Method Detail

      • id

        public DiagnosticReport.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public DiagnosticReport.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public DiagnosticReport.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public DiagnosticReport.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public DiagnosticReport.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public DiagnosticReport.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public DiagnosticReport.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public DiagnosticReport.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public DiagnosticReport.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public DiagnosticReport.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public DiagnosticReport.Builder identifier​(Identifier... identifier)
        Identifiers assigned to this report by the performer or other systems.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Business identifier for report
        Returns:
        A reference to this Builder instance

      • identifier

        public DiagnosticReport.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifiers assigned to this report by the performer or other systems.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Business identifier for report
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public DiagnosticReport.Builder status​(DiagnosticReportStatus status)
        The status of the diagnostic report.

        This element is required.

        Parameters:
        status - registered | partial | preliminary | final +
        Returns:
        A reference to this Builder instance

      • category

        public DiagnosticReport.Builder category​(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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Service category
        Returns:
        A reference to this Builder instance

      • category

        public DiagnosticReport.Builder category​(java.util.Collection<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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Service category
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • code

        public DiagnosticReport.Builder code​(CodeableConcept code)
        A code or name that describes this diagnostic report.

        This element is required.

        Parameters:
        code - Name/Code for this diagnostic report
        Returns:
        A reference to this Builder instance

      • encounter

        public DiagnosticReport.Builder encounter​(Reference encounter)
        The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

        Allowed resource types for this reference:

        Parameters:
        encounter - Health care event when test ordered
        Returns:
        A reference to this Builder instance

      • effective

        public DiagnosticReport.Builder effective​(Element 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.

        This is a choice element with the following allowed types:

        Parameters:
        effective - Clinically relevant time/time-period for report
        Returns:
        A reference to this Builder instance

      • issued

        public DiagnosticReport.Builder issued​(Instant issued)
        The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
        Parameters:
        issued - DateTime this version was made
        Returns:
        A reference to this Builder instance

      • performer

        public DiagnosticReport.Builder performer​(Reference... performer)
        The diagnostic service that is responsible for issuing the report.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        performer - Responsible Diagnostic Service
        Returns:
        A reference to this Builder instance

      • performer

        public DiagnosticReport.Builder performer​(java.util.Collection<Reference> performer)
        The diagnostic service that is responsible for issuing the report.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        performer - Responsible Diagnostic Service
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • resultsInterpreter

        public DiagnosticReport.Builder resultsInterpreter​(Reference... resultsInterpreter)
        The practitioner or organization that is responsible for the report's conclusions and interpretations.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        resultsInterpreter - Primary result interpreter
        Returns:
        A reference to this Builder instance

      • resultsInterpreter

        public DiagnosticReport.Builder resultsInterpreter​(java.util.Collection<Reference> resultsInterpreter)
        The practitioner or organization that is responsible for the report's conclusions and interpretations.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        resultsInterpreter - Primary result interpreter
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • specimen

        public DiagnosticReport.Builder specimen​(Reference... specimen)
        Details about the specimens on which this diagnostic report is based.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        specimen - Specimens this report is based on
        Returns:
        A reference to this Builder instance

      • specimen

        public DiagnosticReport.Builder specimen​(java.util.Collection<Reference> specimen)
        Details about the specimens on which this diagnostic report is based.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        specimen - Specimens this report is based on
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • result

        public DiagnosticReport.Builder result​(Reference... result)
        [Observations](observation.html) that are part of this diagnostic report.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        result - Observations
        Returns:
        A reference to this Builder instance

      • result

        public DiagnosticReport.Builder result​(java.util.Collection<Reference> result)
        [Observations](observation.html) that are part of this diagnostic report.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        result - Observations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • imagingStudy

        public DiagnosticReport.Builder imagingStudy​(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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        imagingStudy - Reference to full details of imaging associated with the diagnostic report
        Returns:
        A reference to this Builder instance

      • imagingStudy

        public DiagnosticReport.Builder imagingStudy​(java.util.Collection<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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        imagingStudy - Reference to full details of imaging associated with the diagnostic report
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • media

        public DiagnosticReport.Builder media​(DiagnosticReport.Media... media)
        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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        media - Key images associated with this report
        Returns:
        A reference to this Builder instance

      • media

        public DiagnosticReport.Builder media​(java.util.Collection<DiagnosticReport.Media> media)
        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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        media - Key images associated with this report
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • conclusion

        public DiagnosticReport.Builder conclusion​(String conclusion)
        Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
        Parameters:
        conclusion - Clinical conclusion (interpretation) of test results
        Returns:
        A reference to this Builder instance

      • conclusionCode

        public DiagnosticReport.Builder conclusionCode​(CodeableConcept... conclusionCode)
        One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        conclusionCode - Codes for the clinical conclusion of test results
        Returns:
        A reference to this Builder instance

      • conclusionCode

        public DiagnosticReport.Builder conclusionCode​(java.util.Collection<CodeableConcept> conclusionCode)
        One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        conclusionCode - Codes for the clinical conclusion of test results
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • presentedForm

        public DiagnosticReport.Builder presentedForm​(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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        presentedForm - Entire report as issued
        Returns:
        A reference to this Builder instance

      • presentedForm

        public DiagnosticReport.Builder presentedForm​(java.util.Collection<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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        presentedForm - Entire report as issued
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null