Package org.hl7.fhir.r5.model

Class Provenance

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.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:

  • Field Details

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

    • occurred

      protected DataType occurred
      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.

    • location

      protected Reference location
      Where the activity occurred, if relevant.

    • authorization

      protected List<CodeableReference> authorization
      The authorization (e.g., PurposeOfUse) that was used during the event being recorded.

    • activity

      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.

    • basedOn

      protected List<Reference> basedOn
      Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.

    • patient

      protected Reference patient
      The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.

    • encounter

      protected Reference 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

      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_ACTIVITY

      public static final String SP_ACTIVITY
      Search parameter: activity

      Description: Activity that occurred
      Type: token
      Path: Provenance.activity

      See Also:

    • ACTIVITY

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

      Description: Activity that occurred
      Type: token
      Path: Provenance.activity

    • SP_AGENT_ROLE

      public static final String SP_AGENT_ROLE
      Search parameter: agent-role

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

      See Also:

    • 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_AGENT_TYPE

      public static final String SP_AGENT_TYPE
      Search parameter: agent-type

      Description: How the agent participated
      Type: token
      Path: Provenance.agent.type

      See Also:

    • AGENT_TYPE

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

      Description: How the agent participated
      Type: token
      Path: Provenance.agent.type

    • SP_AGENT

      public static final String SP_AGENT
      Search parameter: agent

      Description: Who participated
      Type: reference
      Path: Provenance.agent.who

      See Also:

    • 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

    • 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_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Reference to the service request.
      Type: reference
      Path: Provenance.basedOn

      See Also:

    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: Reference to the service request.
      Type: reference
      Path: Provenance.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:based-on".

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Encounter related to the Provenance
      Type: reference
      Path: Provenance.encounter

      See Also:

    • ENCOUNTER

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

      Description: Encounter related to the Provenance
      Type: reference
      Path: Provenance.encounter

    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:encounter".

    • SP_ENTITY

      public static final String SP_ENTITY
      Search parameter: entity

      Description: Identity of entity
      Type: reference
      Path: Provenance.entity.what

      See Also:

    • ENTITY

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

      Description: Identity of entity
      Type: reference
      Path: Provenance.entity.what

    • INCLUDE_ENTITY

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTITY
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Provenance:entity".

    • 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:

    • 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_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Where the activity involved patient data
      Type: reference
      Path: Provenance.patient

      See Also:

    • PATIENT

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

      Description: Where the activity involved patient data
      Type: reference
      Path: Provenance.patient

    • 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_RECORDED

      public static final String SP_RECORDED
      Search parameter: recorded

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

      See Also:

    • 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

    • 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:

    • 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_TARGET

      public static final String SP_TARGET
      Search parameter: target

      Description: Target Reference(s) (usually version specific)
      Type: reference
      Path: Provenance.target

      See Also:

    • 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".

    • SP_WHEN

      public static final String SP_WHEN
      Search parameter: when

      Description: When the activity occurred
      Type: date
      Path: (Provenance.occurred as dateTime)

      See Also:

    • WHEN

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

      Description: When the activity occurred
      Type: date
      Path: (Provenance.occurred as dateTime)

  • Constructor Details

  • Method Details