Finnish Base Profiles
2.0.0 - release

Finnish Base Profiles, published by HL7 Finland. This guide is not an authorized publication; it is the continuous build for version 2.0.0 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: An imaginary profile for Kanta system, specifying things apart from the information custodian

Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/kanta-document-other-metadata-profile | Version: 2.0.0
Active as of 2025-10-05 | Computable Name: KantaDocumentOtherMetadata

This is one way in which a system might use the Finnish Base Information Custodian profile. This profile defines other constraints. The profile KantaDocumentMetadata combines the requirements.

Usages:

- Impose this profile Profile: An imaginary profile for Kanta system, utilizing the Finnish Base Information Custodian profile and An imaginary profile for Kanta system, utilizing the Finnish Base Information Custodian profile

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.0) | Who, What, When for a set of resources
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who | Σ | 1..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who participated
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 FiBaseProvenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.0) | Who, What, When for a set of resources
agent |  |  |  |
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Binding: Example value set for provenance roles (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.role:kantaCoding.​coding.system | Base | required | Example value set for provenance roles | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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)
occurred[x] |  | 0..1 |  | When the activity occurred
occurredPeriod |  |  | Period |
occurredDateTime |  |  | dateTime |
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(FI Base Location(2.0.0)) | Where the activity occurred, if relevant
reason |  | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
activity |  | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent |  | 1..* | BackboneElement | Actor involved
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system Binding: Example value set for provenance roles (required)
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | Σ | 1..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who participated
onBehalfOf |  | 0..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who the agent is representing
entity |  | 0..* | BackboneElement | An entity used in this activity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
what | Σ | 1..1 | Reference(Resource) | Identity of entity
agent |  | 0..* | See agent (Provenance) | Entity is attributed to this agent
signature |  | 0..* | Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5
Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std.
Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std.
Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding.​coding.system | Base | required | Example value set for provenance roles | 📦2.0.0 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 FiBaseProvenance

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Provenance.agent.role

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.0) | Who, What, When for a set of resources
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
who | Σ | 1..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who participated
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 FiBaseProvenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.0) | Who, What, When for a set of resources
agent |  |  |  |
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Binding: Example value set for provenance roles (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.role:kantaCoding.​coding.system | Base | required | Example value set for provenance roles | 📦2.0.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | FiBaseProvenance(2.0.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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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)
occurred[x] |  | 0..1 |  | When the activity occurred
occurredPeriod |  |  | Period |
occurredDateTime |  |  | dateTime |
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(FI Base Location(2.0.0)) | Where the activity occurred, if relevant
reason |  | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place.
activity |  | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place.
agent |  | 1..* | BackboneElement | Actor involved
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Slices for role |  | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by value:coding.system Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
role:kantaCoding |  | 1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system Binding: Example value set for provenance roles (required)
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | Σ | 1..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who participated
onBehalfOf |  | 0..1 | Reference(FI Base Practitioner(2.0.0) | FI Base PractitionerRole(2.0.0) | FI Base Patient(2.0.0) | RelatedPerson | Device | FI Base Organization(2.0.0)) | Who the agent is representing
entity |  | 0..* | BackboneElement | An entity used in this activity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity.
what | Σ | 1..1 | Reference(Resource) | Identity of entity
agent |  | 0..* | See agent (Provenance) | Entity is attributed to this agent
signature |  | 0..* | Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.5
Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std.
Provenance.agent.type | Base | extensible | Provenance participant type | 📍4.0.1 | FHIR Std.
Provenance.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
Provenance.agent.role:kantaCoding.​coding.system | Base | required | Example value set for provenance roles | 📦2.0.0 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 FiBaseProvenance

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Provenance.agent.role

Other representations of profile: CSV, Excel, Schematron