Provenance

ResourceFoundation · SecurityTrial useMaturity 3

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

10 of 10 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
targetRequiredΣ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
occurred[x]	0..1	Period | dateTime	When the activity occurred
recordedRequiredΣ	1..1	instant	When the activity was recorded / updated
policy	0..*	uri	Policy or plan the activity was defined by
location	0..1	Reference(Location)	Where the activity occurred, if relevant
reason	0..*	CodeableConcept	Reason the activity is occurringBinding (extensible): v3-PurposeOfUse
activity	0..1	CodeableConcept	Activity that occurredBinding (extensible): provenance-activity-type
agentRequired	1..*	BackboneElement	Actor involved
typeΣ	0..1	CodeableConcept	How the agent participatedBinding (extensible): provenance-agent-type
role	0..*	CodeableConcept	What the agents role wasBinding (example): security-role-type
whoRequiredΣ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
onBehalfOf	0..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who the agent is representing
entity	0..*	BackboneElement	An entity used in this activity
roleRequiredΣ	1..1	code	derivation | revision | quotation | source | removalBinding (required): provenance-entity-role
whatRequiredΣ	1..1	Reference(Resource)	Identity of entity
agent	0..*	Same as Provenance.agent	Entity is attributed to this agent
signature	0..*	Signature	Signature on target

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Provenance?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
agent	reference	Who participated Provenance.agent.who
agent-role	token	What the agents role was Provenance.agent.role
agent-type	token	How the agent participated Provenance.agent.type
entity	reference	Identity of entity Provenance.entity.what
location	reference	Where the activity occurred, if relevant Provenance.location
patient	reference	Target Reference(s) (usually version specific) Provenance.target.where(resolve() is Patient)
recorded	date	When the activity was recorded / updated Provenance.recorded
signature-type	token	Indication of the reason the entity signed the object(s) Provenance.signature.type
target	reference	Target Reference(s) (usually version specific) Provenance.target
when	date	When the activity occurred (Provenance.occurred.ofType(dateTime))

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition