Package org.linuxforhealth.fhir.model.resource

Class Citation.Builder

    • Method Detail

      • id

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

      • url

        public Citation.Builder url​(Uri url)
        An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
        Parameters:
        url - Canonical identifier for this citation, represented as a globally unique URI
        Returns:
        A reference to this Builder instance

      • identifier

        public Citation.Builder identifier​(Identifier... identifier)
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

        Parameters:
        identifier - Identifier for the Citation resource itself
        Returns:
        A reference to this Builder instance

      • identifier

        public Citation.Builder identifier​(java.util.Collection<Identifier> identifier)
        A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

      • version

        public Citation.Builder version​(String version)
        The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Parameters:
        version - Business version of the citation
        Returns:
        A reference to this Builder instance

      • name

        public Citation.Builder name​(String name)
        A natural language name identifying the citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Parameters:
        name - Name for this citation (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public Citation.Builder title​(String title)
        A short, descriptive, user-friendly title for the citation.
        Parameters:
        title - Name for this citation (human friendly)
        Returns:
        A reference to this Builder instance

      • status

        public Citation.Builder status​(PublicationStatus status)
        The status of this summary. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public Citation.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public Citation.Builder date​(DateTime date)
        The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public Citation.Builder publisher​(java.lang.String publisher)
        Convenience method for setting publisher.
        Parameters:
        publisher - The publisher of the Citation, not the publisher of the article or artifact being cited
        Returns:
        A reference to this Builder instance
        See Also:
        publisher(org.linuxforhealth.fhir.model.type.String)

      • publisher

        public Citation.Builder publisher​(String publisher)
        The name of the organization or individual that published the citation.
        Parameters:
        publisher - The publisher of the Citation, not the publisher of the article or artifact being cited
        Returns:
        A reference to this Builder instance

      • contact

        public Citation.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

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

        Parameters:
        contact - Contact details for the publisher of the Citation Resource
        Returns:
        A reference to this Builder instance

      • contact

        public Citation.Builder contact​(java.util.Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        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:
        contact - Contact details for the publisher of the Citation Resource
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public Citation.Builder description​(Markdown description)
        A free text natural language description of the citation from a consumer's perspective.
        Parameters:
        description - Natural language description of the citation
        Returns:
        A reference to this Builder instance

      • useContext

        public Citation.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.

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

        Parameters:
        useContext - The context that the Citation Resource content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public Citation.Builder useContext​(java.util.Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.

        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:
        useContext - The context that the Citation Resource content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public Citation.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the citation is intended to be used.

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

        Parameters:
        jurisdiction - Intended jurisdiction for citation (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public Citation.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the citation is intended to be used.

        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:
        jurisdiction - Intended jurisdiction for citation (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public Citation.Builder purpose​(Markdown purpose)
        Explanation of why this citation is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this citation is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public Citation.Builder copyright​(Markdown copyright)
        Use and/or publishing restrictions for the Citation, not for the cited artifact.
        Parameters:
        copyright - Use and/or publishing restrictions for the Citation, not for the cited artifact
        Returns:
        A reference to this Builder instance

      • approvalDate

        public Citation.Builder approvalDate​(Date approvalDate)
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Parameters:
        approvalDate - When the citation was approved by publisher
        Returns:
        A reference to this Builder instance

      • lastReviewDate

        public Citation.Builder lastReviewDate​(Date lastReviewDate)
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Parameters:
        lastReviewDate - When the citation was last reviewed
        Returns:
        A reference to this Builder instance

      • effectivePeriod

        public Citation.Builder effectivePeriod​(Period effectivePeriod)
        The period during which the citation content was or is planned to be in active use.
        Parameters:
        effectivePeriod - When the citation is expected to be used
        Returns:
        A reference to this Builder instance

      • author

        public Citation.Builder author​(ContactDetail... author)
        Who authored the Citation.

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

        Parameters:
        author - Who authored the Citation
        Returns:
        A reference to this Builder instance

      • author

        public Citation.Builder author​(java.util.Collection<ContactDetail> author)
        Who authored the Citation.

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

      • editor

        public Citation.Builder editor​(ContactDetail... editor)
        Who edited the Citation.

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

        Parameters:
        editor - Who edited the Citation
        Returns:
        A reference to this Builder instance

      • editor

        public Citation.Builder editor​(java.util.Collection<ContactDetail> editor)
        Who edited the Citation.

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

      • reviewer

        public Citation.Builder reviewer​(ContactDetail... reviewer)
        Who reviewed the Citation.

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

        Parameters:
        reviewer - Who reviewed the Citation
        Returns:
        A reference to this Builder instance

      • reviewer

        public Citation.Builder reviewer​(java.util.Collection<ContactDetail> reviewer)
        Who reviewed the Citation.

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

      • endorser

        public Citation.Builder endorser​(ContactDetail... endorser)
        Who endorsed the Citation.

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

        Parameters:
        endorser - Who endorsed the Citation
        Returns:
        A reference to this Builder instance

      • endorser

        public Citation.Builder endorser​(java.util.Collection<ContactDetail> endorser)
        Who endorsed the Citation.

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

      • summary

        public Citation.Builder summary​(Citation.Summary... summary)
        A human-readable display of the citation.

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

        Parameters:
        summary - A human-readable display of the citation
        Returns:
        A reference to this Builder instance

      • summary

        public Citation.Builder summary​(java.util.Collection<Citation.Summary> summary)
        A human-readable display of the citation.

        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:
        summary - A human-readable display of the citation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • classification

        public Citation.Builder classification​(Citation.Classification... classification)
        The assignment to an organizing scheme.

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

        Parameters:
        classification - The assignment to an organizing scheme
        Returns:
        A reference to this Builder instance

      • classification

        public Citation.Builder classification​(java.util.Collection<Citation.Classification> classification)
        The assignment to an organizing scheme.

        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:
        classification - The assignment to an organizing scheme
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public Citation.Builder note​(Annotation... note)
        Used for general notes and annotations not coded elsewhere.

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

        Parameters:
        note - Used for general notes and annotations not coded elsewhere
        Returns:
        A reference to this Builder instance

      • note

        public Citation.Builder note​(java.util.Collection<Annotation> note)
        Used for general notes and annotations not coded elsewhere.

        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 - Used for general notes and annotations not coded elsewhere
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • currentState

        public Citation.Builder currentState​(CodeableConcept... currentState)
        The status of the citation.

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

        Parameters:
        currentState - The status of the citation
        Returns:
        A reference to this Builder instance

      • currentState

        public Citation.Builder currentState​(java.util.Collection<CodeableConcept> currentState)
        The status of the citation.

        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:
        currentState - The status of the citation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • statusDate

        public Citation.Builder statusDate​(Citation.StatusDate... statusDate)
        An effective date or period for a status of the citation.

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

        Parameters:
        statusDate - An effective date or period for a status of the citation
        Returns:
        A reference to this Builder instance

      • statusDate

        public Citation.Builder statusDate​(java.util.Collection<Citation.StatusDate> statusDate)
        An effective date or period for a status of the citation.

        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:
        statusDate - An effective date or period for a status of the citation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatesTo

        public Citation.Builder relatesTo​(Citation.RelatesTo... relatesTo)
        Artifact related to the Citation Resource.

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

        Parameters:
        relatesTo - Artifact related to the Citation Resource
        Returns:
        A reference to this Builder instance

      • relatesTo

        public Citation.Builder relatesTo​(java.util.Collection<Citation.RelatesTo> relatesTo)
        Artifact related to the Citation Resource.

        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:
        relatesTo - Artifact related to the Citation Resource
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • citedArtifact

        public Citation.Builder citedArtifact​(Citation.CitedArtifact citedArtifact)
        The article or artifact being described.
        Parameters:
        citedArtifact - The article or artifact being described
        Returns:
        A reference to this Builder instance

      • build

        public Citation build()
        Build the Citation

        Required elements:

        • status
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Citation
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Citation per the base specification

      • validate

        protected void validate​(Citation citation)