Profile: ehealth-provenance

StructureDefinition: ehealth-provenance

In certain circumstances data from Observations and QuestionnaireResponses can be reused. When this happens, a Provenance resource will identify the source of the original data.

Provenance also covers state for messages, such as whether a message has been read/acknowledged (activity=read), time limited validity on notifications (using “period”) etc.

Provenance is also used to link correlated resources submitted together.

Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on Provenance.

This profile was published on Wed Mar 06 14:43:56 UTC 2019 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

Mandatory: 1 element

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance	I	0..*		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)
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		1..*	uri	Policy or plan the activity was defined by Binding: Policies for provenances (required)
location		0..1	Reference(Location)	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..*	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	uri, Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)	Who participated
onBehalfOf[x]		0..1	uri, Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)	Who the agent is representing
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	uri, Reference(Resource), Identifier	Identity of entity
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

Mandatory: 1 element

Differential View

This structure is derived from Provenance

Name	Card.	Type	Description & Constraints
Provenance	0..*
policy	1..*	uri	Binding: Policies for provenances (required)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Provenance	I	0..*		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)
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		1..*	uri	Policy or plan the activity was defined by Binding: Policies for provenances (required)
location		0..1	Reference(Location)	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..*	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	uri, Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)	Who participated
onBehalfOf[x]		0..1	uri, Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)	Who the agent is representing
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	uri, Reference(Resource), Identifier	Identity of entity
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	Name	Conformance	ValueSet
Provenance.language	Common Languages	extensible	Common Languages
Provenance.policy	Policies for provenances	required	Policies for provenances
Provenance.reason	PurposeOfUse	extensible	PurposeOfUse
Provenance.activity	ProvenanceActivityType	extensible	ProvenanceActivityType
Provenance.agent.role	SecurityRoleType	extensible	SecurityRoleType (missing link)
Provenance.agent.relatedAgentType	v3 Code System RoleLinkType	example	v3 Code System RoleLinkType
Provenance.entity.role	ProvenanceEntityRole	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())