Package org.linuxforhealth.fhir.model.resource

Class ImagingStudy.Builder

    • Method Detail

      • id

        public ImagingStudy.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 ImagingStudy.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 ImagingStudy.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

      • language

        public ImagingStudy.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public ImagingStudy.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 ImagingStudy.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 ImagingStudy.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 ImagingStudy.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 ImagingStudy.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 ImagingStudy.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 ImagingStudy.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 ImagingStudy.Builder identifier​(Identifier... identifier)
        Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

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

        Parameters:
        identifier - Identifiers for the whole study
        Returns:
        A reference to this Builder instance

      • identifier

        public ImagingStudy.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

        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 - Identifiers for the whole study
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public ImagingStudy.Builder status​(ImagingStudyStatus status)
        The current state of the ImagingStudy.

        This element is required.

        Parameters:
        status - registered | available | cancelled | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • modality

        public ImagingStudy.Builder modality​(Coding... modality)
        A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

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

        Parameters:
        modality - All series modality if actual acquisition modalities
        Returns:
        A reference to this Builder instance

      • modality

        public ImagingStudy.Builder modality​(java.util.Collection<Coding> modality)
        A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

        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:
        modality - All series modality if actual acquisition modalities
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • subject

        public ImagingStudy.Builder subject​(Reference subject)
        The subject, typically a patient, of the imaging study.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Who or what is the subject of the study
        Returns:
        A reference to this Builder instance

      • encounter

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

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter with which this imaging study is associated
        Returns:
        A reference to this Builder instance

      • started

        public ImagingStudy.Builder started​(DateTime started)
        Date and time the study started.
        Parameters:
        started - When the study was started
        Returns:
        A reference to this Builder instance

      • basedOn

        public ImagingStudy.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A list of the diagnostic requests that resulted in this imaging study being performed.

        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:
        basedOn - Request fulfilled
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • interpreter

        public ImagingStudy.Builder interpreter​(Reference... interpreter)
        Who read the study and interpreted the images or other content.

        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:
        interpreter - Who interpreted images
        Returns:
        A reference to this Builder instance

      • interpreter

        public ImagingStudy.Builder interpreter​(java.util.Collection<Reference> interpreter)
        Who read the study and interpreted the images or other content.

        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:
        interpreter - Who interpreted images
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • endpoint

        public ImagingStudy.Builder endpoint​(Reference... endpoint)
        The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

        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:
        endpoint - Study access endpoint
        Returns:
        A reference to this Builder instance

      • endpoint

        public ImagingStudy.Builder endpoint​(java.util.Collection<Reference> endpoint)
        The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

        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:
        endpoint - Study access endpoint
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • numberOfSeries

        public ImagingStudy.Builder numberOfSeries​(UnsignedInt numberOfSeries)
        Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
        Parameters:
        numberOfSeries - Number of Study Related Series
        Returns:
        A reference to this Builder instance

      • numberOfInstances

        public ImagingStudy.Builder numberOfInstances​(UnsignedInt numberOfInstances)
        Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
        Parameters:
        numberOfInstances - Number of Study Related Instances
        Returns:
        A reference to this Builder instance

      • procedureReference

        public ImagingStudy.Builder procedureReference​(Reference procedureReference)
        The procedure which this ImagingStudy was part of.

        Allowed resource types for this reference:

        Parameters:
        procedureReference - The performed Procedure reference
        Returns:
        A reference to this Builder instance

      • procedureCode

        public ImagingStudy.Builder procedureCode​(CodeableConcept... procedureCode)
        The code for the performed procedure type.

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

        Parameters:
        procedureCode - The performed procedure code
        Returns:
        A reference to this Builder instance

      • procedureCode

        public ImagingStudy.Builder procedureCode​(java.util.Collection<CodeableConcept> procedureCode)
        The code for the performed procedure type.

        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:
        procedureCode - The performed procedure code
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • location

        public ImagingStudy.Builder location​(Reference location)
        The principal physical location where the ImagingStudy was performed.

        Allowed resource types for this reference:

        Parameters:
        location - Where ImagingStudy occurred
        Returns:
        A reference to this Builder instance

      • reasonCode

        public ImagingStudy.Builder reasonCode​(CodeableConcept... reasonCode)
        Description of clinical condition indicating why the ImagingStudy was requested.

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

        Parameters:
        reasonCode - Why the study was requested
        Returns:
        A reference to this Builder instance

      • reasonCode

        public ImagingStudy.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Description of clinical condition indicating why the ImagingStudy was requested.

        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:
        reasonCode - Why the study was requested
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public ImagingStudy.Builder reasonReference​(Reference... reasonReference)
        Indicates another resource whose existence justifies this Study.

        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:
        reasonReference - Why was study performed
        Returns:
        A reference to this Builder instance

      • reasonReference

        public ImagingStudy.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Indicates another resource whose existence justifies this Study.

        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:
        reasonReference - Why was study performed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public ImagingStudy.Builder note​(Annotation... note)
        Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

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

        Parameters:
        note - User-defined comments
        Returns:
        A reference to this Builder instance

      • note

        public ImagingStudy.Builder note​(java.util.Collection<Annotation> note)
        Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

        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:
        note - User-defined comments
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public ImagingStudy.Builder description​(String description)
        The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
        Parameters:
        description - Institution-generated description
        Returns:
        A reference to this Builder instance

      • series

        public ImagingStudy.Builder series​(ImagingStudy.Series... series)
        Each study has one or more series of images or other content.

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

        Parameters:
        series - Each study has one or more series of instances
        Returns:
        A reference to this Builder instance

      • series

        public ImagingStudy.Builder series​(java.util.Collection<ImagingStudy.Series> series)
        Each study has one or more series of images or other content.

        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:
        series - Each study has one or more series of instances
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(ImagingStudy imagingStudy)