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

    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
    • 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.)
      • period

        protected Period period
        The period during which the activity occurred.
      • 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.)
      • reason

        protected List<Coding> reason
        The reason that the activity was taking place.
      • 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.
      • 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-ref

        Description: 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-ref

        Description: 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: agent

        Description: 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 agent

        Description: 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-type

        Description: 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-type

        Description: 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: patient

        Description: 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 patient

        Description: 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: start

        Description: 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 start

        Description: Starting time with inclusive boundary
        Type: date
        Path: Provenance.period.start

      • SP_END

        public static final String SP_END
        Search parameter: end

        Description: 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 end

        Description: End time with inclusive boundary, if not ongoing
        Type: date
        Path: Provenance.period.end

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter: location

        Description: 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 location

        Description: 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: recorded

        Description: 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 recorded

        Description: When the activity was recorded / updated
        Type: date
        Path: Provenance.recorded

      • AGENT_ROLE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_ROLE
        Fluent Client search parameter constant for agent-role

        Description: What the agents role was
        Type: token
        Path: Provenance.agent.role

      • SP_ENTITY_ID

        public static final String SP_ENTITY_ID
        Search parameter: entity-id

        Description: 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-id

        Description: Identity of entity
        Type: token
        Path: Provenance.entity.whatIdentifier

      • SP_TARGET

        public static final String SP_TARGET
        Search parameter: target

        Description: 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 target

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