Package org.linuxforhealth.fhir.model.resource

Class Provenance.Agent.Builder

java.lang.Object

org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>

org.linuxforhealth.fhir.model.type.Element.Builder

org.linuxforhealth.fhir.model.type.BackboneElement.Builder

org.linuxforhealth.fhir.model.resource.Provenance.Agent.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

Provenance.Agent

public static class Provenance.Agent.Builder
extends BackboneElement.Builder

Field Summary

Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder

modifierExtension

Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder

extension, id

Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder

validating

Method Summary

Modifier and Type	Method	Description
Provenance.Agent	build()	Build the Provenance.Agent
Provenance.Agent.Builder	extension(java.util.Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the element.
Provenance.Agent.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the element.
protected Provenance.Agent.Builder	from(Provenance.Agent agent)
Provenance.Agent.Builder	id(java.lang.String id)	Unique id for the element within a resource (for internal references).
Provenance.Agent.Builder	modifierExtension(java.util.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.
Provenance.Agent.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.
Provenance.Agent.Builder	onBehalfOf(Reference onBehalfOf)	The individual, device, or organization for whom the change was made.
Provenance.Agent.Builder	role(java.util.Collection<CodeableConcept> role)	The function of the agent with respect to the activity.
Provenance.Agent.Builder	role(CodeableConcept... role)	The function of the agent with respect to the activity.
Provenance.Agent.Builder	type(CodeableConcept type)	The participation the agent had with respect to the activity.
protected void	validate(Provenance.Agent agent)
Provenance.Agent.Builder	who(Reference who)	The individual, device or organization that participated in the event.

Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder

from, validate

Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder

from, validate

Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder

isValidating, setValidating

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public Provenance.Agent.Builder id(java.lang.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 Provenance.Agent.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 Provenance.Agent.Builder extension(java.util.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:

java.lang.NullPointerException - If the passed collection is null

modifierExtension

public Provenance.Agent.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 Provenance.Agent.Builder modifierExtension(java.util.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:

java.lang.NullPointerException - If the passed collection is null

type

public Provenance.Agent.Builder type(CodeableConcept type)

The participation the agent had with respect to the activity.

Parameters:

type - How the agent participated

Returns:

A reference to this Builder instance

role

public Provenance.Agent.Builder role(CodeableConcept... role)

The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

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

Parameters:

role - What the agents role was

Returns:

A reference to this Builder instance

role

public Provenance.Agent.Builder role(java.util.Collection<CodeableConcept> role)

The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

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:

role - What the agents role was

Returns:

A reference to this Builder instance

Throws:

java.lang.NullPointerException - If the passed collection is null

who

public Provenance.Agent.Builder who(Reference who)

The individual, device or organization that participated in the event.

This element is required.

Allowed resource types for this reference:

• Practitioner
• PractitionerRole
• RelatedPerson
• Patient
• Device
• Organization

Parameters:

who - Who participated

Returns:

A reference to this Builder instance

onBehalfOf

public Provenance.Agent.Builder onBehalfOf(Reference onBehalfOf)

The individual, device, or organization for whom the change was made.

Allowed resource types for this reference:

• Practitioner
• PractitionerRole
• RelatedPerson
• Patient
• Device
• Organization

Parameters:

onBehalfOf - Who the agent is representing

Returns:

A reference to this Builder instance

build

public Provenance.Agent build()

Build the Provenance.Agent

Required elements:

• who

Specified by:

build in interface Builder<Element>

Specified by:

build in class BackboneElement.Builder

Returns:

An immutable object of type Provenance.Agent

Throws:

java.lang.IllegalStateException - if the current state cannot be built into a valid Agent per the base specification

validate

protected void validate(Provenance.Agent agent)

from

protected Provenance.Agent.Builder from(Provenance.Agent agent)