Smile CDR v2022.08.PRE
On this page:
   37.85    OpenID Connect (OIDC) 37.87    Realtime Export   

37.86Provenance Injection

 

The Provenance Injection configuration category includes the following configurable options:

  • Agent Type

  • Agent Who

  • $everything operation

  • Profile

  • _revinclude=Provenance:target

37.86.1Property: Agent Type

 
Property Name Agent Type
Property Key
Property Type STRING
Description The participation the agent had with respect to the activity. This should be the code system value and then pipe-delimited with the code value, e.g. http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type|transmitter.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.provenance_injection.agent_type = 

37.86.2Property: Agent Who

 
Property Name Agent Who
Property Key
Property Type STRING
Description Required if Provenance injection is enabled. The organization that participated in the event. This should be a reference to an Organization, e.g. Organization/123.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.provenance_injection.agent_who = 

37.86.3Property: $everything operation

 
Property Name $everything operation
Property Key
Property Type BOOLEAN
Description If set to true, a Provenance resource will be injected when $everything operation is invoked.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.provenance_injection.everything_enabled = false

37.86.4Property: Profile

 
Property Name Profile
Property Key
Property Type STRING
Description The profile (references to [[[StructureDefinition]]]) that the Provenance claims to conform to, e.g. http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.provenance_injection.profile = 

37.86.5Property: _revinclude=Provenance:target

 
Property Name _revinclude=Provenance:target
Property Key
Property Type BOOLEAN
Description If set to true, a Provenance resource will be injected when a search that includes ?_revinclude=Provenance:target is invoked.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.provenance_injection.revinclude_enabled = false
   37.85    OpenID Connect (OIDC) 37.87    Realtime Export