Package org.hl7.fhir.dstu2.model

Class Provenance

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.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.ProvenanceAgentRelatedAgentComponent
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.
protected List<Provenance.ProvenanceAgentComponent>	agent	An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place.
protected List<Provenance.ProvenanceEntityComponent>	entity	An entity used in this activity.
protected Reference	location	Where the activity occurred, if relevant.
protected Location	locationTarget	The actual object that is the target of the reference (Where the activity occurred, if relevant.)
protected Period	period	The period during which the activity occurred.
protected List<UriType>	policy	Policy or plan the activity was defined by.
protected List<CodeableConcept>	reason	The reason that the activity was taking place.
protected InstantType	recorded	The instant of time at which the activity was recorded.
protected List<Signature>	signature	A digital signature on the target Reference(s).
static final String	SP_AGENT
static final String	SP_END
static final String	SP_ENTITY
static final String	SP_ENTITYTYPE
static final String	SP_LOCATION
static final String	SP_PATIENT
static final String	SP_SIGTYPE
static final String	SP_START
static final String	SP_TARGET
static final String	SP_USERID
protected List<Reference>	target	The Reference(s) that were generated or updated by the activity described in this resource.
protected List<Resource>	targetTarget	The actual objects that are the target of the reference (The Reference(s) that were generated or updated by the activity described in this resource.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Provenance()
Provenance(InstantType recorded)

Method Summary

Modifier and Type	Method	Description
Provenance.ProvenanceAgentComponent	addAgent()
Provenance	addAgent(Provenance.ProvenanceAgentComponent t)
Base	addChild(String name)
Provenance.ProvenanceEntityComponent	addEntity()
Provenance	addEntity(Provenance.ProvenanceEntityComponent t)
Provenance	addPolicy(String value)
UriType	addPolicyElement()
CodeableConcept	addReason()
Provenance	addReason(CodeableConcept t)
Signature	addSignature()
Provenance	addSignature(Signature t)
Reference	addTarget()
Provenance	addTarget(Reference t)
Provenance	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getActivity()
List<Provenance.ProvenanceAgentComponent>	getAgent()
List<Provenance.ProvenanceEntityComponent>	getEntity()
Reference	getLocation()
Location	getLocationTarget()
Period	getPeriod()
List<UriType>	getPolicy()
List<CodeableConcept>	getReason()
Date	getRecorded()
InstantType	getRecordedElement()
ResourceType	getResourceType()
List<Signature>	getSignature()
List<Reference>	getTarget()
List<Resource>	getTargetTarget()
boolean	hasActivity()
boolean	hasAgent()
boolean	hasEntity()
boolean	hasLocation()
boolean	hasPeriod()
boolean	hasPolicy()
boolean	hasPolicy(String value)
boolean	hasReason()
boolean	hasRecorded()
boolean	hasRecordedElement()
boolean	hasSignature()
boolean	hasTarget()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Provenance	setActivity(CodeableConcept value)
Provenance	setLocation(Reference value)
Provenance	setLocationTarget(Location value)
Provenance	setPeriod(Period value)
void	setProperty(String name, Base value)
Provenance	setRecorded(Date value)
Provenance	setRecordedElement(InstantType value)
protected Provenance	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

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

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, isDeleted, 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.

targetTarget

protected List<Resource> targetTarget

The actual objects that are the target of the reference (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.)

period

protected Period period

The period during which the activity occurred.

recorded

protected InstantType recorded

The instant of time at which the activity was recorded.

reason

protected List<CodeableConcept> reason

The reason that the activity was taking place.

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.

location

protected Reference location

Where the activity occurred, if relevant.

locationTarget

protected Location locationTarget

The actual object that is the target of the reference (Where the activity occurred, if relevant.)

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.

agent

protected List<Provenance.ProvenanceAgentComponent> agent

An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.

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_SIGTYPE

public static final String SP_SIGTYPE

See Also:

• Constant Field Values

SP_AGENT

public static final String SP_AGENT

See Also:

• Constant Field Values

SP_ENTITYTYPE

public static final String SP_ENTITYTYPE

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_START

public static final String SP_START

See Also:

• Constant Field Values

SP_END

public static final String SP_END

See Also:

• Constant Field Values

SP_LOCATION

public static final String SP_LOCATION

See Also:

• Constant Field Values

SP_USERID

public static final String SP_USERID

See Also:

• Constant Field Values

SP_ENTITY

public static final String SP_ENTITY

See Also:

• Constant Field Values

SP_TARGET

public static final String SP_TARGET

See Also:

• Constant Field Values

Constructor Details

Provenance

public Provenance()

Provenance

public Provenance(InstantType recorded)

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

hasTarget

public boolean hasTarget()

addTarget

public Reference addTarget()

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

addTarget

public Provenance addTarget(Reference t)

getTargetTarget

public List<Resource> getTargetTarget()

Returns:

target (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)

getPeriod

public Period getPeriod()

Returns:

period (The period during which the activity occurred.)

hasPeriod

public boolean hasPeriod()

setPeriod

public Provenance setPeriod(Period value)

Parameters:

value - period (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.

getReason

public List<CodeableConcept> getReason()

Returns:

reason (The reason that the activity was taking place.)

hasReason

public boolean hasReason()

addReason

public CodeableConcept addReason()

Returns:

reason (The reason that the activity was taking place.)

addReason

public Provenance addReason(CodeableConcept t)

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

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

getLocationTarget

public Location getLocationTarget()

Returns:

location The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Where the activity occurred, if relevant.)

setLocationTarget

public Provenance setLocationTarget(Location value)

Parameters:

value - location The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Where the activity occurred, if relevant.)

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

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

getAgent

public List<Provenance.ProvenanceAgentComponent> getAgent()

Returns:

agent (An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.)

hasAgent

public boolean hasAgent()

addAgent

public Provenance.ProvenanceAgentComponent addAgent()

Returns:

agent (An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.)

addAgent

public Provenance addAgent(Provenance.ProvenanceAgentComponent t)

getEntity

public List<Provenance.ProvenanceEntityComponent> getEntity()

Returns:

entity (An entity used in this activity.)

hasEntity

public boolean hasEntity()

addEntity

public Provenance.ProvenanceEntityComponent addEntity()

Returns:

entity (An entity used in this activity.)

addEntity

public Provenance addEntity(Provenance.ProvenanceEntityComponent t)

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

hasSignature

public boolean hasSignature()

addSignature

public Signature addSignature()

Returns:

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

addSignature

public Provenance addSignature(Signature t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

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

Overrides:

setProperty 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

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