Package com.ibm.fhir.model.resource

Class AuditEvent.Builder

    • Method Detail

      • id

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

      • type

        public AuditEvent.Builder type​(Coding type)
        Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.

        This element is required.

        Parameters:
        type - Type/identifier of event
        Returns:
        A reference to this Builder instance

      • subtype

        public AuditEvent.Builder subtype​(Coding... subtype)
        Identifier for the category of event.

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

        Parameters:
        subtype - More specific type/id for the event
        Returns:
        A reference to this Builder instance

      • subtype

        public AuditEvent.Builder subtype​(java.util.Collection<Coding> subtype)
        Identifier for the category of event.

        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:
        subtype - More specific type/id for the event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • action

        public AuditEvent.Builder action​(AuditEventAction action)
        Indicator for type of action performed during the event that generated the audit.
        Parameters:
        action - Type of action performed during the event
        Returns:
        A reference to this Builder instance

      • period

        public AuditEvent.Builder period​(Period period)
        The period during which the activity occurred.
        Parameters:
        period - When the activity occurred
        Returns:
        A reference to this Builder instance

      • recorded

        public AuditEvent.Builder recorded​(java.time.ZonedDateTime recorded)
        Convenience method for setting recorded.

        This element is required.

        Parameters:
        recorded - Time when the event was recorded
        Returns:
        A reference to this Builder instance
        See Also:
        recorded(com.ibm.fhir.model.type.Instant)

      • recorded

        public AuditEvent.Builder recorded​(Instant recorded)
        The time when the event was recorded.

        This element is required.

        Parameters:
        recorded - Time when the event was recorded
        Returns:
        A reference to this Builder instance

      • outcome

        public AuditEvent.Builder outcome​(AuditEventOutcome outcome)
        Indicates whether the event succeeded or failed.
        Parameters:
        outcome - Whether the event succeeded or failed
        Returns:
        A reference to this Builder instance

      • outcomeDesc

        public AuditEvent.Builder outcomeDesc​(String outcomeDesc)
        A free text description of the outcome of the event.
        Parameters:
        outcomeDesc - Description of the event outcome
        Returns:
        A reference to this Builder instance

      • purposeOfEvent

        public AuditEvent.Builder purposeOfEvent​(CodeableConcept... purposeOfEvent)
        The purposeOfUse (reason) that was used during the event being recorded.

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

        Parameters:
        purposeOfEvent - The purposeOfUse of the event
        Returns:
        A reference to this Builder instance

      • purposeOfEvent

        public AuditEvent.Builder purposeOfEvent​(java.util.Collection<CodeableConcept> purposeOfEvent)
        The purposeOfUse (reason) that was used during the event being recorded.

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

      • agent

        public AuditEvent.Builder agent​(AuditEvent.Agent... agent)
        An actor taking an active role in the event or activity that is logged.

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

        This element is required.

        Parameters:
        agent - Actor involved in the event
        Returns:
        A reference to this Builder instance

      • agent

        public AuditEvent.Builder agent​(java.util.Collection<AuditEvent.Agent> agent)
        An actor taking an active role in the event or activity that is logged.

        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:
        agent - Actor involved in the event
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • source

        public AuditEvent.Builder source​(AuditEvent.Source source)
        The system that is reporting the event.

        This element is required.

        Parameters:
        source - Audit Event Reporter
        Returns:
        A reference to this Builder instance

      • entity

        public AuditEvent.Builder entity​(AuditEvent.Entity... entity)
        Specific instances of data or objects that have been accessed.

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

        Parameters:
        entity - Data or objects used
        Returns:
        A reference to this Builder instance

      • entity

        public AuditEvent.Builder entity​(java.util.Collection<AuditEvent.Entity> entity)
        Specific instances of data or objects that have been accessed.

        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:
        entity - Data or objects used
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public AuditEvent build()
        Build the AuditEvent

        Required elements:

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

      • validate

        protected void validate​(AuditEvent auditEvent)