Package com.ibm.fhir.model.resource

Class FamilyMemberHistory.Builder

    • Method Detail

      • id

        public FamilyMemberHistory.Builder id​(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 FamilyMemberHistory.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 FamilyMemberHistory.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 FamilyMemberHistory.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 FamilyMemberHistory.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

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

      • contained

        public FamilyMemberHistory.Builder contained​(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

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

      • extension

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

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

      • extension

        public FamilyMemberHistory.Builder extension​(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

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

      • modifierExtension

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

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

      • modifierExtension

        public FamilyMemberHistory.Builder modifierExtension​(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

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

      • identifier

        public FamilyMemberHistory.Builder identifier​(Identifier... identifier)
        Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        Adds new element(s) to the existing list

        Parameters:
        identifier - External Id(s) for this record
        Returns:
        A reference to this Builder instance

      • identifier

        public FamilyMemberHistory.Builder identifier​(Collection<Identifier> identifier)
        Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        identifier - External Id(s) for this record
        Returns:
        A reference to this Builder instance

      • instantiatesCanonical

        public FamilyMemberHistory.Builder instantiatesCanonical​(Canonical... instantiatesCanonical)
        The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

        Adds new element(s) to the existing list

        Parameters:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesCanonical

        public FamilyMemberHistory.Builder instantiatesCanonical​(Collection<Canonical> instantiatesCanonical)
        The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public FamilyMemberHistory.Builder instantiatesUri​(Uri... instantiatesUri)
        The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

        Adds new element(s) to the existing list

        Parameters:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public FamilyMemberHistory.Builder instantiatesUri​(Collection<Uri> instantiatesUri)
        The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance

      • status

        public FamilyMemberHistory.Builder status​(FamilyHistoryStatus status)
        A code specifying the status of the record of the family history of a specific family member.

        This element is required.

        Parameters:
        status - partial | completed | entered-in-error | health-unknown
        Returns:
        A reference to this Builder instance

      • dataAbsentReason

        public FamilyMemberHistory.Builder dataAbsentReason​(CodeableConcept dataAbsentReason)
        Describes why the family member's history is not available.
        Parameters:
        dataAbsentReason - subject-unknown | withheld | unable-to-obtain | deferred
        Returns:
        A reference to this Builder instance

      • patient

        public FamilyMemberHistory.Builder patient​(Reference patient)
        The person who this history concerns.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        patient - Patient history is about
        Returns:
        A reference to this Builder instance

      • date

        public FamilyMemberHistory.Builder date​(DateTime date)
        The date (and possibly time) when the family member history was recorded or last updated.
        Parameters:
        date - When history was recorded or last updated
        Returns:
        A reference to this Builder instance

      • name

        public FamilyMemberHistory.Builder name​(String name)
        This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
        Parameters:
        name - The family member described
        Returns:
        A reference to this Builder instance

      • relationship

        public FamilyMemberHistory.Builder relationship​(CodeableConcept relationship)
        The type of relationship this person has to the patient (father, mother, brother etc.).

        This element is required.

        Parameters:
        relationship - Relationship to the subject
        Returns:
        A reference to this Builder instance

      • born

        public FamilyMemberHistory.Builder born​(Element born)
        The actual or approximate date of birth of the relative.

        This is a choice element with the following allowed types:

        Parameters:
        born - (approximate) date of birth
        Returns:
        A reference to this Builder instance

      • age

        public FamilyMemberHistory.Builder age​(Element age)
        The age of the relative at the time the family member history is recorded.

        This is a choice element with the following allowed types:

        Parameters:
        age - (approximate) age
        Returns:
        A reference to this Builder instance

      • estimatedAge

        public FamilyMemberHistory.Builder estimatedAge​(Boolean estimatedAge)
        If true, indicates that the age value specified is an estimated value.
        Parameters:
        estimatedAge - Age is estimated?
        Returns:
        A reference to this Builder instance

      • deceased

        public FamilyMemberHistory.Builder deceased​(Element deceased)
        Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

        This is a choice element with the following allowed types:

        Parameters:
        deceased - Dead? How old/when?
        Returns:
        A reference to this Builder instance

      • reasonCode

        public FamilyMemberHistory.Builder reasonCode​(CodeableConcept... reasonCode)
        Describes why the family member history occurred in coded or textual form.

        Adds new element(s) to the existing list

        Parameters:
        reasonCode - Why was family member history performed?
        Returns:
        A reference to this Builder instance

      • reasonCode

        public FamilyMemberHistory.Builder reasonCode​(Collection<CodeableConcept> reasonCode)
        Describes why the family member history occurred in coded or textual form.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        reasonCode - Why was family member history performed?
        Returns:
        A reference to this Builder instance

      • reasonReference

        public FamilyMemberHistory.Builder reasonReference​(Reference... reasonReference)
        Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

        Adds new element(s) to the existing list

        Parameters:
        reasonReference - Why was family member history performed?
        Returns:
        A reference to this Builder instance

      • reasonReference

        public FamilyMemberHistory.Builder reasonReference​(Collection<Reference> reasonReference)
        Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        reasonReference - Why was family member history performed?
        Returns:
        A reference to this Builder instance

      • note

        public FamilyMemberHistory.Builder note​(Annotation... note)
        This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

        Adds new element(s) to the existing list

        Parameters:
        note - General note about related person
        Returns:
        A reference to this Builder instance

      • note

        public FamilyMemberHistory.Builder note​(Collection<Annotation> note)
        This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        note - General note about related person
        Returns:
        A reference to this Builder instance

      • condition

        public FamilyMemberHistory.Builder condition​(FamilyMemberHistory.Condition... condition)
        The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

        Adds new element(s) to the existing list

        Parameters:
        condition - Condition that the related person had
        Returns:
        A reference to this Builder instance

      • condition

        public FamilyMemberHistory.Builder condition​(Collection<FamilyMemberHistory.Condition> condition)
        The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        condition - Condition that the related person had
        Returns:
        A reference to this Builder instance