Package com.ibm.fhir.model.resource

Class Contract.Term.Action.Builder

    • Method Detail

      • id

        public Contract.Term.Action.Builder id​(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 Contract.Term.Action.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 Contract.Term.Action.Builder extension​(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:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public Contract.Term.Action.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 Contract.Term.Action.Builder modifierExtension​(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:
        NullPointerException - If the passed collection is null

      • doNotPerform

        public Contract.Term.Action.Builder doNotPerform​(Boolean doNotPerform)
        True if the term prohibits the action.
        Parameters:
        doNotPerform - True if the term prohibits the action
        Returns:
        A reference to this Builder instance

      • type

        public Contract.Term.Action.Builder type​(CodeableConcept type)
        Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.

        This element is required.

        Parameters:
        type - Type or form of the action
        Returns:
        A reference to this Builder instance

      • intent

        public Contract.Term.Action.Builder intent​(CodeableConcept intent)
        Reason or purpose for the action stipulated by this Contract Provision.

        This element is required.

        Parameters:
        intent - Purpose for the Contract Term Action
        Returns:
        A reference to this Builder instance

      • linkId

        public Contract.Term.Action.Builder linkId​(String... linkId)
        Convenience method for setting linkId.

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

        Parameters:
        linkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        See Also:
        #linkId(com.ibm.fhir.model.type.String)

      • linkId

        public Contract.Term.Action.Builder linkId​(String... linkId)
        Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

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

        Parameters:
        linkId - Pointer to specific item
        Returns:
        A reference to this Builder instance

      • linkId

        public Contract.Term.Action.Builder linkId​(Collection<String> linkId)
        Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

        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:
        linkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • status

        public Contract.Term.Action.Builder status​(CodeableConcept status)
        Current state of the term action.

        This element is required.

        Parameters:
        status - State of the action
        Returns:
        A reference to this Builder instance

      • context

        public Contract.Term.Action.Builder context​(Reference context)
        Encounter or Episode with primary association to specified term activity.

        Allowed resource types for this reference:

        Parameters:
        context - Episode associated with action
        Returns:
        A reference to this Builder instance

      • contextLinkId

        public Contract.Term.Action.Builder contextLinkId​(String... contextLinkId)
        Convenience method for setting contextLinkId.

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

        Parameters:
        contextLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        See Also:
        #contextLinkId(com.ibm.fhir.model.type.String)

      • contextLinkId

        public Contract.Term.Action.Builder contextLinkId​(String... contextLinkId)
        Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

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

        Parameters:
        contextLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance

      • contextLinkId

        public Contract.Term.Action.Builder contextLinkId​(Collection<String> contextLinkId)
        Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

        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:
        contextLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • occurrence

        public Contract.Term.Action.Builder occurrence​(Element occurrence)
        When action happens.

        This is a choice element with the following allowed types:

        Parameters:
        occurrence - When action happens
        Returns:
        A reference to this Builder instance

      • requesterLinkId

        public Contract.Term.Action.Builder requesterLinkId​(String... requesterLinkId)
        Convenience method for setting requesterLinkId.

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

        Parameters:
        requesterLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        See Also:
        #requesterLinkId(com.ibm.fhir.model.type.String)

      • requesterLinkId

        public Contract.Term.Action.Builder requesterLinkId​(String... requesterLinkId)
        Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

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

        Parameters:
        requesterLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance

      • requesterLinkId

        public Contract.Term.Action.Builder requesterLinkId​(Collection<String> requesterLinkId)
        Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

        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:
        requesterLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • performerType

        public Contract.Term.Action.Builder performerType​(CodeableConcept... performerType)
        The type of individual that is desired or required to perform or not perform the action.

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

        Parameters:
        performerType - Kind of service performer
        Returns:
        A reference to this Builder instance

      • performerType

        public Contract.Term.Action.Builder performerType​(Collection<CodeableConcept> performerType)
        The type of individual that is desired or required to perform or not perform the action.

        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:
        performerType - Kind of service performer
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • performerRole

        public Contract.Term.Action.Builder performerRole​(CodeableConcept performerRole)
        The type of role or competency of an individual desired or required to perform or not perform the action.
        Parameters:
        performerRole - Competency of the performer
        Returns:
        A reference to this Builder instance

      • performerLinkId

        public Contract.Term.Action.Builder performerLinkId​(String... performerLinkId)
        Convenience method for setting performerLinkId.

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

        Parameters:
        performerLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        See Also:
        #performerLinkId(com.ibm.fhir.model.type.String)

      • performerLinkId

        public Contract.Term.Action.Builder performerLinkId​(String... performerLinkId)
        Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

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

        Parameters:
        performerLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance

      • performerLinkId

        public Contract.Term.Action.Builder performerLinkId​(Collection<String> performerLinkId)
        Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

        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:
        performerLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • reasonCode

        public Contract.Term.Action.Builder reasonCode​(CodeableConcept... reasonCode)
        Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.

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

        Parameters:
        reasonCode - Why is action (not) needed?
        Returns:
        A reference to this Builder instance

      • reasonCode

        public Contract.Term.Action.Builder reasonCode​(Collection<CodeableConcept> reasonCode)
        Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.

        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 is action (not) needed?
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • reason

        public Contract.Term.Action.Builder reason​(String... reason)
        Convenience method for setting reason.

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

        Parameters:
        reason - Why action is to be performed
        Returns:
        A reference to this Builder instance
        See Also:
        #reason(com.ibm.fhir.model.type.String)

      • reason

        public Contract.Term.Action.Builder reason​(String... reason)
        Describes why the action is to be performed or not performed in textual form.

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

        Parameters:
        reason - Why action is to be performed
        Returns:
        A reference to this Builder instance

      • reason

        public Contract.Term.Action.Builder reason​(Collection<String> reason)
        Describes why the action is to be performed or not performed in textual form.

        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:
        reason - Why action is to be performed
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • reasonLinkId

        public Contract.Term.Action.Builder reasonLinkId​(String... reasonLinkId)
        Convenience method for setting reasonLinkId.

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

        Parameters:
        reasonLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        See Also:
        #reasonLinkId(com.ibm.fhir.model.type.String)

      • reasonLinkId

        public Contract.Term.Action.Builder reasonLinkId​(String... reasonLinkId)
        Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

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

        Parameters:
        reasonLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance

      • reasonLinkId

        public Contract.Term.Action.Builder reasonLinkId​(Collection<String> reasonLinkId)
        Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

        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:
        reasonLinkId - Pointer to specific item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • note

        public Contract.Term.Action.Builder note​(Annotation... note)
        Comments made about the term action made by the requester, performer, subject or other participants.

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

        Parameters:
        note - Comments about the action
        Returns:
        A reference to this Builder instance

      • note

        public Contract.Term.Action.Builder note​(Collection<Annotation> note)
        Comments made about the term action made by the requester, performer, subject or other participants.

        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 - Comments about the action
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • securityLabelNumber

        public Contract.Term.Action.Builder securityLabelNumber​(UnsignedInt... securityLabelNumber)
        Security labels that protects the action.

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

        Parameters:
        securityLabelNumber - Action restriction numbers
        Returns:
        A reference to this Builder instance

      • securityLabelNumber

        public Contract.Term.Action.Builder securityLabelNumber​(Collection<UnsignedInt> securityLabelNumber)
        Security labels that protects the action.

        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:
        securityLabelNumber - Action restriction numbers
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null