Package org.hl7.fhir.r5.model

Class Provenance

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.Provenance

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Provenance
extends DomainResource

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Provenance.ProvenanceAgentComponent
static class	Provenance.ProvenanceEntityComponent
static enum	Provenance.ProvenanceEntityRole
static class	Provenance.ProvenanceEntityRoleEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	activity	An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTIVITY	Fluent Client search parameter constant for activity
protected List<Provenance.ProvenanceAgentComponent>	agent	An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AGENT	Fluent Client search parameter constant for agent
static final ca.uhn.fhir.rest.gclient.TokenClientParam	AGENT_ROLE	Fluent Client search parameter constant for agent-role
static final ca.uhn.fhir.rest.gclient.TokenClientParam	AGENT_TYPE	Fluent Client search parameter constant for agent-type
protected List<CodeableReference>	authorization	The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.
protected Reference	encounter	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.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected List<Provenance.ProvenanceEntityComponent>	entity	An entity used in this activity.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENTITY	Fluent Client search parameter constant for entity
static final ca.uhn.fhir.model.api.Include	INCLUDE_AGENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENTITY	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_TARGET	Constant for fluent queries to be used to add include statements.
protected Reference	location	Where the activity occurred, if relevant.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected DataType	occurred	The period during which the activity occurred.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<UriType>	policy	Policy or plan the activity was defined by.
protected InstantType	recorded	The instant of time at which the activity was recorded.
static final ca.uhn.fhir.rest.gclient.DateClientParam	RECORDED	Fluent Client search parameter constant for recorded
protected List<Signature>	signature	A digital signature on the target Reference(s).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SIGNATURE_TYPE	Fluent Client search parameter constant for signature-type
static final String	SP_ACTIVITY	Search parameter: activity
static final String	SP_AGENT	Search parameter: agent
static final String	SP_AGENT_ROLE	Search parameter: agent-role
static final String	SP_AGENT_TYPE	Search parameter: agent-type
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_ENTITY	Search parameter: entity
static final String	SP_LOCATION	Search parameter: location
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_RECORDED	Search parameter: recorded
static final String	SP_SIGNATURE_TYPE	Search parameter: signature-type
static final String	SP_TARGET	Search parameter: target
static final String	SP_WHEN	Search parameter: when
protected List<Reference>	target	The Reference(s) that were generated or updated by the activity described in this resource.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	TARGET	Fluent Client search parameter constant for target
static final ca.uhn.fhir.rest.gclient.DateClientParam	WHEN	Fluent Client search parameter constant for when

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Provenance()	Constructor
Provenance(Reference target, Provenance.ProvenanceAgentComponent agent)	Constructor

Method Summary

Modifier and Type	Method	Description
Provenance.ProvenanceAgentComponent	addAgent()
Provenance	addAgent(Provenance.ProvenanceAgentComponent t)
CodeableReference	addAuthorization()
Provenance	addAuthorization(CodeableReference t)
Reference	addBasedOn()
Provenance	addBasedOn(Reference t)
Base	addChild(String name)
Provenance.ProvenanceEntityComponent	addEntity()
Provenance	addEntity(Provenance.ProvenanceEntityComponent t)
Provenance	addPolicy(String value)
UriType	addPolicyElement()
Signature	addSignature()
Provenance	addSignature(Signature t)
Reference	addTarget()
Provenance	addTarget(Reference t)
Provenance	copy()
void	copyValues(Provenance dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getActivity()
List<Provenance.ProvenanceAgentComponent>	getAgent()
Provenance.ProvenanceAgentComponent	getAgentFirstRep()
List<CodeableReference>	getAuthorization()
CodeableReference	getAuthorizationFirstRep()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
Reference	getEncounter()
List<Provenance.ProvenanceEntityComponent>	getEntity()
Provenance.ProvenanceEntityComponent	getEntityFirstRep()
Reference	getLocation()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DataType	getOccurred()
DateTimeType	getOccurredDateTimeType()
Period	getOccurredPeriod()
List<UriType>	getPolicy()
Base[]	getProperty(int hash, String name, boolean checkValid)
Date	getRecorded()
InstantType	getRecordedElement()
ResourceType	getResourceType()
List<Signature>	getSignature()
Signature	getSignatureFirstRep()
List<Reference>	getTarget()
Reference	getTargetFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActivity()
boolean	hasAgent()
boolean	hasAuthorization()
boolean	hasBasedOn()
boolean	hasEncounter()
boolean	hasEntity()
boolean	hasLocation()
boolean	hasOccurred()
boolean	hasOccurredDateTimeType()
boolean	hasOccurredPeriod()
boolean	hasPolicy()
boolean	hasPolicy(String value)
boolean	hasRecorded()
boolean	hasRecordedElement()
boolean	hasSignature()
boolean	hasTarget()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Provenance	setActivity(CodeableConcept value)
Provenance	setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)
Provenance	setAuthorization(List<CodeableReference> theAuthorization)
Provenance	setBasedOn(List<Reference> theBasedOn)
Provenance	setEncounter(Reference value)
Provenance	setEntity(List<Provenance.ProvenanceEntityComponent> theEntity)
Provenance	setLocation(Reference value)
Provenance	setOccurred(DataType value)
Provenance	setPolicy(List<UriType> thePolicy)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Provenance	setRecorded(Date value)
Provenance	setRecordedElement(InstantType value)
Provenance	setSignature(List<Signature> theSignature)
Provenance	setTarget(List<Reference> theTarget)
protected Provenance	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Details

target

protected List<Reference> target

The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

occurred

protected DataType occurred

The period during which the activity occurred.

recorded

protected InstantType recorded

The instant of time at which the activity was recorded.

policy

protected List<UriType> policy

Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

location

protected Reference location

Where the activity occurred, if relevant.

authorization

protected List<CodeableReference> authorization

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

activity

protected CodeableConcept activity

An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

basedOn

protected List<Reference> basedOn

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

encounter

protected Reference encounter

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

agent

protected List<Provenance.ProvenanceAgentComponent> agent

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

entity

protected List<Provenance.ProvenanceEntityComponent> entity

An entity used in this activity.

signature

protected List<Signature> signature

A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

SP_ACTIVITY

public static final String SP_ACTIVITY

Search parameter: activity

Description: Activity that occurred
Type: token
Path: Provenance.activity

See Also:

• Constant Field Values

ACTIVITY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVITY

Fluent Client search parameter constant for activity

Description: Activity that occurred
Type: token
Path: Provenance.activity

SP_AGENT_ROLE

public static final String SP_AGENT_ROLE

Search parameter: agent-role

Description: What the agents role was
Type: token
Path: Provenance.agent.role

See Also:

• Constant Field Values

AGENT_ROLE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_ROLE

Fluent Client search parameter constant for agent-role

Description: What the agents role was
Type: token
Path: Provenance.agent.role

SP_AGENT_TYPE

public static final String SP_AGENT_TYPE

Search parameter: agent-type

Description: How the agent participated
Type: token
Path: Provenance.agent.type

See Also:

• Constant Field Values

AGENT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_TYPE

Fluent Client search parameter constant for agent-type

Description: How the agent participated
Type: token
Path: Provenance.agent.type

SP_AGENT

public static final String SP_AGENT

Search parameter: agent

Description: Who participated
Type: reference
Path: Provenance.agent.who

See Also:

• Constant Field Values

AGENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT

Fluent Client search parameter constant for agent

Description: Who participated
Type: reference
Path: Provenance.agent.who

INCLUDE_AGENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:agent".

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Reference to the service request.
Type: reference
Path: Provenance.basedOn

See Also:

• Constant Field Values

BASED_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON

Fluent Client search parameter constant for based-on

Description: Reference to the service request.
Type: reference
Path: Provenance.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:based-on".

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Encounter related to the Provenance
Type: reference
Path: Provenance.encounter

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Encounter related to the Provenance
Type: reference
Path: Provenance.encounter

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:encounter".

SP_ENTITY

public static final String SP_ENTITY

Search parameter: entity

Description: Identity of entity
Type: reference
Path: Provenance.entity.what

See Also:

• Constant Field Values

ENTITY

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTITY

Fluent Client search parameter constant for entity

Description: Identity of entity
Type: reference
Path: Provenance.entity.what

INCLUDE_ENTITY

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTITY

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:entity".

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location

See Also:

• Constant Field Values

LOCATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION

Fluent Client search parameter constant for location

Description: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location

INCLUDE_LOCATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:location".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target.where(resolve() is Patient)

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target.where(resolve() is Patient)

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:patient".

SP_RECORDED

public static final String SP_RECORDED

Search parameter: recorded

Description: When the activity was recorded / updated
Type: date
Path: Provenance.recorded

See Also:

• Constant Field Values

RECORDED

public static final ca.uhn.fhir.rest.gclient.DateClientParam RECORDED

Fluent Client search parameter constant for recorded

Description: When the activity was recorded / updated
Type: date
Path: Provenance.recorded

SP_SIGNATURE_TYPE

public static final String SP_SIGNATURE_TYPE

Search parameter: signature-type

Description: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type

See Also:

• Constant Field Values

SIGNATURE_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SIGNATURE_TYPE

Fluent Client search parameter constant for signature-type

Description: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type

SP_TARGET

public static final String SP_TARGET

Search parameter: target

Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target

See Also:

• Constant Field Values

TARGET

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET

Fluent Client search parameter constant for target

Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target

INCLUDE_TARGET

public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET

Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:target".

SP_WHEN

public static final String SP_WHEN

Search parameter: when

Description: When the activity occurred
Type: date
Path: (Provenance.occurred as dateTime)

See Also:

• Constant Field Values

WHEN

public static final ca.uhn.fhir.rest.gclient.DateClientParam WHEN

Fluent Client search parameter constant for when

Description: When the activity occurred
Type: date
Path: (Provenance.occurred as dateTime)

Constructor Details

Provenance

public Provenance()

Constructor

Provenance

public Provenance(Reference target,
 Provenance.ProvenanceAgentComponent agent)

Constructor

Method Details

getTarget

public List<Reference> getTarget()

Returns:

target (The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.)

setTarget

public Provenance setTarget(List<Reference> theTarget)

Returns:

Returns a reference to this for easy method chaining

hasTarget

public boolean hasTarget()

addTarget

public Reference addTarget()

addTarget

public Provenance addTarget(Reference t)

getTargetFirstRep

public Reference getTargetFirstRep()

Returns:

The first repetition of repeating field target, creating it if it does not already exist {3}

getOccurred

public DataType getOccurred()

Returns:

occurred (The period during which the activity occurred.)

getOccurredPeriod

public Period getOccurredPeriod()
                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

occurred (The period during which the activity occurred.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurredPeriod

public boolean hasOccurredPeriod()

getOccurredDateTimeType

public DateTimeType getOccurredDateTimeType()
                                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

occurred (The period during which the activity occurred.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurredDateTimeType

public boolean hasOccurredDateTimeType()

hasOccurred

public boolean hasOccurred()

setOccurred

public Provenance setOccurred(DataType value)

Parameters:

value - occurred (The period during which the activity occurred.)

getRecordedElement

public InstantType getRecordedElement()

Returns:

recorded (The instant of time at which the activity was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value

hasRecordedElement

public boolean hasRecordedElement()

hasRecorded

public boolean hasRecorded()

setRecordedElement

public Provenance setRecordedElement(InstantType value)

Parameters:

value - recorded (The instant of time at which the activity was recorded.). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value

getRecorded

public Date getRecorded()

Returns:

The instant of time at which the activity was recorded.

setRecorded

public Provenance setRecorded(Date value)

Parameters:

value - The instant of time at which the activity was recorded.

getPolicy

public List<UriType> getPolicy()

Returns:

policy (Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)

setPolicy

public Provenance setPolicy(List<UriType> thePolicy)

Returns:

Returns a reference to this for easy method chaining

hasPolicy

public boolean hasPolicy()

addPolicyElement

public UriType addPolicyElement()

Returns:

policy (Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)

addPolicy

public Provenance addPolicy(String value)

Parameters:

value - policy (Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)

hasPolicy

public boolean hasPolicy(String value)

Parameters:

value - policy (Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.)

getLocation

public Reference getLocation()

Returns:

location (Where the activity occurred, if relevant.)

hasLocation

public boolean hasLocation()

setLocation

public Provenance setLocation(Reference value)

Parameters:

value - location (Where the activity occurred, if relevant.)

getAuthorization

public List<CodeableReference> getAuthorization()

Returns:

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

setAuthorization

public Provenance setAuthorization(List<CodeableReference> theAuthorization)

Returns:

Returns a reference to this for easy method chaining

hasAuthorization

public boolean hasAuthorization()

addAuthorization

public CodeableReference addAuthorization()

addAuthorization

public Provenance addAuthorization(CodeableReference t)

getAuthorizationFirstRep

public CodeableReference getAuthorizationFirstRep()

Returns:

The first repetition of repeating field authorization, creating it if it does not already exist {3}

getActivity

public CodeableConcept getActivity()

Returns:

activity (An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.)

hasActivity

public boolean hasActivity()

setActivity

public Provenance setActivity(CodeableConcept value)

Parameters:

value - activity (An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.)

getBasedOn

public List<Reference> getBasedOn()

Returns:

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

setBasedOn

public Provenance setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public Provenance addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist {3}

getEncounter

public Reference getEncounter()

Returns:

encounter (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).)

hasEncounter

public boolean hasEncounter()

setEncounter

public Provenance setEncounter(Reference value)

Parameters:

value - encounter (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).)

getAgent

public List<Provenance.ProvenanceAgentComponent> getAgent()

Returns:

agent (An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)

setAgent

public Provenance setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)

Returns:

Returns a reference to this for easy method chaining

hasAgent

public boolean hasAgent()

addAgent

public Provenance.ProvenanceAgentComponent addAgent()

addAgent

public Provenance addAgent(Provenance.ProvenanceAgentComponent t)

getAgentFirstRep

public Provenance.ProvenanceAgentComponent getAgentFirstRep()

Returns:

The first repetition of repeating field agent, creating it if it does not already exist {3}

getEntity

public List<Provenance.ProvenanceEntityComponent> getEntity()

Returns:

entity (An entity used in this activity.)

setEntity

public Provenance setEntity(List<Provenance.ProvenanceEntityComponent> theEntity)

Returns:

Returns a reference to this for easy method chaining

hasEntity

public boolean hasEntity()

addEntity

public Provenance.ProvenanceEntityComponent addEntity()

addEntity

public Provenance addEntity(Provenance.ProvenanceEntityComponent t)

getEntityFirstRep

public Provenance.ProvenanceEntityComponent getEntityFirstRep()

Returns:

The first repetition of repeating field entity, creating it if it does not already exist {3}

getSignature

public List<Signature> getSignature()

Returns:

signature (A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.)

setSignature

public Provenance setSignature(List<Signature> theSignature)

Returns:

Returns a reference to this for easy method chaining

hasSignature

public boolean hasSignature()

addSignature

public Signature addSignature()

addSignature

public Provenance addSignature(Signature t)

getSignatureFirstRep

public Signature getSignatureFirstRep()

Returns:

The first repetition of repeating field signature, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Provenance copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Provenance dst)

typedCopy

protected Provenance typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource