Package com.ibm.fhir.model.resource

Class RelatedPerson.Builder

    • Method Detail

      • id

        public RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.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 RelatedPerson.Builder identifier​(Identifier... identifier)
        Identifier for a person within a particular scope.

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

        Parameters:
        identifier - A human identifier for this person
        Returns:
        A reference to this Builder instance

      • identifier

        public RelatedPerson.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifier for a person within a particular 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.

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

      • active

        public RelatedPerson.Builder active​(Boolean active)
        Whether this related person record is in active use.
        Parameters:
        active - Whether this related person's record is in active use
        Returns:
        A reference to this Builder instance

      • patient

        public RelatedPerson.Builder patient​(Reference patient)
        The patient this person is related to.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        patient - The patient this person is related to
        Returns:
        A reference to this Builder instance

      • relationship

        public RelatedPerson.Builder relationship​(CodeableConcept... relationship)
        The nature of the relationship between a patient and the related person.

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

        Parameters:
        relationship - The nature of the relationship
        Returns:
        A reference to this Builder instance

      • relationship

        public RelatedPerson.Builder relationship​(java.util.Collection<CodeableConcept> relationship)
        The nature of the relationship between a patient and the related person.

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

      • name

        public RelatedPerson.Builder name​(HumanName... name)
        A name associated with the person.

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

        Parameters:
        name - A name associated with the person
        Returns:
        A reference to this Builder instance

      • name

        public RelatedPerson.Builder name​(java.util.Collection<HumanName> name)
        A name associated with the person.

        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:
        name - A name associated with the person
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • telecom

        public RelatedPerson.Builder telecom​(ContactPoint... telecom)
        A contact detail for the person, e.g. a telephone number or an email address.

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

        Parameters:
        telecom - A contact detail for the person
        Returns:
        A reference to this Builder instance

      • telecom

        public RelatedPerson.Builder telecom​(java.util.Collection<ContactPoint> telecom)
        A contact detail for the person, e.g. a telephone number or an email address.

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

      • gender

        public RelatedPerson.Builder gender​(AdministrativeGender gender)
        Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
        Parameters:
        gender - male | female | other | unknown
        Returns:
        A reference to this Builder instance

      • birthDate

        public RelatedPerson.Builder birthDate​(Date birthDate)
        The date on which the related person was born.
        Parameters:
        birthDate - The date on which the related person was born
        Returns:
        A reference to this Builder instance

      • address

        public RelatedPerson.Builder address​(Address... address)
        Address where the related person can be contacted or visited.

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

        Parameters:
        address - Address where the related person can be contacted or visited
        Returns:
        A reference to this Builder instance

      • address

        public RelatedPerson.Builder address​(java.util.Collection<Address> address)
        Address where the related person can be contacted or visited.

        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:
        address - Address where the related person can be contacted or visited
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • photo

        public RelatedPerson.Builder photo​(Attachment... photo)
        Image of the person.

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

        Parameters:
        photo - Image of the person
        Returns:
        A reference to this Builder instance

      • photo

        public RelatedPerson.Builder photo​(java.util.Collection<Attachment> photo)
        Image of the person.

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

      • period

        public RelatedPerson.Builder period​(Period period)
        The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
        Parameters:
        period - Period of time that this relationship is considered valid
        Returns:
        A reference to this Builder instance

      • communication

        public RelatedPerson.Builder communication​(RelatedPerson.Communication... communication)
        A language which may be used to communicate with about the patient's health.

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

        Parameters:
        communication - A language which may be used to communicate with about the patient's health
        Returns:
        A reference to this Builder instance

      • communication

        public RelatedPerson.Builder communication​(java.util.Collection<RelatedPerson.Communication> communication)
        A language which may be used to communicate with about the patient's health.

        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:
        communication - A language which may be used to communicate with about the patient's health
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(RelatedPerson relatedPerson)