
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CodeableConcept
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.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for activityprotected List<Provenance.ProvenanceAgentComponent>
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for agentstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for agent-rolestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for agent-typeprotected List<CodeableReference>
The authorization (e.g., PurposeOfUse) that was used during the event being recorded.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onAllows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.protected Reference
This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected List<Provenance.ProvenanceEntityComponent>
An entity used in this activity.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for entitystatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
Where the activity occurred, if relevant.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for locationprotected DataType
The period during which the activity occurred.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientPolicy or plan the activity was defined by.protected InstantType
The instant of time at which the activity was recorded.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for recordedA digital signature on the target Reference(s).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for signature-typestatic final String
Search parameter: activitystatic final String
Search parameter: agentstatic final String
Search parameter: agent-rolestatic final String
Search parameter: agent-typestatic final String
Search parameter: based-onstatic final String
Search parameter: encounterstatic final String
Search parameter: entitystatic final String
Search parameter: locationstatic final String
Search parameter: patientstatic final String
Search parameter: recordedstatic final String
Search parameter: signature-typestatic final String
Search parameter: targetstatic final String
Search parameter: whenThe Reference(s) that were generated or updated by the activity described in this resource.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for targetstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for whenFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorProvenance
(Reference target, Provenance.ProvenanceAgentComponent agent) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddAgent()
copy()
void
copyValues
(Provenance dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getAgent()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
hasAgent()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setActivity
(CodeableConcept value) setAgent
(List<Provenance.ProvenanceAgentComponent> theAgent) setAuthorization
(List<CodeableReference> theAuthorization) setBasedOn
(List<Reference> theBasedOn) setEncounter
(Reference value) setEntity
(List<Provenance.ProvenanceEntityComponent> theEntity) setLocation
(Reference value) setOccurred
(DataType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRecorded
(Date value) setRecordedElement
(InstantType value) setSignature
(List<Signature> theSignature) protected Provenance
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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 Details
-
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. -
occurred
The period during which the activity occurred. -
recorded
The instant of time at which the activity was recorded. -
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. -
location
Where the activity occurred, if relevant. -
authorization
The authorization (e.g., PurposeOfUse) that was used during the event being recorded. -
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. -
basedOn
Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon. -
encounter
This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests). -
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
An entity used in this activity. -
signature
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. -
SP_ACTIVITY
Search parameter: activityDescription: Activity that occurred
Type: token
Path: Provenance.activity
- See Also:
-
ACTIVITY
Fluent Client search parameter constant for activityDescription: Activity that occurred
Type: token
Path: Provenance.activity
-
SP_AGENT_ROLE
Search parameter: agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
- See Also:
-
AGENT_ROLE
Fluent Client search parameter constant for agent-roleDescription: What the agents role was
Type: token
Path: Provenance.agent.role
-
SP_AGENT_TYPE
Search parameter: agent-typeDescription: How the agent participated
Type: token
Path: Provenance.agent.type
- See Also:
-
AGENT_TYPE
Fluent Client search parameter constant for agent-typeDescription: How the agent participated
Type: token
Path: Provenance.agent.type
-
SP_AGENT
Search parameter: agentDescription: Who participated
Type: reference
Path: Provenance.agent.who
- See Also:
-
AGENT
Fluent Client search parameter constant for agentDescription: Who participated
Type: reference
Path: Provenance.agent.who
-
INCLUDE_AGENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:agent". -
SP_BASED_ON
Search parameter: based-onDescription: Reference to the service request.
Type: reference
Path: Provenance.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Reference to the service request.
Type: reference
Path: Provenance.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:based-on". -
SP_ENCOUNTER
Search parameter: encounterDescription: Encounter related to the Provenance
Type: reference
Path: Provenance.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter related to the Provenance
Type: reference
Path: Provenance.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:encounter". -
SP_ENTITY
Search parameter: entityDescription: Identity of entity
Type: reference
Path: Provenance.entity.what
- See Also:
-
ENTITY
Fluent Client search parameter constant for entityDescription: Identity of entity
Type: reference
Path: Provenance.entity.what
-
INCLUDE_ENTITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:entity". -
SP_LOCATION
Search parameter: locationDescription: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:location". -
SP_PATIENT
Search parameter: patientDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target.where(resolve() is Patient)
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target.where(resolve() is Patient)
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:patient". -
SP_RECORDED
Search parameter: recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
- See Also:
-
RECORDED
Fluent Client search parameter constant for recordedDescription: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
-
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:
-
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_TARGET
Search parameter: targetDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
- See Also:
-
TARGET
Fluent Client search parameter constant for targetDescription: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
-
INCLUDE_TARGET
Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:target". -
SP_WHEN
Search parameter: whenDescription: When the activity occurred
Type: date
Path: (Provenance.occurred as dateTime)
- See Also:
-
WHEN
Fluent Client search parameter constant for whenDescription: When the activity occurred
Type: date
Path: (Provenance.occurred as dateTime)
-
-
Constructor Details
-
Provenance
public Provenance()Constructor -
Provenance
Constructor
-
-
Method Details
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTarget
-
addTarget
-
addTarget
-
getTargetFirstRep
- Returns:
- The first repetition of repeating field
target
, creating it if it does not already exist {3}
-
getOccurred
- Returns:
occurred
(The period during which the activity occurred.)
-
getOccurredPeriod
- Returns:
occurred
(The period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredPeriod
-
getOccurredDateTimeType
- Returns:
occurred
(The period during which the activity occurred.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurredDateTimeType
-
hasOccurred
-
setOccurred
- Parameters:
value
-occurred
(The period during which the activity occurred.)
-
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
-
hasRecorded
-
setRecordedElement
- 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
- Returns:
- The instant of time at which the activity was recorded.
-
setRecorded
- Parameters:
value
- The instant of time at which the activity was recorded.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPolicy
-
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
- 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
- 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
- Returns:
location
(Where the activity occurred, if relevant.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Where the activity occurred, if relevant.)
-
getAuthorization
- Returns:
authorization
(The authorization (e.g., PurposeOfUse) that was used during the event being recorded.)
-
setAuthorization
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthorization
-
addAuthorization
-
addAuthorization
-
getAuthorizationFirstRep
- Returns:
- The first repetition of repeating field
authorization
, creating it if it does not already exist {3}
-
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
-
setActivity
- 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.)
-
getBasedOn
- Returns:
basedOn
(Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist {3}
-
getEncounter
- Returns:
encounter
(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAgent
-
addAgent
-
addAgent
-
getAgentFirstRep
- Returns:
- The first repetition of repeating field
agent
, creating it if it does not already exist {3}
-
getEntity
- Returns:
entity
(An entity used in this activity.)
-
setEntity
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEntity
-
addEntity
-
addEntity
-
getEntityFirstRep
- Returns:
- The first repetition of repeating field
entity
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSignature
-
addSignature
-
addSignature
-
getSignatureFirstRep
- Returns:
- The first repetition of repeating field
signature
, creating it if it does not already exist {3}
-
listChildren
- 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
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-