Struct AuditEventBuilder 

pub struct AuditEventBuilder { /* private fields */ }

Builder for AuditEventInner.

Implementations

impl AuditEventBuilder

pub fn id(self, value: String) -> AuditEventBuilder

Logical id of this artifact

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

pub fn meta(self, value: Meta) -> AuditEventBuilder

Metadata about the resource

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.

pub fn implicit_rules(self, value: String) -> AuditEventBuilder

A set of rules under which this content was created

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

pub fn language(self, value: String) -> AuditEventBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

pub fn text(self, value: Narrative) -> AuditEventBuilder

Text summary of the resource, for human interpretation

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.

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

pub fn contained(self, value: Vec<Resource>) -> AuditEventBuilder

Contained, inline Resources

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

pub fn extension(self, value: Vec<Extension>) -> AuditEventBuilder

Additional content defined by implementations

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 managable, 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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn modifier_extension(self, value: Vec<Extension>) -> AuditEventBuilder

Extensions that cannot be ignored

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 managable, 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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn category(self, value: Vec<Option<CodeableConcept>>) -> AuditEventBuilder

AuditEventType; Type/identifier of event

Classification of the type of event.

pub fn category_ext( self, value: Vec<Option<FieldExtension>>, ) -> AuditEventBuilder

Extension field.

pub fn code(self, value: CodeableConcept) -> AuditEventBuilder

AuditEventSubType; Specific type of event

Describes what happened. The most specific code for the event.

pub fn code_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn action(self, value: AuditEventAction) -> AuditEventBuilder

AuditEventAction; Type of action performed during the event

Indicator for type of action performed during the event that generated the audit.

pub fn action_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn severity(self, value: AuditEventSeverity) -> AuditEventBuilder

AuditEventSeverity; emergency | alert | critical | error | warning | notice | informational | debug

Indicates and enables segmentation of various severity including debugging from critical.

ATNA will map this to the SYSLOG PRI element.

pub fn severity_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn occurred(self, value: AuditEventOccurred) -> AuditEventBuilder

When the activity occurred

The time or period during which the activity occurred.

The time or period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

pub fn occurred_ext( self, value: AuditEventOccurredExtension, ) -> AuditEventBuilder

Extension field.

pub fn recorded(self, value: Instant) -> AuditEventBuilder

Time when the event was recorded

The time when the event was recorded.

In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.

pub fn recorded_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn outcome(self, value: AuditEventOutcome) -> AuditEventBuilder

Whether the event succeeded or failed

Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.

In some cases a “success” may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.

pub fn outcome_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn authorization( self, value: Vec<Option<CodeableConcept>>, ) -> AuditEventBuilder

AuditPurposeOfUse; Authorization related to the event

The authorization (e.g., PurposeOfUse) that was used during the event being recorded.

Use AuditEvent.agent.authorization when you know that it is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

pub fn authorization_ext( self, value: Vec<Option<FieldExtension>>, ) -> AuditEventBuilder

Extension field.

pub fn based_on(self, value: Vec<Option<Reference>>) -> AuditEventBuilder

Workflow authorization within which this event occurred

Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.

pub fn based_on_ext( self, value: Vec<Option<FieldExtension>>, ) -> AuditEventBuilder

Extension field.

pub fn patient(self, value: Reference) -> AuditEventBuilder

The patient is the subject of the data used/created/updated/deleted during the activity

The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.

pub fn patient_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn encounter(self, value: Reference) -> AuditEventBuilder

Encounter within which this event occurred or which the event is tightly associated

This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).

pub fn encounter_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn agent(self, value: Vec<Option<AuditEventAgent>>) -> AuditEventBuilder

Actor involved in the event

An actor taking an active role in the event or activity that is logged.

Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.

For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.

When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.

pub fn agent_ext(self, value: Vec<Option<FieldExtension>>) -> AuditEventBuilder

Extension field.

pub fn source(self, value: AuditEventSource) -> AuditEventBuilder

Audit Event Reporter

The actor that is reporting the event.

Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.

pub fn source_ext(self, value: FieldExtension) -> AuditEventBuilder

Extension field.

pub fn entity(self, value: Vec<Option<AuditEventEntity>>) -> AuditEventBuilder

Data or objects used

Specific instances of data or objects that have been accessed.

Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.

pub fn entity_ext(self, value: Vec<Option<FieldExtension>>) -> AuditEventBuilder

Extension field.

pub fn build_inner(self) -> Result<AuditEventInner, BuilderError>

Builds a new AuditEventInner.

Errors

If a required field has not been initialized.

impl AuditEventBuilder

pub fn build(self) -> Result<AuditEvent, BuilderError>

Finalize building AuditEvent.

Trait Implementations

impl Default for AuditEventBuilder

fn default() -> AuditEventBuilder

Returns the “default value” for a type.