Class AuditEvent.Participant

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    AuditEvent

    public static class AuditEvent.Participant
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: AuditEvent.participant ()

    Definition:

    See Also:
    Serialized Form
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getRole

        public List<CodeableConceptDtgetRole()
        Gets the value(s) for role (). creating it if it does not exist. Will not return null.

        Definition: Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context

      • setRole

        public AuditEvent.Participant setRole​(List<CodeableConceptDt> theValue)
        Sets the value(s) for role ()

        Definition: Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context

      • addRole

        public CodeableConceptDt addRole()
        Adds and returns a new value for role ()

        Definition: Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context

      • addRole

        public AuditEvent.Participant addRole​(CodeableConceptDt theValue)
        Adds a given new value for role ()

        Definition: Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context

        Parameters:
        theValue - The role to add (must not be null)
      • getRoleFirstRep

        public CodeableConceptDt getRoleFirstRep()
        Gets the first repetition for role (), creating it if it does not already exist.

        Definition: Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context

      • getReference

        public ResourceReferenceDt getReference()
        Gets the value(s) for reference (). creating it if it does not exist. Will not return null.

        Definition: Direct reference to a resource that identifies the participant

      • getUserId

        public IdentifierDt getUserId()
        Gets the value(s) for userId (). creating it if it does not exist. Will not return null.

        Definition: Unique identifier for the user actively participating in the event

      • getAltIdElement

        public ca.uhn.fhir.model.primitive.StringDt getAltIdElement()
        Gets the value(s) for altId (). creating it if it does not exist. Will not return null.

        Definition: Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available

      • getAltId

        public String getAltId()
        Gets the value(s) for altId (). creating it if it does not exist. This method may return null.

        Definition: Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available

      • setAltId

        public AuditEvent.Participant setAltId​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for altId ()

        Definition: Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available

      • setAltId

        public AuditEvent.Participant setAltId​(String theString)
        Sets the value for altId ()

        Definition: Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available

      • getNameElement

        public ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: Human-meaningful name for the user

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: Human-meaningful name for the user

      • setName

        public AuditEvent.Participant setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: Human-meaningful name for the user

      • getRequestorElement

        public ca.uhn.fhir.model.primitive.BooleanDt getRequestorElement()
        Gets the value(s) for requestor (). creating it if it does not exist. Will not return null.

        Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.

      • getRequestor

        public Boolean getRequestor()
        Gets the value(s) for requestor (). creating it if it does not exist. This method may return null.

        Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.

      • setRequestor

        public AuditEvent.Participant setRequestor​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for requestor ()

        Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.

      • setRequestor

        public AuditEvent.Participant setRequestor​(boolean theBoolean)
        Sets the value for requestor ()

        Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.

      • getLocation

        public ResourceReferenceDt getLocation()
        Gets the value(s) for location (). creating it if it does not exist. Will not return null.

        Definition: Where the event occurred

      • getPolicy

        public List<ca.uhn.fhir.model.primitive.UriDt> getPolicy()
        Gets the value(s) for policy (). creating it if it does not exist. Will not return null.

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

      • setPolicy

        public AuditEvent.Participant setPolicy​(List<ca.uhn.fhir.model.primitive.UriDt> theValue)
        Sets the value(s) for policy ()

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

      • addPolicy

        public ca.uhn.fhir.model.primitive.UriDt addPolicy()
        Adds and returns a new value for policy ()

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

      • addPolicy

        public AuditEvent.Participant addPolicy​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Adds a given new value for policy ()

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

        Parameters:
        theValue - The policy to add (must not be null)
      • getPolicyFirstRep

        public ca.uhn.fhir.model.primitive.UriDt getPolicyFirstRep()
        Gets the first repetition for policy (), creating it if it does not already exist.

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

      • addPolicy

        public AuditEvent.Participant addPolicy​(String theUri)
        Adds a new value for policy ()

        Definition: The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getMedia

        public CodingDt getMedia()
        Gets the value(s) for media (). creating it if it does not exist. Will not return null.

        Definition: Type of media involved. Used when the event is about exporting/importing onto media

      • setMedia

        public AuditEvent.Participant setMedia​(CodingDt theValue)
        Sets the value(s) for media ()

        Definition: Type of media involved. Used when the event is about exporting/importing onto media

      • getNetwork

        public AuditEvent.ParticipantNetwork getNetwork()
        Gets the value(s) for network (). creating it if it does not exist. Will not return null.

        Definition: Logical network location for application activity, if the activity has a network location

      • getPurposeOfUse

        public List<CodingDtgetPurposeOfUse()
        Gets the value(s) for purposeOfUse (). creating it if it does not exist. Will not return null.

        Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.

      • setPurposeOfUse

        public AuditEvent.Participant setPurposeOfUse​(List<CodingDt> theValue)
        Sets the value(s) for purposeOfUse ()

        Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.

      • addPurposeOfUse

        public CodingDt addPurposeOfUse()
        Adds and returns a new value for purposeOfUse ()

        Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.

      • addPurposeOfUse

        public AuditEvent.Participant addPurposeOfUse​(CodingDt theValue)
        Adds a given new value for purposeOfUse ()

        Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.

        Parameters:
        theValue - The purposeOfUse to add (must not be null)
      • getPurposeOfUseFirstRep

        public CodingDt getPurposeOfUseFirstRep()
        Gets the first repetition for purposeOfUse (), creating it if it does not already exist.

        Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.