Finnish Base Profiles
2.0.0-rc2 - ballot 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-rc2 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-rc2
Draft as of 2025-08-04 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:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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)
... 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-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) Who participated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCodingexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from FiBaseProvenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Provenance.agent.role:kantaCoding.coding.systemrequired
http://gen.kanta.fi/kanta-provenance-agent-role
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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
... 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-rc2)) 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-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) Who participated
.... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Provenance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
From the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
From the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCodingexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCoding.coding.systemrequired
http://gen.kanta.fi/kanta-provenance-agent-role
From this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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)
... 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-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) Who participated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCodingexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from FiBaseProvenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Provenance.agent.role:kantaCoding.coding.systemrequired
http://gen.kanta.fi/kanta-provenance-agent-role
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-rc2) 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
... 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-rc2)) 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-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) Who participated
.... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-rc2) | FI Base PractitionerRole(2.0.0-rc2) | FI Base Patient(2.0.0-rc2) | RelatedPerson | Device | FI Base Organization(2.0.0-rc2)) 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Provenance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
From the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
From the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCodingexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Provenance.agent.role:kantaCoding.coding.systemrequired
http://gen.kanta.fi/kanta-provenance-agent-role
From this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf 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-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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