StructureDefinition: ehealth-detached-provenance

Introduction

Detached Provenance is a replica of the ehealth-provenance resource. While the ehealth-provenance profile is nested into other resource types, the “Detached Provenance” exists as a stand-alone entity that can be created, searched, and read.

Scope and Usage

In scope of the eHealth infrastructure the purpose of the Detached Provenance resource is:

Marking instances of ehealth-messages read/acknowledged (see eHealth-message for further details). Eg. to mark a message as read, a DetachedProvenance instance must be created with activity=read.
Indicating the temporal validity of notifications using the “period” attribute (to indicate in which point in the the notification is no longer valid)
Specifying legal patient context

A DetachedProvenance resource must reference the related ehealth-message instance using the “target” field, and the actual message recipient in the agent/whoReference field (see example in the “Examples” tab). Only one Provenance instance may be created per ehealth-message. If a different state must be registered, the existing Provenance resource must be updated.

Java examples of searching for DetachedProvenance based on message and recipient are located on the Wiki.

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-detached-provenance

This profile builds on Provenance.

This profile was published on Tue Feb 04 09:11:17 UTC 2020 as a draft by ehealth.sundhed.dk.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Provenance

Summary

Structures

This structure refers to these other structures:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner

This structure is derived from Provenance

Name	Card.	Type
Provenance	0..*	Provenance
location	0..1	Reference(Location) {r }
agent	1..1	BackboneElement
who[x]	1..1
whoUri		uri
whoReference		Reference(eHealth Practitioner \| eHealth Patient)
onBehalfOf[x]	0..1
onBehalfOfUri		uri
onBehalfOfReference		Reference(eHealth Practitioner \| eHealth Patient)
Documentation for this format

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance	I	0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
period		0..1	Period	When the activity occurred
recorded	Σ	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) {r }	Where the activity occurred, if relevant
reason		0..*	Coding	Reason the activity is occurring Binding: PurposeOfUse (extensible)
activity		0..1	Coding	Activity that occurred Binding: ProvenanceActivityType (extensible)
agent	I	1..1	BackboneElement	Actor involved
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (extensible)
who[x]	Σ	1..1		Who participated
whoUri			uri
whoReference			Reference(eHealth Practitioner \| eHealth Patient)
onBehalfOf[x]		0..1		Who the agent is representing
onBehalfOfUri			uri
onBehalfOfReference			Reference(eHealth Practitioner \| eHealth Patient)
relatedAgentType		0..1	CodeableConcept	Type of relationship between agents Binding: RoleLinkType (example)
entity	I	0..*	BackboneElement	An entity used in this activity
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required)
what[x]	Σ	1..1		Identity of entity
whatUri			uri
whatReference			Reference(Resource)
whatIdentifier			Identifier
agent		0..*		Unknown reference to #Provenance.agent Entity is attributed to this agent
signature		0..*	Signature	Signature on target
Documentation for this format

This structure is derived from Provenance

Summary

Structures

This structure refers to these other structures:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-practitioner

Differential View

This structure is derived from Provenance

Name	Card.	Type
Provenance	0..*	Provenance
location	0..1	Reference(Location) {r }
agent	1..1	BackboneElement
who[x]	1..1
whoUri		uri
whoReference		Reference(eHealth Practitioner \| eHealth Patient)
onBehalfOf[x]	0..1
onBehalfOfUri		uri
onBehalfOfReference		Reference(eHealth Practitioner \| eHealth Patient)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Provenance	I	0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
period		0..1	Period	When the activity occurred
recorded	Σ	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) {r }	Where the activity occurred, if relevant
reason		0..*	Coding	Reason the activity is occurring Binding: PurposeOfUse (extensible)
activity		0..1	Coding	Activity that occurred Binding: ProvenanceActivityType (extensible)
agent	I	1..1	BackboneElement	Actor involved
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (extensible)
who[x]	Σ	1..1		Who participated
whoUri			uri
whoReference			Reference(eHealth Practitioner \| eHealth Patient)
onBehalfOf[x]		0..1		Who the agent is representing
onBehalfOfUri			uri
onBehalfOfReference			Reference(eHealth Practitioner \| eHealth Patient)
relatedAgentType		0..1	CodeableConcept	Type of relationship between agents Binding: RoleLinkType (example)
entity	I	0..*	BackboneElement	An entity used in this activity
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required)
what[x]	Σ	1..1		Identity of entity
whatUri			uri
whatReference			Reference(Resource)
whatIdentifier			Identifier
agent		0..*		Unknown reference to #Provenance.agent Entity is attributed to this agent
signature		0..*	Signature	Signature on target
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Provenance.language	extensible	Common Languages Max Binding: All Languages
Provenance.reason	extensible	PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType
Provenance.agent.role	extensible	SecurityRoleType
Provenance.agent.relatedAgentType	example	v3 Code System RoleLinkType
Provenance.entity.role	required	ProvenanceEntityRole

Constraints

Id	Path	Details	Requirements
dom-2	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-1	Provenance	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-4	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1	Provenance.agent	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ele-1	Provenance.entity	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())