Package org.hl7.fhir.dstu2016may.model

Class Provenance

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.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 class	Provenance.ProvenanceEntityRole
static class	Provenance.ProvenanceEntityRoleEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Coding	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 actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	AGENT	Fluent Client search parameter constant for agent
static ca.uhn.fhir.rest.gclient.DateClientParam	END	Fluent Client search parameter constant for end
protected List<Provenance.ProvenanceEntityComponent>	entity	An entity used in this activity.
static ca.uhn.fhir.rest.gclient.UriClientParam	ENTITY	Fluent Client search parameter constant for entity
static ca.uhn.fhir.rest.gclient.TokenClientParam	ENTITY_TYPE	Fluent Client search parameter constant for entity-type
static ca.uhn.fhir.model.api.Include	INCLUDE_AGENT	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected Location	locationTarget	The actual object that is the target of the reference (Where the activity occurred, if relevant.)
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Period	period	The period during which the activity occurred.
protected List<UriType>	policy	Policy or plan the activity was defined by.
protected List<Coding>	reason	The reason that the activity was taking place.
protected InstantType	recorded	The instant of time at which the activity was recorded.
static ca.uhn.fhir.rest.gclient.TokenClientParam	SIG	Fluent Client search parameter constant for sig
protected List<Signature>	signature	A digital signature on the target Reference(s).
static String	SP_AGENT	Search parameter: agent
static String	SP_END	Search parameter: end
static String	SP_ENTITY	Search parameter: entity
static String	SP_ENTITY_TYPE	Search parameter: entity-type
static String	SP_LOCATION	Search parameter: location
static String	SP_PATIENT	Search parameter: patient
static String	SP_SIG	Search parameter: sig
static String	SP_START	Search parameter: start
static String	SP_TARGET	Search parameter: target
static String	SP_USERID	Search parameter: userid
static ca.uhn.fhir.rest.gclient.DateClientParam	START	Fluent Client search parameter constant for start
protected List<Reference>	target	The Reference(s) that were generated or updated by the activity described in this resource.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	TARGET	Fluent Client search parameter constant for target
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.
static ca.uhn.fhir.rest.gclient.TokenClientParam	USERID	Fluent Client search parameter constant for userid

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Provenance()	Constructor
Provenance(InstantType recorded)	Constructor

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()
Coding	addReason()
Provenance	addReason(Coding 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()
Coding	getActivity()
List<Provenance.ProvenanceAgentComponent>	getAgent()
List<Provenance.ProvenanceEntityComponent>	getEntity()
Reference	getLocation()
Location	getLocationTarget()
Period	getPeriod()
List<UriType>	getPolicy()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Coding>	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)
Base	makeProperty(int hash, String name)	make an instance of a property.
Provenance	setActivity(Coding value)
Provenance	setLocation(Reference value)
Provenance	setLocationTarget(Location value)
Provenance	setPeriod(Period value)
void	setProperty(int hash, String name, Base 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.dstu2016may.model.DomainResource

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

Methods inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

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

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

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<Coding> reason

The reason that the activity was taking place.

activity

protected Coding 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 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_PATIENT

public static final String SP_PATIENT

Search parameter: patient

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

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

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_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_START

public static final String SP_START

Search parameter: start

Description: Starting time with inclusive boundary
Type: date
Path: Provenance.period.start

See Also:

Constant Field Values

START

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

Fluent Client search parameter constant for start

Description: Starting time with inclusive boundary
Type: date
Path: Provenance.period.start

SP_ENTITY

public static final String SP_ENTITY

Search parameter: entity

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

See Also:

Constant Field Values

ENTITY

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

Fluent Client search parameter constant for entity

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

SP_USERID

public static final String SP_USERID

Search parameter: userid

Description: Authorization-system identifier for the agent
Type: token
Path: Provenance.agent.userId

See Also:

Constant Field Values

USERID

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

Fluent Client search parameter constant for userid

Description: Authorization-system identifier for the agent
Type: token
Path: Provenance.agent.userId

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_ENTITY_TYPE

public static final String SP_ENTITY_TYPE

Search parameter: entity-type

Description: The type of resource in this entity
Type: token
Path: Provenance.entity.type

See Also:

Constant Field Values

ENTITY_TYPE

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

Fluent Client search parameter constant for entity-type

Description: The type of resource in this entity
Type: token
Path: Provenance.entity.type

SP_AGENT

public static final String SP_AGENT

Search parameter: agent

Description: Individual, device or organization playing role
Type: reference
Path: Provenance.agent.actor

See Also:

Constant Field Values

AGENT

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

Fluent Client search parameter constant for agent

Description: Individual, device or organization playing role
Type: reference
Path: Provenance.agent.actor

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_END

public static final String SP_END

Search parameter: end

Description: End time with inclusive boundary, if not ongoing
Type: date
Path: Provenance.period.end

See Also:

Constant Field Values

END

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

Fluent Client search parameter constant for end

Description: End time with inclusive boundary, if not ongoing
Type: date
Path: Provenance.period.end

SP_SIG

public static final String SP_SIG

Search parameter: sig

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

See Also:

Constant Field Values

SIG

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

Fluent Client search parameter constant for sig

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

Constructor Detail

Provenance

public Provenance()

Constructor

Provenance

public Provenance(InstantType recorded)

Constructor

Method Detail

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<Coding> getReason()

Returns:

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

hasReason

public boolean hasReason()

addReason

public Coding addReason()

Returns:

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

addReason

public Provenance addReason(Coding t)

getActivity

public Coding 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(Coding 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 actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)

hasAgent

public boolean hasAgent()

addAgent

public Provenance.ProvenanceAgentComponent addAgent()

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

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

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 void 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 void 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

Description copied from class: Base

make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property

Overrides:

makeProperty in class DomainResource

Returns:

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