
Class Provenance
- java.lang.Object
-
- ca.uhn.fhir.model.api.BaseElement
-
- ca.uhn.fhir.model.dstu2.resource.BaseResource
-
- ca.uhn.fhir.model.dstu2.resource.Provenance
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class Provenance extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Provenance Resource (infrastructure.information)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
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 ()
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.ReferenceClientParam
AGENT
Fluent Client search parameter constant for agentstatic ca.uhn.fhir.rest.gclient.DateClientParam
END
Fluent Client search parameter constant for endstatic ca.uhn.fhir.rest.gclient.UriClientParam
ENTITY
Fluent Client search parameter constant for entitystatic ca.uhn.fhir.rest.gclient.TokenClientParam
ENTITYTYPE
Fluent Client search parameter constant for entitytypestatic 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.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
LOCATION
Fluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.TokenClientParam
SIGTYPE
Fluent Client search parameter constant for sigtypestatic String
SP_AGENT
Search parameter constant for agentstatic String
SP_END
Search parameter constant for endstatic String
SP_ENTITY
Search parameter constant for entitystatic String
SP_ENTITYTYPE
Search parameter constant for entitytypestatic String
SP_LOCATION
Search parameter constant for locationstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_SIGTYPE
Search parameter constant for sigtypestatic String
SP_START
Search parameter constant for startstatic String
SP_TARGET
Search parameter constant for targetstatic String
SP_USERID
Search parameter constant for useridstatic ca.uhn.fhir.rest.gclient.DateClientParam
START
Fluent Client search parameter constant for startstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
TARGET
Fluent Client search parameter constant for targetstatic ca.uhn.fhir.rest.gclient.TokenClientParam
USERID
Fluent Client search parameter constant for userid-
Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
-
-
Constructor Summary
Constructors Constructor Description Provenance()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 ()ca.uhn.fhir.model.primitive.UriDt
addPolicy()
Adds and returns a new value for policy ()Provenance
addPolicy(ca.uhn.fhir.model.primitive.UriDt theValue)
Adds a given new value for policy ()Provenance
addPolicy(String theUri)
Adds a 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 ca.uhn.fhir.model.api.IElement>
List<T>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<ca.uhn.fhir.model.primitive.UriDt>
getPolicy()
Gets the value(s) for policy ().ca.uhn.fhir.model.primitive.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).ca.uhn.fhir.model.primitive.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.ca.uhn.fhir.context.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<ca.uhn.fhir.model.primitive.UriDt> theValue)
Sets the value(s) for policy ()Provenance
setReason(List<CodeableConceptDt> theValue)
Sets the value(s) for reason (why)Provenance
setRecorded(ca.uhn.fhir.model.primitive.InstantDt theValue)
Sets the value(s) for recorded (when.recorded)Provenance
setRecorded(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value 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)-
Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
-
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
-
-
-
Field Detail
-
SP_TARGET
public static final String SP_TARGET
Search parameter constant for targetDescription:
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 targetDescription:
Type: reference
Path: Provenance.target
-
SP_START
public static final String SP_START
Search parameter constant for startDescription:
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 startDescription:
Type: date
Path: Provenance.period.start
-
SP_END
public static final String SP_END
Search parameter constant for endDescription:
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 endDescription:
Type: date
Path: Provenance.period.end
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter constant for locationDescription:
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 locationDescription:
Type: reference
Path: Provenance.location
-
SP_AGENT
public static final String SP_AGENT
Search parameter constant for agentDescription:
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 agentDescription:
Type: reference
Path: Provenance.agent.actor
-
SP_USERID
public static final String SP_USERID
Search parameter constant for useridDescription:
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 useridDescription:
Type: token
Path: Provenance.agent.userId
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter constant for patientDescription:
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 patientDescription:
Type: reference
Path: Provenance.target
-
SP_SIGTYPE
public static final String SP_SIGTYPE
Search parameter constant for sigtypeDescription:
Type: token
Path: Provenance.signature.type
- See Also:
- Constant Field Values
-
SIGTYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SIGTYPE
Fluent Client search parameter constant for sigtypeDescription:
Type: token
Path: Provenance.signature.type
-
SP_ENTITYTYPE
public static final String SP_ENTITYTYPE
Search parameter constant for entitytypeDescription:
Type: token
Path: Provenance.entity.type
- See Also:
- Constant Field Values
-
ENTITYTYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ENTITYTYPE
Fluent Client search parameter constant for entitytypeDescription:
Type: token
Path: Provenance.entity.type
-
SP_ENTITY
public static final String SP_ENTITY
Search parameter constant for entityDescription:
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 entityDescription:
Type: uri
Path: Provenance.entity.reference
-
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".
-
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".
-
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".
-
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".
-
-
Constructor Detail
-
Provenance
public Provenance()
-
-
Method Detail
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getTarget
public List<ResourceReferenceDt> getTarget()
Gets the value(s) for target (what). creating it if it does not exist. Will not returnnull
.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
-
setTarget
public Provenance setTarget(List<ResourceReferenceDt> theValue)
Sets the value(s) for target (what)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
-
addTarget
public ResourceReferenceDt addTarget()
Adds and returns a new value for target (what)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
-
getPeriod
public PeriodDt getPeriod()
Gets the value(s) for period (when.done). creating it if it does not exist. Will not returnnull
.Definition: The period during which the activity occurred
-
setPeriod
public Provenance setPeriod(PeriodDt theValue)
Sets the value(s) for period (when.done)Definition: The period during which the activity occurred
-
getRecordedElement
public ca.uhn.fhir.model.primitive.InstantDt getRecordedElement()
Gets the value(s) for recorded (when.recorded). creating it if it does not exist. Will not returnnull
.Definition: The instant of time at which the activity was recorded
-
getRecorded
public Date getRecorded()
Gets the value(s) for recorded (when.recorded). creating it if it does not exist. This method may returnnull
.Definition: The instant of time at which the activity was recorded
-
setRecorded
public Provenance setRecorded(ca.uhn.fhir.model.primitive.InstantDt theValue)
Sets the value(s) for recorded (when.recorded)Definition: The instant of time at which the activity was recorded
-
setRecorded
public Provenance setRecorded(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for recorded (when.recorded)Definition: The instant of time at which the activity was recorded
-
setRecordedWithMillisPrecision
public Provenance setRecordedWithMillisPrecision(Date theDate)
Sets the value for recorded (when.recorded)Definition: The instant of time at which the activity was recorded
-
getReason
public List<CodeableConceptDt> getReason()
Gets the value(s) for reason (why). creating it if it does not exist. Will not returnnull
.Definition: The reason that the activity was taking place
-
setReason
public Provenance setReason(List<CodeableConceptDt> theValue)
Sets the value(s) for reason (why)Definition: The reason that the activity was taking place
-
addReason
public CodeableConceptDt addReason()
Adds and returns a new value for reason (why)Definition: The reason that the activity was taking place
-
addReason
public Provenance addReason(CodeableConceptDt theValue)
Adds a given new value for reason (why)Definition: The reason that the activity was taking place
- Parameters:
theValue
- The reason to add (must not benull
)
-
getReasonFirstRep
public CodeableConceptDt getReasonFirstRep()
Gets the first repetition for reason (why), creating it if it does not already exist.Definition: The reason that the activity was taking place
-
getActivity
public CodeableConceptDt getActivity()
Gets the value(s) for activity (why). creating it if it does not exist. Will not returnnull
.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
-
setActivity
public Provenance setActivity(CodeableConceptDt theValue)
Sets the value(s) for activity (why)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
-
getLocation
public ResourceReferenceDt getLocation()
Gets the value(s) for location (where). creating it if it does not exist. Will not returnnull
.Definition: Where the activity occurred, if relevant
-
setLocation
public Provenance setLocation(ResourceReferenceDt theValue)
Sets the value(s) for location (where)Definition: Where the activity occurred, if relevant
-
getPolicy
public List<ca.uhn.fhir.model.primitive.UriDt> getPolicy()
Gets the value(s) for policy (). creating it if it does not exist. Will not returnnull
.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<ca.uhn.fhir.model.primitive.UriDt> theValue)
Sets the value(s) for policy ()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 ca.uhn.fhir.model.primitive.UriDt addPolicy()
Adds and returns a new value for policy ()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(ca.uhn.fhir.model.primitive.UriDt theValue)
Adds a given new value for policy ()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.
- Parameters:
theValue
- The policy to add (must not benull
)
-
getPolicyFirstRep
public ca.uhn.fhir.model.primitive.UriDt getPolicyFirstRep()
Gets the first repetition for policy (), 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 ()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 (who). creating it if it does not exist. Will not returnnull
.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
-
setAgent
public Provenance setAgent(List<Provenance.Agent> theValue)
Sets the value(s) for agent (who)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
-
addAgent
public Provenance.Agent addAgent()
Adds and returns a new value for agent (who)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
-
addAgent
public Provenance addAgent(Provenance.Agent theValue)
Adds a given new value for agent (who)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
- Parameters:
theValue
- The agent to add (must not benull
)
-
getAgentFirstRep
public Provenance.Agent getAgentFirstRep()
Gets the first repetition for agent (who), 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, an organization, software, or other entities that may be ascribed responsibility
-
getEntity
public List<Provenance.Entity> getEntity()
Gets the value(s) for entity (). creating it if it does not exist. Will not returnnull
.Definition: An entity used in this activity
-
setEntity
public Provenance setEntity(List<Provenance.Entity> theValue)
Sets the value(s) for entity ()Definition: An entity used in this activity
-
addEntity
public Provenance.Entity addEntity()
Adds and returns a new value for entity ()Definition: An entity used in this activity
-
addEntity
public Provenance addEntity(Provenance.Entity theValue)
Adds a given new value for entity ()Definition: An entity used in this activity
- Parameters:
theValue
- The entity to add (must not benull
)
-
getEntityFirstRep
public Provenance.Entity getEntityFirstRep()
Gets the first repetition for entity (), creating it if it does not already exist.Definition: An entity used in this activity
-
getSignature
public List<SignatureDt> getSignature()
Gets the value(s) for signature (). creating it if it does not exist. Will not returnnull
.Definition: 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<SignatureDt> theValue)
Sets the value(s) for signature ()Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
-
addSignature
public SignatureDt addSignature()
Adds and returns a new value for signature ()Definition: 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(SignatureDt theValue)
Adds a given new value for signature ()Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
- Parameters:
theValue
- The signature to add (must not benull
)
-
getSignatureFirstRep
public SignatureDt getSignatureFirstRep()
Gets the first repetition for signature (), creating it if it does not already exist.Definition: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
-
getResourceName
public String getResourceName()
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-
-