public class Provenance extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
Provenance.ProvenanceAgentComponent |
static class |
Provenance.ProvenanceEntityComponent |
static class |
Provenance.ProvenanceEntityRole |
static class |
Provenance.ProvenanceEntityRoleEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected CodeableConcept |
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 agent
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
AGENT_ROLE
Fluent Client search parameter constant for agent-role
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
AGENT_TYPE
Fluent Client search parameter constant for agent-type
|
protected List<Provenance.ProvenanceEntityComponent> |
entity
An entity used in this activity.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
ENTITY
Fluent Client search parameter constant for entity
|
static 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
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 location
|
protected Location |
locationTarget
The actual object that is the target of the reference (Where the activity occurred, if relevant.)
|
protected Type |
occurred
The period during which the activity occurred.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
protected List<UriType> |
policy
Policy or plan the activity was defined by.
|
protected List<CodeableConcept> |
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 recorded
|
protected 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-type
|
static String |
SP_AGENT
Search parameter: agent
|
static String |
SP_AGENT_ROLE
Search parameter: agent-role
|
static String |
SP_AGENT_TYPE
Search parameter: agent-type
|
static String |
SP_ENTITY
Search parameter: entity
|
static String |
SP_LOCATION
Search parameter: location
|
static String |
SP_PATIENT
Search parameter: patient
|
static String |
SP_RECORDED
Search parameter: recorded
|
static String |
SP_SIGNATURE_TYPE
Search parameter: signature-type
|
static String |
SP_TARGET
Search parameter: target
|
static String |
SP_WHEN
Search parameter: when
|
protected 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 target
|
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.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
WHEN
Fluent Client search parameter constant for when
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
Provenance()
Constructor
|
Provenance(InstantType recorded)
Constructor
|
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Reference> target
protected List<Resource> targetTarget
protected InstantType recorded
protected List<UriType> policy
protected Location locationTarget
protected List<CodeableConcept> reason
protected CodeableConcept activity
protected List<Provenance.ProvenanceAgentComponent> agent
protected List<Provenance.ProvenanceEntityComponent> entity
protected List<Signature> signature
public static final String SP_AGENT_TYPE
Description: How the agent participated
Type: token
Path: Provenance.agent.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_TYPE
Description: How the agent participated
Type: token
Path: Provenance.agent.type
public static final String SP_AGENT
Description: Who participated
Type: reference
Path: Provenance.agent.who
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT
Description: Who participated
Type: reference
Path: Provenance.agent.who
public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT
public static final String SP_SIGNATURE_TYPE
Description: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SIGNATURE_TYPE
Description: Indication of the reason the entity signed the object(s)
Type: token
Path: Provenance.signature.type
public static final String SP_PATIENT
Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_LOCATION
Description: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
Description: Where the activity occurred, if relevant
Type: reference
Path: Provenance.location
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
public static final String SP_RECORDED
Description: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
public static final ca.uhn.fhir.rest.gclient.DateClientParam RECORDED
Description: When the activity was recorded / updated
Type: date
Path: Provenance.recorded
public static final String SP_AGENT_ROLE
Description: What the agents role was
Type: token
Path: Provenance.agent.role
public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_ROLE
Description: What the agents role was
Type: token
Path: Provenance.agent.role
public static final String SP_WHEN
Description: When the activity occurred
Type: date
Path: Provenance.occurredDateTime
public static final ca.uhn.fhir.rest.gclient.DateClientParam WHEN
Description: When the activity occurred
Type: date
Path: Provenance.occurredDateTime
public static final String SP_ENTITY
Description: Identity of entity
Type: reference
Path: Provenance.entity.what
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTITY
Description: Identity of entity
Type: reference
Path: Provenance.entity.what
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTITY
public static final String SP_TARGET
Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
Description: Target Reference(s) (usually version specific)
Type: reference
Path: Provenance.target
public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET
public Provenance()
public Provenance(InstantType recorded)
public List<Reference> getTarget()
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.)public Provenance setTarget(List<Reference> theTarget)
this for easy method chainingpublic boolean hasTarget()
public Provenance addTarget(Reference t)
public Reference getTargetFirstRep()
target, creating it if it does not already exist@Deprecated public List<Resource> getTargetTarget()
public Type getOccurred()
occurred (The period during which the activity occurred.)public Period getOccurredPeriod() throws org.hl7.fhir.exceptions.FHIRException
occurred (The period during which the activity occurred.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasOccurredPeriod()
public DateTimeType getOccurredDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
occurred (The period during which the activity occurred.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasOccurredDateTimeType()
public boolean hasOccurred()
public Provenance setOccurred(Type value)
value - occurred (The period during which the activity occurred.)public InstantType getRecordedElement()
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 valuepublic boolean hasRecordedElement()
public boolean hasRecorded()
public Provenance setRecordedElement(InstantType value)
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 valuepublic Date getRecorded()
public Provenance setRecorded(Date value)
value - The instant of time at which the activity was recorded.public List<UriType> getPolicy()
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.)public Provenance setPolicy(List<UriType> thePolicy)
this for easy method chainingpublic boolean hasPolicy()
public UriType addPolicyElement()
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.)public Provenance addPolicy(String value)
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.)public boolean hasPolicy(String value)
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.)public Reference getLocation()
location (Where the activity occurred, if relevant.)public boolean hasLocation()
public Provenance setLocation(Reference value)
value - location (Where the activity occurred, if relevant.)public Location getLocationTarget()
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.)public Provenance setLocationTarget(Location value)
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.)public List<CodeableConcept> getReason()
reason (The reason that the activity was taking place.)public Provenance setReason(List<CodeableConcept> theReason)
this for easy method chainingpublic boolean hasReason()
public CodeableConcept addReason()
public Provenance addReason(CodeableConcept t)
public CodeableConcept getReasonFirstRep()
reason, creating it if it does not already existpublic CodeableConcept getActivity()
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.)public boolean hasActivity()
public Provenance setActivity(CodeableConcept value)
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.)public List<Provenance.ProvenanceAgentComponent> getAgent()
agent (An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.)public Provenance setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)
this for easy method chainingpublic boolean hasAgent()
public Provenance.ProvenanceAgentComponent addAgent()
public Provenance addAgent(Provenance.ProvenanceAgentComponent t)
public Provenance.ProvenanceAgentComponent getAgentFirstRep()
agent, creating it if it does not already existpublic List<Provenance.ProvenanceEntityComponent> getEntity()
entity (An entity used in this activity.)public Provenance setEntity(List<Provenance.ProvenanceEntityComponent> theEntity)
this for easy method chainingpublic boolean hasEntity()
public Provenance.ProvenanceEntityComponent addEntity()
public Provenance addEntity(Provenance.ProvenanceEntityComponent t)
public Provenance.ProvenanceEntityComponent getEntityFirstRep()
entity, creating it if it does not already existpublic List<Signature> getSignature()
signature (A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.)public Provenance setSignature(List<Signature> theSignature)
this for easy method chainingpublic boolean hasSignature()
public Signature addSignature()
public Provenance addSignature(Signature t)
public Signature getSignatureFirstRep()
signature, creating it if it does not already existprotected void listChildren(List<Property> children)
listChildren in class DomainResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class DomainResourcepublic Provenance copy()
copy in class DomainResourcepublic void copyValues(Provenance dst)
protected Provenance typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.