Package com.ibm.fhir.model.resource

Class DocumentReference.Context.Builder

    • Method Detail

      • id

        public DocumentReference.Context.Builder id​(java.lang.String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public DocumentReference.Context.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public DocumentReference.Context.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.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 DocumentReference.Context.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public DocumentReference.Context.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • encounter

        public DocumentReference.Context.Builder encounter​(Reference... encounter)
        Describes the clinical encounter or type of care that the document content is associated with.

        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:
        encounter - Context of the document content
        Returns:
        A reference to this Builder instance

      • encounter

        public DocumentReference.Context.Builder encounter​(java.util.Collection<Reference> encounter)
        Describes the clinical encounter or type of care that the document content is associated with.

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

      • event

        public DocumentReference.Context.Builder event​(CodeableConcept... event)
        This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

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

        Parameters:
        event - Main clinical acts documented
        Returns:
        A reference to this Builder instance

      • event

        public DocumentReference.Context.Builder event​(java.util.Collection<CodeableConcept> event)
        This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

        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:
        event - Main clinical acts documented
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • period

        public DocumentReference.Context.Builder period​(Period period)
        The time period over which the service that is described by the document was provided.
        Parameters:
        period - Time of service that is being documented
        Returns:
        A reference to this Builder instance

      • facilityType

        public DocumentReference.Context.Builder facilityType​(CodeableConcept facilityType)
        The kind of facility where the patient was seen.
        Parameters:
        facilityType - Kind of facility where patient was seen
        Returns:
        A reference to this Builder instance

      • practiceSetting

        public DocumentReference.Context.Builder practiceSetting​(CodeableConcept practiceSetting)
        This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
        Parameters:
        practiceSetting - Additional details about where the content was created (e.g. clinical specialty)
        Returns:
        A reference to this Builder instance

      • sourcePatientInfo

        public DocumentReference.Context.Builder sourcePatientInfo​(Reference sourcePatientInfo)
        The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

        Allowed resource types for this reference:

        Parameters:
        sourcePatientInfo - Patient demographics from source
        Returns:
        A reference to this Builder instance

      • related

        public DocumentReference.Context.Builder related​(Reference... related)
        Related identifiers or resources associated with the DocumentReference.

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

        Parameters:
        related - Related identifiers or resources
        Returns:
        A reference to this Builder instance

      • related

        public DocumentReference.Context.Builder related​(java.util.Collection<Reference> related)
        Related identifiers or resources associated with the DocumentReference.

        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:
        related - Related identifiers or resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null