FI Base Provenance - Finnish Base Profiles v2.0.0-ci

Finnish Base Profiles
2.0.0-ci - ci-build Finland flag

Finnish Base Profiles, published by HL7 Finland. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fhir-fi/finnish-base-profiles/ and changes regularly. See the Directory of published versions

Resource Profile: FI Base Provenance

Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-provenance				Version: 2.0.0-ci
Draft as of 2025-03-27				Computable Name: FiBaseProvenance

This is the Finnish base profile for the Provenance resource.

Usage:

Derived from this Resource Profile: FI Base InformationCustodian, An imaginary profile for Kanta system, utilizing the Finnish Base Information Custodian profile and An imaginary profile for Kanta system, specifying things apart from the information custodian
Refer to this Resource Profile: FI Base MedicationAdministration and FI Base MedicationRequest

Formal Views of Profile Content

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

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific) ele-1: All FHIR elements must have a @value or children
recorded	Σ	1..1	instant	When the activity was recorded / updated ele-1: All FHIR elements must have a @value or children
location		0..1	Reference(FI Base Location)	Where the activity occurred, if relevant ele-1: All FHIR elements must have a @value or children
agent		1..*	BackboneElement	Actor involved ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
who	Σ	1..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who participated ele-1: All FHIR elements must have a @value or children
onBehalfOf		0..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who the agent is representing ele-1: All FHIR elements must have a @value or children
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	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-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Name	Card.	Type	Description & Constraints
Provenance		Provenance
location	0..1	Reference(FI Base Location)	Where the activity occurred, if relevant
agent
who	1..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who participated
onBehalfOf	0..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who the agent is representing
Documentation for this format

Description & Constraints

Provenance

0..*

Provenance

Who, What, When for a set of resources

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Provenance.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Provenance.reason

extensible

PurposeOfUse

http://terminology.hl7.org/ValueSet/v3-PurposeOfUse

Provenance.activity

extensible

ProvenanceActivityType

http://hl7.org/fhir/ValueSet/provenance-activity-type

from the FHIR Standard

Provenance.agent.type

extensible

ProvenanceParticipantType

http://hl7.org/fhir/ValueSet/provenance-agent-type

from the FHIR Standard

Provenance.agent.role

example

SecurityRoleType

http://hl7.org/fhir/ValueSet/security-role-type

from the FHIR Standard

Provenance.entity.role

required

ProvenanceEntityRole

http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	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-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Summary

Structures

This structure refers to these other structures:

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific) ele-1: All FHIR elements must have a @value or children
recorded	Σ	1..1	instant	When the activity was recorded / updated ele-1: All FHIR elements must have a @value or children
location		0..1	Reference(FI Base Location)	Where the activity occurred, if relevant ele-1: All FHIR elements must have a @value or children
agent		1..*	BackboneElement	Actor involved ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
who	Σ	1..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who participated ele-1: All FHIR elements must have a @value or children
onBehalfOf		0..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who the agent is representing ele-1: All FHIR elements must have a @value or children
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	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-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Provenance

Name	Card.	Type	Description & Constraints
Provenance		Provenance
location	0..1	Reference(FI Base Location)	Where the activity occurred, if relevant
agent
who	1..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who participated
onBehalfOf	0..1	Reference(FI Base Practitioner \| FI Base PractitionerRole \| FI Base Patient \| RelatedPerson \| Device \| FI Base Organization)	Who the agent is representing
Documentation for this format

Snapshot View

Description & Constraints

Provenance

0..*

Provenance

Who, What, When for a set of resources

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Provenance.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Provenance.reason

extensible

PurposeOfUse

http://terminology.hl7.org/ValueSet/v3-PurposeOfUse

Provenance.activity

extensible

ProvenanceActivityType

http://hl7.org/fhir/ValueSet/provenance-activity-type

from the FHIR Standard

Provenance.agent.type

extensible

ProvenanceParticipantType

http://hl7.org/fhir/ValueSet/provenance-agent-type

from the FHIR Standard

Provenance.agent.role

example

SecurityRoleType

http://hl7.org/fhir/ValueSet/security-role-type

from the FHIR Standard

Provenance.entity.role

required

ProvenanceEntityRole

http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	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-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Provenance

Summary

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel, Schematron