
Class Provenance
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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.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 agentstatic ca.uhn.fhir.rest.gclient.TokenClientParam
AGENT_ROLE
Fluent Client search parameter constant for agent-rolestatic ca.uhn.fhir.rest.gclient.DateClientParam
END
Fluent Client search parameter constant for endprotected List<Provenance.ProvenanceEntityComponent>
entity
An entity used in this activity.static ca.uhn.fhir.rest.gclient.TokenClientParam
ENTITY_ID
Fluent Client search parameter constant for entity-idstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENTITY_REF
Fluent Client search parameter constant for entity-refstatic 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_ENTITY_REF
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 locationprotected 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 patientprotected 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.DateClientParam
RECORDED
Fluent Client search parameter constant for recordedprotected List<Signature>
signature
A digital signature on the target Reference(s).static ca.uhn.fhir.rest.gclient.TokenClientParam
SIGNATURE_TYPE
Fluent Client search parameter constant for signature-typestatic String
SP_AGENT
Search parameter: agentstatic String
SP_AGENT_ROLE
Search parameter: agent-rolestatic String
SP_END
Search parameter: endstatic String
SP_ENTITY_ID
Search parameter: entity-idstatic String
SP_ENTITY_REF
Search parameter: entity-refstatic String
SP_LOCATION
Search parameter: locationstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_RECORDED
Search parameter: recordedstatic String
SP_SIGNATURE_TYPE
Search parameter: signature-typestatic String
SP_START
Search parameter: startstatic String
SP_TARGET
Search parameter: targetstatic ca.uhn.fhir.rest.gclient.DateClientParam
START
Fluent Client search parameter constant for startprotected 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 targetprotected 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.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Provenance()
ConstructorProvenance(InstantType recorded)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
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.)
-
recorded
protected InstantType recorded
The instant of time at which the activity was recorded.
-
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.
-
locationTarget
protected Location locationTarget
The actual object that is the target of the reference (Where the activity occurred, if relevant.)
-
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.
-
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_ENTITY_REF
public static final String SP_ENTITY_REF
Search parameter: entity-refDescription: Identity of entity
Type: reference
Path: Provenance.entity.whatReference
- See Also:
- Constant Field Values
-
ENTITY_REF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTITY_REF
Fluent Client search parameter constant for entity-refDescription: Identity of entity
Type: reference
Path: Provenance.entity.whatReference
-
INCLUDE_ENTITY_REF
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTITY_REF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:entity-ref".
-
SP_AGENT
public static final String SP_AGENT
Search parameter: agentDescription: Who participated
Type: reference
Path: Provenance.agent.who[x]
- See Also:
- Constant Field Values
-
AGENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT
Fluent Client search parameter constant for agentDescription: Who participated
Type: reference
Path: Provenance.agent.who[x]
-
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_SIGNATURE_TYPE
public static final String SP_SIGNATURE_TYPE
Search parameter: signature-typeDescription: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
- See Also:
- Constant Field Values
-
SIGNATURE_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SIGNATURE_TYPE
Fluent Client search parameter constant for signature-typeDescription: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: 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 patientDescription: 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_START
public static final String SP_START
Search parameter: startDescription: 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 startDescription: Starting time with inclusive boundary
Type: date
Path: Provenance.period.start
-
SP_END
public static final String SP_END
Search parameter: endDescription: 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 endDescription: End time with inclusive boundary, if not ongoing
Type: date
Path: Provenance.period.end
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: 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 locationDescription: 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_RECORDED
public static final String SP_RECORDED
Search parameter: recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
- See Also:
- Constant Field Values
-
RECORDED
public static final ca.uhn.fhir.rest.gclient.DateClientParam RECORDED
Fluent Client search parameter constant for recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
-
SP_AGENT_ROLE
public static final String SP_AGENT_ROLE
Search parameter: agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
- See Also:
- Constant Field Values
-
AGENT_ROLE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_ROLE
Fluent Client search parameter constant for agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
-
SP_ENTITY_ID
public static final String SP_ENTITY_ID
Search parameter: entity-idDescription: Identity of entity
Type: token
Path: Provenance.entity.whatIdentifier
- See Also:
- Constant Field Values
-
ENTITY_ID
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ENTITY_ID
Fluent Client search parameter constant for entity-idDescription: Identity of entity
Type: token
Path: Provenance.entity.whatIdentifier
-
SP_TARGET
public static final String SP_TARGET
Search parameter: targetDescription: 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 targetDescription: 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".
-
-
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.)
-
setTarget
public Provenance setTarget(List<Reference> theTarget)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTarget
public boolean hasTarget()
-
addTarget
public Provenance addTarget(Reference t)
-
getTargetFirstRep
public Reference getTargetFirstRep()
- Returns:
- The first repetition of repeating field
target
, creating it if it does not already exist
-
getTargetTarget
@Deprecated public List<Resource> getTargetTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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.
-
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.)
-
setPolicy
public Provenance setPolicy(List<UriType> thePolicy)
- Returns:
- Returns a reference to
this
for easy method chaining
-
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.)
-
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.)
-
getReason
public List<Coding> getReason()
- Returns:
reason
(The reason that the activity was taking place.)
-
setReason
public Provenance setReason(List<Coding> theReason)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
public boolean hasReason()
-
addReason
public Provenance addReason(Coding t)
-
getReasonFirstRep
public Coding getReasonFirstRep()
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist
-
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.)
-
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.)
-
setAgent
public Provenance setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAgent
public boolean hasAgent()
-
addAgent
public Provenance.ProvenanceAgentComponent addAgent()
-
addAgent
public Provenance addAgent(Provenance.ProvenanceAgentComponent t)
-
getAgentFirstRep
public Provenance.ProvenanceAgentComponent getAgentFirstRep()
- Returns:
- The first repetition of repeating field
agent
, creating it if it does not already exist
-
getEntity
public List<Provenance.ProvenanceEntityComponent> getEntity()
- Returns:
entity
(An entity used in this activity.)
-
setEntity
public Provenance setEntity(List<Provenance.ProvenanceEntityComponent> theEntity)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEntity
public boolean hasEntity()
-
addEntity
public Provenance.ProvenanceEntityComponent addEntity()
-
addEntity
public Provenance addEntity(Provenance.ProvenanceEntityComponent t)
-
getEntityFirstRep
public Provenance.ProvenanceEntityComponent getEntityFirstRep()
- Returns:
- The first repetition of repeating field
entity
, creating it if it does not already exist
-
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.)
-
setSignature
public Provenance setSignature(List<Signature> theSignature)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSignature
public boolean hasSignature()
-
addSignature
public Signature addSignature()
-
addSignature
public Provenance addSignature(Signature t)
-
getSignatureFirstRep
public Signature getSignatureFirstRep()
- Returns:
- The first repetition of repeating field
signature
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Provenance copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected Provenance typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-