public class Provenance extends BaseResource implements IResource
Definition: 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.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Provenance
| Modifier and Type | Class and Description |
|---|---|
static class |
Provenance.Agent
Block class for child element: Provenance.agent (who)
|
static class |
Provenance.AgentRelatedAgent
Block class for child element: Provenance.agent.relatedAgent ()
|
static class |
Provenance.Entity
Block class for child element: Provenance.entity ()
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
AGENT
Fluent Client search parameter constant for agent
|
static DateClientParam |
END
Fluent Client search parameter constant for end
|
static UriClientParam |
ENTITY
Fluent Client search parameter constant for entity
|
static TokenClientParam |
ENTITYTYPE
Fluent Client search parameter constant for entitytype
|
static Include |
INCLUDE_AGENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_TARGET
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
LOCATION
Fluent Client search parameter constant for location
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static TokenClientParam |
SIGTYPE
Fluent Client search parameter constant for sigtype
|
static String |
SP_AGENT
Search parameter constant for agent
|
static String |
SP_END
Search parameter constant for end
|
static String |
SP_ENTITY
Search parameter constant for entity
|
static String |
SP_ENTITYTYPE
Search parameter constant for entitytype
|
static String |
SP_LOCATION
Search parameter constant for location
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_SIGTYPE
Search parameter constant for sigtype
|
static String |
SP_START
Search parameter constant for start
|
static String |
SP_TARGET
Search parameter constant for target
|
static String |
SP_USERID
Search parameter constant for userid
|
static DateClientParam |
START
Fluent Client search parameter constant for start
|
static ReferenceClientParam |
TARGET
Fluent Client search parameter constant for target
|
static TokenClientParam |
USERID
Fluent Client search parameter constant for userid
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Provenance() |
| Modifier and Type | Method and Description |
|---|---|
Provenance.Agent |
addAgent()
Adds and returns a new value for agent (who)
|
Provenance |
addAgent(Provenance.Agent theValue)
Adds a given new value for agent (who)
|
Provenance.Entity |
addEntity()
Adds and returns a new value for entity ()
|
Provenance |
addEntity(Provenance.Entity theValue)
Adds a given new value for entity ()
|
UriDt |
addPolicy()
Adds and returns a new value for policy ()
|
Provenance |
addPolicy(String theUri)
Adds a new value for policy ()
|
Provenance |
addPolicy(UriDt theValue)
Adds a given new value for policy ()
|
CodeableConceptDt |
addReason()
Adds and returns a new value for reason (why)
|
Provenance |
addReason(CodeableConceptDt theValue)
Adds a given new value for reason (why)
|
SignatureDt |
addSignature()
Adds and returns a new value for signature ()
|
Provenance |
addSignature(SignatureDt theValue)
Adds a given new value for signature ()
|
ResourceReferenceDt |
addTarget()
Adds and returns a new value for target (what)
|
CodeableConceptDt |
getActivity()
Gets the value(s) for activity (why).
|
List<Provenance.Agent> |
getAgent()
Gets the value(s) for agent (who).
|
Provenance.Agent |
getAgentFirstRep()
Gets the first repetition for agent (who),
creating it if it does not already exist.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<Provenance.Entity> |
getEntity()
Gets the value(s) for entity ().
|
Provenance.Entity |
getEntityFirstRep()
Gets the first repetition for entity (),
creating it if it does not already exist.
|
ResourceReferenceDt |
getLocation()
Gets the value(s) for location (where).
|
PeriodDt |
getPeriod()
Gets the value(s) for period (when.done).
|
List<UriDt> |
getPolicy()
Gets the value(s) for policy ().
|
UriDt |
getPolicyFirstRep()
Gets the first repetition for policy (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getReason()
Gets the value(s) for reason (why).
|
CodeableConceptDt |
getReasonFirstRep()
Gets the first repetition for reason (why),
creating it if it does not already exist.
|
Date |
getRecorded()
Gets the value(s) for recorded (when.recorded).
|
InstantDt |
getRecordedElement()
Gets the value(s) for recorded (when.recorded).
|
String |
getResourceName() |
List<SignatureDt> |
getSignature()
Gets the value(s) for signature ().
|
SignatureDt |
getSignatureFirstRep()
Gets the first repetition for signature (),
creating it if it does not already exist.
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<ResourceReferenceDt> |
getTarget()
Gets the value(s) for target (what).
|
boolean |
isEmpty() |
Provenance |
setActivity(CodeableConceptDt theValue)
Sets the value(s) for activity (why)
|
Provenance |
setAgent(List<Provenance.Agent> theValue)
Sets the value(s) for agent (who)
|
Provenance |
setEntity(List<Provenance.Entity> theValue)
Sets the value(s) for entity ()
|
Provenance |
setLocation(ResourceReferenceDt theValue)
Sets the value(s) for location (where)
|
Provenance |
setPeriod(PeriodDt theValue)
Sets the value(s) for period (when.done)
|
Provenance |
setPolicy(List<UriDt> theValue)
Sets the value(s) for policy ()
|
Provenance |
setReason(List<CodeableConceptDt> theValue)
Sets the value(s) for reason (why)
|
Provenance |
setRecorded(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for recorded (when.recorded)
|
Provenance |
setRecorded(InstantDt theValue)
Sets the value(s) for recorded (when.recorded)
|
Provenance |
setRecordedWithMillisPrecision(Date theDate)
Sets the value for recorded (when.recorded)
|
Provenance |
setSignature(List<SignatureDt> theValue)
Sets the value(s) for signature ()
|
Provenance |
setTarget(List<ResourceReferenceDt> theValue)
Sets the value(s) for target (what)
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_TARGET
Description:
Type: reference
Path: Provenance.target
public static final ReferenceClientParam TARGET
Description:
Type: reference
Path: Provenance.target
public static final String SP_START
Description:
Type: date
Path: Provenance.period.start
public static final DateClientParam START
Description:
Type: date
Path: Provenance.period.start
public static final String SP_END
Description:
Type: date
Path: Provenance.period.end
public static final DateClientParam END
Description:
Type: date
Path: Provenance.period.end
public static final String SP_LOCATION
Description:
Type: reference
Path: Provenance.location
public static final ReferenceClientParam LOCATION
Description:
Type: reference
Path: Provenance.location
public static final String SP_AGENT
Description:
Type: reference
Path: Provenance.agent.actor
public static final ReferenceClientParam AGENT
Description:
Type: reference
Path: Provenance.agent.actor
public static final String SP_USERID
Description:
Type: token
Path: Provenance.agent.userId
public static final TokenClientParam USERID
Description:
Type: token
Path: Provenance.agent.userId
public static final String SP_PATIENT
Description:
Type: reference
Path: Provenance.target
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: Provenance.target
public static final String SP_SIGTYPE
Description:
Type: token
Path: Provenance.signature.type
public static final TokenClientParam SIGTYPE
Description:
Type: token
Path: Provenance.signature.type
public static final String SP_ENTITYTYPE
Description:
Type: token
Path: Provenance.entity.type
public static final TokenClientParam ENTITYTYPE
Description:
Type: token
Path: Provenance.entity.type
public static final String SP_ENTITY
Description:
Type: uri
Path: Provenance.entity.reference
public static final UriClientParam ENTITY
Description:
Type: uri
Path: Provenance.entity.reference
public static final Include INCLUDE_AGENT
public static final Include INCLUDE_LOCATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_TARGET
public Provenance()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<ResourceReferenceDt> getTarget()
null.
Definition: 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
public Provenance setTarget(List<ResourceReferenceDt> theValue)
Definition: 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
public ResourceReferenceDt addTarget()
Definition: 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
public PeriodDt getPeriod()
null.
Definition: The period during which the activity occurred
public Provenance setPeriod(PeriodDt theValue)
Definition: The period during which the activity occurred
public InstantDt getRecordedElement()
null.
Definition: The instant of time at which the activity was recorded
public Date getRecorded()
null.
Definition: The instant of time at which the activity was recorded
public Provenance setRecorded(InstantDt theValue)
Definition: The instant of time at which the activity was recorded
public Provenance setRecordedWithMillisPrecision(Date theDate)
Definition: The instant of time at which the activity was recorded
public Provenance setRecorded(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The instant of time at which the activity was recorded
public List<CodeableConceptDt> getReason()
null.
Definition: The reason that the activity was taking place
public Provenance setReason(List<CodeableConceptDt> theValue)
Definition: The reason that the activity was taking place
public CodeableConceptDt addReason()
Definition: The reason that the activity was taking place
public Provenance addReason(CodeableConceptDt theValue)
Definition: The reason that the activity was taking place
theValue - The reason to add (must not be null)public CodeableConceptDt getReasonFirstRep()
Definition: The reason that the activity was taking place
public CodeableConceptDt getActivity()
null.
Definition: 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
public Provenance setActivity(CodeableConceptDt theValue)
Definition: 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
public ResourceReferenceDt getLocation()
null.
Definition: Where the activity occurred, if relevant
public Provenance setLocation(ResourceReferenceDt theValue)
Definition: Where the activity occurred, if relevant
public List<UriDt> getPolicy()
null.
Definition: 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.
public Provenance setPolicy(List<UriDt> theValue)
Definition: 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.
public UriDt addPolicy()
Definition: 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.
public Provenance addPolicy(UriDt theValue)
Definition: 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.
theValue - The policy to add (must not be null)public UriDt getPolicyFirstRep()
Definition: 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.
public Provenance addPolicy(String theUri)
Definition: 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.
public List<Provenance.Agent> getAgent()
null.
Definition: 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
public Provenance setAgent(List<Provenance.Agent> theValue)
Definition: 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
public Provenance.Agent addAgent()
Definition: 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
public Provenance addAgent(Provenance.Agent theValue)
Definition: 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
theValue - The agent to add (must not be null)public Provenance.Agent getAgentFirstRep()
Definition: 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
public List<Provenance.Entity> getEntity()
null.
Definition: An entity used in this activity
public Provenance setEntity(List<Provenance.Entity> theValue)
Definition: An entity used in this activity
public Provenance.Entity addEntity()
Definition: An entity used in this activity
public Provenance addEntity(Provenance.Entity theValue)
Definition: An entity used in this activity
theValue - The entity to add (must not be null)public Provenance.Entity getEntityFirstRep()
Definition: An entity used in this activity
public List<SignatureDt> getSignature()
null.
Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
public Provenance setSignature(List<SignatureDt> theValue)
Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
public SignatureDt addSignature()
Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
public Provenance addSignature(SignatureDt theValue)
Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
theValue - The signature to add (must not be null)public SignatureDt getSignatureFirstRep()
Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.