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

Finnish Base Profiles - Local Development build (v2.0.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: FI Base InformationCustodian ( Abstract )

Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-information-custodian Version: 2.0.0-ci
Draft as of 2025-10-05 Computable Name: FiBaseInformationCustodian

This is a Finnish abstract base profile for the Provenance resource, used to communicate the custodian of information (rekisterinpitäjä).

Scope and Usage

How to communicate Kanta information custodian and register information

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).

Proposed alternatives are:

  1. ​use extensions either to the .agent field or to the root of the Provenance resource (see the proposal in the first ballot version and the example from Kanta)
  2. ​encode the information in .entity fields of Provenance instances (see examples for public healthcare and for private healthcare)
  3. include the register information in the .reason field of the Provenance resource (see example from CGI)

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.

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-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
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)
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... who Σ 1..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
.... agent:custodian 1..* BackboneElement Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
....... 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
..... 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:custodianRole 1..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
....... Slices for coding Σ 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... system Σ 1..1 uri Identity of the terminology system
........ coding:custodianRoleCoding Σ 1..* Coding Code defined by a terminology system
......... system Σ 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who Σ 1..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... 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.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent:custodian.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role:custodianRole Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.type Base extensible IdentifierType 📍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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:custodian 1..* BackboneElement Actor involved
..... type 1..1 CodeableConcept How the agent participated
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
...... role:custodianRole 1..* CodeableConcept What the agents role was
....... Slices for coding 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... system 1..1 uri Identity of the terminology system
........ coding:custodianRoleCoding 1..* Coding Code defined by a terminology system
......... system 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... type 1..1 CodeableConcept Description of identifier
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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
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-ci)) 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.
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... 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.
..... role 0..* 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-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
..... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who the agent is representing
.... agent:custodian 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 Σ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
....... 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
..... 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:custodianRole 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
....... Slices for coding Σ 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... 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 Σ 1..1 uri Identity of the terminology system
......... 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
........ coding:custodianRoleCoding Σ 1..* 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 Σ 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
......... 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-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... 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.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... 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
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 0..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) 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

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:custodian.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role:custodianRole Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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: 9 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
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)
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... who Σ 1..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
.... agent:custodian 1..* BackboneElement Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
....... 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
..... 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:custodianRole 1..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
....... Slices for coding Σ 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... system Σ 1..1 uri Identity of the terminology system
........ coding:custodianRoleCoding Σ 1..* Coding Code defined by a terminology system
......... system Σ 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who Σ 1..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... 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.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.agent:custodian.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role:custodianRole Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.type Base extensible IdentifierType 📍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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
Who, What, When for a set of resources
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:custodian 1..* BackboneElement Actor involved
..... type 1..1 CodeableConcept How the agent participated
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
...... role:custodianRole 1..* CodeableConcept What the agents role was
....... Slices for coding 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... system 1..1 uri Identity of the terminology system
........ coding:custodianRoleCoding 1..* Coding Code defined by a terminology system
......... system 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
..... who
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... type 1..1 CodeableConcept Description of identifier
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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* FiBaseProvenance(2.0.0-ci) This is an abstract profile. Child profiles: FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic, FiBaseInformationCustodianIndividual, FiBaseInformationCustodianPrivate, FiBaseInformationCustodianPublic
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-ci)) 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.
... Slices for agent 1..* BackboneElement An agent with type http://terminology.hl7.org/CodeSystem/v3-ParticipationType#CST
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... 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.
..... role 0..* 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-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
..... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who the agent is representing
.... agent:custodian 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 Σ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
....... 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
..... 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:custodianRole 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
....... Slices for coding Σ 1..* Coding A role with type urn:oid:1.2.246.537.5.40172
Slice: Unordered, Open by value:system
........ coding:All Slices Content/Rules for all slices
......... 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 Σ 1..1 uri Identity of the terminology system
......... 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
........ coding:custodianRoleCoding Σ 1..* 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 Σ 1..1 uri Public or private occupational healthcare provider
Required Pattern: urn:oid:1.2.246.537.5.40172
......... 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-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) Who participated
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... 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.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... 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
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 0..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... onBehalfOf 0..1 Reference(FI Base Practitioner(2.0.0-ci) | FI Base PractitionerRole(2.0.0-ci) | FI Base Patient(2.0.0-ci) | RelatedPerson | Device | FI Base Organization(2.0.0-ci)) 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

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:custodian.​type Base extensible Provenance participant type 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​role:custodianRole Base example SecurityRoleType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Provenance.agent:custodian.​who.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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: 9 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron