Finnish Base Profiles
2.0.0-ci - ci-build
Finnish Base Profiles
2.0.0-ci - ci-build
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
| Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-information-custodian | Version: 2.0.0-ci | |||
| Draft as of 2025-03-27 | Computable Name: FiBaseInformationCustodian | |||
This is a Finnish abstract base profile for the Provenance resource, used to communicate the custodian of information (rekisterinpitäjä).
The Finnish national healthcare infrastructure uses the concept of the information custodian (rekisterinpitäjä), also known as the data controller or register keeper.
Most of the information in the Kanta system needs to be tagged with information of the information custodian and of the specific register.
For details, please refer to the Kanta CDA R2 Header specification, version 4.66 or later, chapters 2.2.17, 2.4.21, and 2.4.22.
These details are expressed with the Provenance resource conforming to this profile. Information
custodian is the .agent.
The working group was not able to reach consensus on how to present the details of the register
(the type of register, rekisterin tyyppi and the register specifier, rekisterin tarkenne). One
option is to use extensions to the information custodian .agent or even to the Provenance
resource instance (see
the ballot version
as one example). Another proposed approach is to
encode this information in .entity instances (see
version 1.0.0-rc21
for details). See also the
discussion thread
on chat.fhir.org and the GitHub issues
#88,
#135,
#141, and
#163.
Implementer feedback is appreciated on how to continue work on the topic.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance |
0..* | FiBaseProvenance | This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic 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 |
  Slices for agent |
1..* | BackboneElement | An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | |
   agent:All Slices |
Content/Rules for all slices | |||
  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 |
  agent:custodian |
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 |
  type |
Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |
| 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. ele-1: All FHIR elements must have a @value or children | |
| role:custodianRole |
1..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. ele-1: All FHIR elements must have a @value or children | |
 Slices for coding |
Σ | 1..* | Coding | A role with type urn:oid:1.2.246.537.5.40172 Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| coding:All Slices |
Content/Rules for all slices | |||
| system |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| coding:custodianRoleCoding |
Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
 system |
Σ | 1..1 | uri | Public or private occupational healthcare provider ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.2.246.537.5.40172 |
| 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 |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.agent:custodian.type | extensible | Pattern: CSThttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | |
| Provenance.agent:custodian.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Provenance.agent:custodian.role:custodianRole | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Provenance.agent:custodian.who.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Provenance.agent:custodian.who.identifier.type | extensible | Pattern: PRNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Finland. Package hl7.fhir.fi.base#2.0.0-ci based on FHIR 4.0.1. Generated 2025-03-27
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change
