Package ca.uhn.fhir.model.dstu2.resource

Class 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

    • Field Detail

      • TARGET

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
        Fluent Client search parameter constant for target

        Description:
        Type: reference
        Path: Provenance.target

      • START

        public static final ca.uhn.fhir.rest.gclient.DateClientParam START
        Fluent Client search parameter constant for start

        Description:
        Type: date
        Path: Provenance.period.start

      • END

        public static final ca.uhn.fhir.rest.gclient.DateClientParam END
        Fluent Client search parameter constant for end

        Description:
        Type: date
        Path: Provenance.period.end

      • LOCATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
        Fluent Client search parameter constant for location

        Description:
        Type: reference
        Path: Provenance.location

      • AGENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT
        Fluent Client search parameter constant for agent

        Description:
        Type: reference
        Path: Provenance.agent.actor

      • USERID

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam USERID
        Fluent Client search parameter constant for userid

        Description:
        Type: token
        Path: Provenance.agent.userId

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: Provenance.target

      • SIGTYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SIGTYPE
        Fluent Client search parameter constant for sigtype

        Description:
        Type: token
        Path: Provenance.signature.type

      • ENTITYTYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ENTITYTYPE
        Fluent Client search parameter constant for entitytype

        Description:
        Type: token
        Path: Provenance.entity.type

      • ENTITY

        public static final ca.uhn.fhir.rest.gclient.UriClientParam ENTITY
        Fluent Client search parameter constant for entity

        Description:
        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".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.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 interface ca.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 return null.

        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 return null.

        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 return null.

        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 return null.

        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

      • getReason

        public List<CodeableConceptDt> getReason()
        Gets the value(s) for reason (why). creating it if it does not exist. Will not return null.

        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 be null)

      • 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 return null.

        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 return null.

        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 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<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 be null)

      • 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 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, 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 be null)

      • 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 return null.

        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 be null)

      • 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 return null.

        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 be null)

      • 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 interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource