Provenance (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Provenance

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Provenance
extends BaseResource
implements IResource
```
HAPI/FHIR Provenance Resource (Who, What, When for a set of resources)
Definition: Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Provenance

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Provenance.Agent` Block class for child element: Provenance.agent (Person, organization, records, etc.
`static class`	`Provenance.Entity` Block class for child element: Provenance.entity (An entity used in this activity)

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`END` Fluent Client search parameter constant for end
`static Include`	`INCLUDE_LOCATION` 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 TokenClientParam`	`PARTY` Fluent Client search parameter constant for party
`static TokenClientParam`	`PARTYTYPE` Fluent Client search parameter constant for partytype
`static String`	`SP_END` Search parameter constant for end
`static String`	`SP_LOCATION` Search parameter constant for location
`static String`	`SP_PARTY` Search parameter constant for party
`static String`	`SP_PARTYTYPE` Search parameter constant for partytype
`static String`	`SP_START` Search parameter constant for start
`static String`	`SP_TARGET` Search parameter constant for target
`static DateClientParam`	`START` Fluent Client search parameter constant for start
`static ReferenceClientParam`	`TARGET` Fluent Client search parameter constant for target

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Provenance()

Constructors
Constructor and Description
`Provenance()`

Method Summary

Methods
Modifier and Type	Method and Description
`Provenance.Agent`	`addAgent()` Adds and returns a new value for agent (Person, organization, records, etc.
`Provenance.Entity`	`addEntity()` Adds and returns a new value for entity (An entity used in this activity)
`UriDt`	`addPolicy()` Adds and returns a new value for policy (Policy or plan the activity was defined by)
`Provenance`	`addPolicy(String theUri)` Adds a new value for policy (Policy or plan the activity was defined by)
`ResourceReferenceDt`	`addTarget()` Adds and returns a new value for target (Target resource(s) (usually version specific))
`List<Provenance.Agent>`	`getAgent()` Gets the value(s) for agent (Person, organization, records, etc.
`Provenance.Agent`	`getAgentFirstRep()` Gets the first repetition for agent (Person, organization, records, etc.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<Provenance.Entity>`	`getEntity()` Gets the value(s) for entity (An entity used in this activity).
`Provenance.Entity`	`getEntityFirstRep()` Gets the first repetition for entity (An entity used in this activity), creating it if it does not already exist.
`StringDt`	`getIntegritySignature()` Gets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check).
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location (Where the activity occurred, if relevant).
`PeriodDt`	`getPeriod()` Gets the value(s) for period (When the activity occurred).
`List<UriDt>`	`getPolicy()` Gets the value(s) for policy (Policy or plan the activity was defined by).
`UriDt`	`getPolicyFirstRep()` Gets the first repetition for policy (Policy or plan the activity was defined by), creating it if it does not already exist.
`CodeableConceptDt`	`getReason()` Gets the value(s) for reason (Reason the activity is occurring).
`InstantDt`	`getRecorded()` Gets the value(s) for recorded (When the activity was recorded / updated).
`List<ResourceReferenceDt>`	`getTarget()` Gets the value(s) for target (Target resource(s) (usually version specific)).
`boolean`	`isEmpty()`
`Provenance`	`setAgent(List<Provenance.Agent> theValue)` Sets the value(s) for agent (Person, organization, records, etc.
`Provenance`	`setEntity(List<Provenance.Entity> theValue)` Sets the value(s) for entity (An entity used in this activity)
`Provenance`	`setIntegritySignature(String theString)` Sets the value for integritySignature (Base64 signature (DigSig) - integrity check)
`Provenance`	`setIntegritySignature(StringDt theValue)` Sets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check)
`Provenance`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location (Where the activity occurred, if relevant)
`Provenance`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period (When the activity occurred)
`Provenance`	`setPolicy(List<UriDt> theValue)` Sets the value(s) for policy (Policy or plan the activity was defined by)
`Provenance`	`setReason(CodeableConceptDt theValue)` Sets the value(s) for reason (Reason the activity is occurring)
`Provenance`	`setRecorded(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for recorded (When the activity was recorded / updated)
`Provenance`	`setRecorded(InstantDt theValue)` Sets the value(s) for recorded (When the activity was recorded / updated)
`Provenance`	`setRecordedWithMillisPrecision(Date theDate)` Sets the value for recorded (When the activity was recorded / updated)
`Provenance`	`setTarget(List<ResourceReferenceDt> theValue)` Sets the value(s) for target (Target resource(s) (usually version specific))

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_TARGET
```
public static final String SP_TARGET
```
    Search parameter constant for target
    Description:
    Type: reference
    Path: Provenance.target
    
    See Also:
    Constant Field Values
  - TARGET
```
public static final ReferenceClientParam TARGET
```
    Fluent Client search parameter constant for target
    Description:
    Type: reference
    Path: Provenance.target
  - INCLUDE_TARGET
```
public static final Include INCLUDE_TARGET
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance.target".
  - SP_START
```
public static final String SP_START
```
    Search parameter constant for start
    Description:
    Type: date
    Path: Provenance.period.start
    
    See Also:
    Constant Field Values
  - START
```
public static final DateClientParam START
```
    Fluent Client search parameter constant for start
    Description:
    Type: date
    Path: Provenance.period.start
  - SP_END
```
public static final String SP_END
```
    Search parameter constant for end
    Description:
    Type: date
    Path: Provenance.period.end
    
    See Also:
    Constant Field Values
  - END
```
public static final DateClientParam END
```
    Fluent Client search parameter constant for end
    Description:
    Type: date
    Path: Provenance.period.end
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter constant for location
    Description:
    Type: reference
    Path: Provenance.location
    
    See Also:
    Constant Field Values
  - LOCATION
```
public static final ReferenceClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description:
    Type: reference
    Path: Provenance.location
  - INCLUDE_LOCATION
```
public static final Include INCLUDE_LOCATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance.location".
  - SP_PARTY
```
public static final String SP_PARTY
```
    Search parameter constant for party
    Description:
    Type: token
    Path: Provenance.agent.reference
    
    See Also:
    Constant Field Values
  - PARTY
```
public static final TokenClientParam PARTY
```
    Fluent Client search parameter constant for party
    Description:
    Type: token
    Path: Provenance.agent.reference
  - SP_PARTYTYPE
```
public static final String SP_PARTYTYPE
```
    Search parameter constant for partytype
    Description:
    Type: token
    Path: Provenance.agent.type
    
    See Also:
    Constant Field Values
  - PARTYTYPE
```
public static final TokenClientParam PARTYTYPE
```
    Fluent Client search parameter constant for partytype
    Description:
    Type: token
    Path: Provenance.agent.type
- Constructor Detail
  - Provenance
```
public Provenance()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getTarget
```
public List<ResourceReferenceDt> getTarget()
```
    Gets the value(s) for target (Target resource(s) (usually version specific)). creating it if it does not exist. Will not return null.
    Definition: The resource(s) that were generated 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<ResourceReferenceDt> theValue)
```
    Sets the value(s) for target (Target resource(s) (usually version specific))
    Definition: The resource(s) that were generated 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 ResourceReferenceDt addTarget()
```
    Adds and returns a new value for target (Target resource(s) (usually version specific))
    Definition: The resource(s) that were generated 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 PeriodDt getPeriod()
```
    Gets the value(s) for period (When the activity occurred). creating it if it does not exist. Will not return null.
    Definition: The period during which the activity occurred
  - setPeriod
```
public Provenance setPeriod(PeriodDt theValue)
```
    Sets the value(s) for period (When the activity occurred)
    Definition: The period during which the activity occurred
  - getRecorded
```
public InstantDt getRecorded()
```
    Gets the value(s) for recorded (When the activity was recorded / updated). creating it if it does not exist. Will not return null.
    Definition: The instant of time at which the activity was recorded
  - setRecorded
```
public Provenance setRecorded(InstantDt theValue)
```
    Sets the value(s) for recorded (When the activity was recorded / updated)
    Definition: The instant of time at which the activity was recorded
  - setRecorded
```
public Provenance setRecorded(Date theDate,
                     TemporalPrecisionEnum thePrecision)
```
    Sets the value for recorded (When the activity was recorded / updated)
    Definition: The instant of time at which the activity was recorded
  - setRecordedWithMillisPrecision
```
public Provenance setRecordedWithMillisPrecision(Date theDate)
```
    Sets the value for recorded (When the activity was recorded / updated)
    Definition: The instant of time at which the activity was recorded
  - getReason
```
public CodeableConceptDt getReason()
```
    Gets the value(s) for reason (Reason the activity is occurring). creating it if it does not exist. Will not return null.
    Definition: The reason that the activity was taking place
  - setReason
```
public Provenance setReason(CodeableConceptDt theValue)
```
    Sets the value(s) for reason (Reason the activity is occurring)
    Definition: The reason that the activity was taking place
  - getLocation
```
public ResourceReferenceDt getLocation()
```
    Gets the value(s) for location (Where the activity occurred, if relevant). creating it if it does not exist. Will not return null.
    Definition: Where the activity occurred, if relevant
  - setLocation
```
public Provenance setLocation(ResourceReferenceDt theValue)
```
    Sets the value(s) for location (Where the activity occurred, if relevant)
    Definition: Where the activity occurred, if relevant
  - getPolicy
```
public List<UriDt> getPolicy()
```
    Gets the value(s) for policy (Policy or plan the activity was defined by). creating it if it does not exist. Will not return 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.
  - setPolicy
```
public Provenance setPolicy(List<UriDt> theValue)
```
    Sets the value(s) for policy (Policy or plan the activity was defined by)
    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.
  - addPolicy
```
public UriDt addPolicy()
```
    Adds and returns a new value for policy (Policy or plan the activity was defined by)
    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.
  - getPolicyFirstRep
```
public UriDt getPolicyFirstRep()
```
    Gets the first repetition for policy (Policy or plan the activity was defined by), creating it if it does not already exist.
    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.
  - addPolicy
```
public Provenance addPolicy(String theUri)
```
    Adds a new value for policy (Policy or plan the activity was defined by)
    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.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getAgent
```
public List<Provenance.Agent> getAgent()
```
    Gets the value(s) for agent (Person, organization, records, etc. involved in creating resource). creating it if it does not exist. Will not return 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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
  - setAgent
```
public Provenance setAgent(List<Provenance.Agent> theValue)
```
    Sets the value(s) for agent (Person, organization, records, etc. involved in creating resource)
    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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
  - addAgent
```
public Provenance.Agent addAgent()
```
    Adds and returns a new value for agent (Person, organization, records, etc. involved in creating resource)
    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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
  - getAgentFirstRep
```
public Provenance.Agent getAgentFirstRep()
```
    Gets the first repetition for agent (Person, organization, records, etc. involved in creating resource), creating it if it does not already exist.
    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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
  - getEntity
```
public List<Provenance.Entity> getEntity()
```
    Gets the value(s) for entity (An entity used in this activity). creating it if it does not exist. Will not return null.
    Definition: An entity used in this activity
  - setEntity
```
public Provenance setEntity(List<Provenance.Entity> theValue)
```
    Sets the value(s) for entity (An entity used in this activity)
    Definition: An entity used in this activity
  - addEntity
```
public Provenance.Entity addEntity()
```
    Adds and returns a new value for entity (An entity used in this activity)
    Definition: An entity used in this activity
  - getEntityFirstRep
```
public Provenance.Entity getEntityFirstRep()
```
    Gets the first repetition for entity (An entity used in this activity), creating it if it does not already exist.
    Definition: An entity used in this activity
  - getIntegritySignature
```
public StringDt getIntegritySignature()
```
    Gets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check). creating it if it does not exist. Will not return null.
    Definition: A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
  - setIntegritySignature
```
public Provenance setIntegritySignature(StringDt theValue)
```
    Sets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check)
    Definition: A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
  - setIntegritySignature
```
public Provenance setIntegritySignature(String theString)
```
    Sets the value for integritySignature (Base64 signature (DigSig) - integrity check)
    Definition: A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.

Class Provenance

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_TARGET

TARGET

INCLUDE_TARGET

SP_START

START

SP_END

END

SP_LOCATION

LOCATION

INCLUDE_LOCATION

SP_PARTY

PARTY

SP_PARTYTYPE

PARTYTYPE

Constructor Detail

Provenance

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getTarget

setTarget

addTarget

getPeriod

setPeriod

getRecorded

setRecorded

setRecorded

setRecordedWithMillisPrecision

getReason

setReason

getLocation

setLocation

getPolicy

setPolicy

addPolicy

getPolicyFirstRep

addPolicy

getAgent

setAgent

addAgent

getAgentFirstRep

getEntity

setEntity

addEntity

getEntityFirstRep

getIntegritySignature

setIntegritySignature

setIntegritySignature