Package org.linuxforhealth.fhir.model.resource

Class Consent.Builder

    • Method Detail

      • id

        public Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.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 Consent.Builder identifier​(Identifier... identifier)
        Unique identifier for this copy of the Consent Statement.

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

        Parameters:
        identifier - Identifier for this record (external references)
        Returns:
        A reference to this Builder instance

      • identifier

        public Consent.Builder identifier​(java.util.Collection<Identifier> identifier)
        Unique identifier for this copy of the Consent Statement.

        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 this record (external references)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public Consent.Builder status​(ConsentState status)
        Indicates the current state of this consent.

        This element is required.

        Parameters:
        status - draft | proposed | active | rejected | inactive | entered-in-error
        Returns:
        A reference to this Builder instance

      • scope

        public Consent.Builder scope​(CodeableConcept scope)
        A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

        This element is required.

        Parameters:
        scope - Which of the four areas this resource covers (extensible)
        Returns:
        A reference to this Builder instance

      • category

        public Consent.Builder category​(CodeableConcept... category)
        A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

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

        This element is required.

        Parameters:
        category - Classification of the consent statement - for indexing/retrieval
        Returns:
        A reference to this Builder instance

      • category

        public Consent.Builder category​(java.util.Collection<CodeableConcept> category)
        A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        category - Classification of the consent statement - for indexing/retrieval
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • patient

        public Consent.Builder patient​(Reference patient)
        The patient/healthcare consumer to whom this consent applies.

        Allowed resource types for this reference:

        Parameters:
        patient - Who the consent applies to
        Returns:
        A reference to this Builder instance

      • dateTime

        public Consent.Builder dateTime​(DateTime dateTime)
        When this Consent was issued / created / indexed.
        Parameters:
        dateTime - When this Consent was created or indexed
        Returns:
        A reference to this Builder instance

      • performer

        public Consent.Builder performer​(Reference... performer)
        Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

        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:
        performer - Who is agreeing to the policy and rules
        Returns:
        A reference to this Builder instance

      • performer

        public Consent.Builder performer​(java.util.Collection<Reference> performer)
        Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

        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:
        performer - Who is agreeing to the policy and rules
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • organization

        public Consent.Builder organization​(Reference... organization)
        The organization that manages the consent, and the framework within which it is executed.

        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:
        organization - Custodian of the consent
        Returns:
        A reference to this Builder instance

      • organization

        public Consent.Builder organization​(java.util.Collection<Reference> organization)
        The organization that manages the consent, and the framework within which it is executed.

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

      • source

        public Consent.Builder source​(Element source)
        The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        source - Source from which this consent is taken
        Returns:
        A reference to this Builder instance

      • policy

        public Consent.Builder policy​(Consent.Policy... policy)
        The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

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

        Parameters:
        policy - Policies covered by this consent
        Returns:
        A reference to this Builder instance

      • policy

        public Consent.Builder policy​(java.util.Collection<Consent.Policy> policy)
        The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

        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:
        policy - Policies covered by this consent
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • policyRule

        public Consent.Builder policyRule​(CodeableConcept policyRule)
        A reference to the specific base computable regulation or policy.
        Parameters:
        policyRule - Regulation that this consents to
        Returns:
        A reference to this Builder instance

      • verification

        public Consent.Builder verification​(Consent.Verification... verification)
        Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

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

        Parameters:
        verification - Consent Verified by patient or family
        Returns:
        A reference to this Builder instance

      • verification

        public Consent.Builder verification​(java.util.Collection<Consent.Verification> verification)
        Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized 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:
        verification - Consent Verified by patient or family
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • provision

        public Consent.Builder provision​(Consent.Provision provision)
        An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
        Parameters:
        provision - Constraints to the base Consent.policyRule
        Returns:
        A reference to this Builder instance

      • build

        public Consent build()
        Build the Consent

        Required elements:

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

      • validate

        protected void validate​(Consent consent)