ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: MitatointiProvenance
| Official URL: https://gen.kanta.fi/fhir/StructureDefinition/MitatointiProvenance | Version: 1.0.0 | |||
| Draft as of 2025-10-08 | Computable Name: MitatointiProvenance | |||
Provenance profile used in Kanta Services for invalidating a resource.
Provenance profile used in Kanta Services for invalidating a resource.
Usages:
- This Profile is not used by any profiles in this Specification
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
  meta |
0..1 | Meta | Metadata about the resource | |
   profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
 implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |
| reference |
C | 1..1 | string | Logical id of the main resource instance to be invalidated |
| display |
0..1 | string | Display name | |
| recorded |
1..1 | instant | Creation/recording time | |
| activity |
1..1 | CodeableConcept | Reason for invalidation Binding: ProvenanceActivityType (extensible): The activity that took place. | |
| coding |
0..1 | Coding | Reason for invalidation | |
| system |
1..1 | uri | Code system to be used | |
| code |
1..1 | code | Code value of the reason for invalidation | |
| display |
1..1 | string | Reason for invalidation | |
| text |
0..1 | string | Reason for invalidation | |
 Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  agent:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
  coding |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
 who |
1..1 | Reference(KantaPatient) {c} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
 agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| entity |
1..1 | BackboneElement | An entity used in this activity | |
| 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. Fixed Value: removal (no extensions allowed) | |
| what |
1..1 | Reference(Resource) | Identity of entity | |
| reference |
C | 1..1 | string | Logical id of the resource instance to be invalidated |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.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 Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Logical id of the main resource instance to be invalidated | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..1 | string | Display name | |
| occurred[x] |
0..0 | When the activity occurred | ||
| recorded |
1..1 | instant | Creation/recording time | |
| policy |
0..0 | Policy or plan the activity was defined by | ||
| location |
0..0 | Where the activity occurred, if relevant | ||
| reason |
0..0 | Reason the activity is occurring | ||
| activity |
1..1 | CodeableConcept | Reason for invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
0..1 | Coding | Reason for invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Code system to be used | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the reason for invalidation | |
| display |
1..1 | string | Reason for invalidation | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..1 | string | Reason for invalidation | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:All Slices |
Content/Rules for all slices | |||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPatient) {c} | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
 onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| entity |
1..1 | BackboneElement | An entity used in this activity | |
| id |
0..0 | Unique id for inter-element referencing | ||
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: removal (no extensions allowed) | |
| what |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Logical id of the resource instance to be invalidated | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Display name | ||
| agent |
0..0 | Entity is attributed to this agent | ||
| signature |
0..0 | Signature on target | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.agent.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| 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.
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Logical id of the main resource instance to be invalidated | ||||
| display |
0..1 | string | Display name | |||||
| recorded |
1..1 | instant | Creation/recording time | |||||
| activity |
1..1 | CodeableConcept | Reason for invalidation Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..1 | Coding | Reason for invalidation | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Code system to be used | |||||
| code |
1..1 | code | Code value of the reason for invalidation | |||||
| display |
1..1 | string | Reason for invalidation | |||||
| text |
0..1 | string | Reason for invalidation | |||||
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |||||
| 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 | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| who |
1..1 | Reference(KantaPatient) {c} | Who participated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| entity |
1..1 | BackboneElement | An entity used in this activity | |||||
| 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. Fixed Value: removal (no extensions allowed) | |||||
| what |
1..1 | Reference(Resource) | Identity of entity | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Logical id of the resource instance to be invalidated | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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 | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.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 Provenance
Summary
Mandatory: 20 elements(4 nested mandatory elements)
Fixed: 5 elements
Prohibited: 48 elements
Structures
This structure refers to these other structures:
- KantaPatient (https://gen.kanta.fi/fhir/StructureDefinition/KantaPatient)
- KantaPractitioner (https://gen.kanta.fi/fhir/StructureDefinition/KantaPractitioner)
- KantaDevice (https://gen.kanta.fi/fhir/StructureDefinition/KantaDevice)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Provenance.agent
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |
| reference |
C | 1..1 | string | Logical id of the main resource instance to be invalidated |
| display |
0..1 | string | Display name | |
| recorded |
1..1 | instant | Creation/recording time | |
| activity |
1..1 | CodeableConcept | Reason for invalidation Binding: ProvenanceActivityType (extensible): The activity that took place. | |
| coding |
0..1 | Coding | Reason for invalidation | |
| system |
1..1 | uri | Code system to be used | |
| code |
1..1 | code | Code value of the reason for invalidation | |
| display |
1..1 | string | Reason for invalidation | |
| text |
0..1 | string | Reason for invalidation | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaPatient) {c} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |
| reference |
C | 1..1 | string | Reference to the resource to be used |
| entity |
1..1 | BackboneElement | An entity used in this activity | |
| 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. Fixed Value: removal (no extensions allowed) | |
| what |
1..1 | Reference(Resource) | Identity of entity | |
| reference |
C | 1..1 | string | Logical id of the resource instance to be invalidated |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.activity | Base | extensible | Provenance activity type | 📍4.0.1 | FHIR Std. |
| Provenance.agent.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.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()
|
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |
| target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Logical id of the main resource instance to be invalidated | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..1 | string | Display name | |
| occurred[x] |
0..0 | When the activity occurred | ||
| recorded |
1..1 | instant | Creation/recording time | |
| policy |
0..0 | Policy or plan the activity was defined by | ||
| location |
0..0 | Where the activity occurred, if relevant | ||
| reason |
0..0 | Reason the activity is occurring | ||
| activity |
1..1 | CodeableConcept | Reason for invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
0..1 | Coding | Reason for invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Code system to be used | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the reason for invalidation | |
| display |
1..1 | string | Reason for invalidation | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..1 | string | Reason for invalidation | |
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| agent:All Slices |
Content/Rules for all slices | |||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPatient) {c} | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |
| id |
0..0 | Unique id for inter-element referencing | ||
| type |
0..0 | How the agent participated | ||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Reference to the resource to be used | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| onBehalfOf |
0..0 | Who the agent is representing | ||
| entity |
1..1 | BackboneElement | An entity used in this activity | |
| id |
0..0 | Unique id for inter-element referencing | ||
| role |
1..1 | code | derivation | revision | quotation | source | removal Fixed Value: removal (no extensions allowed) | |
| what |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| reference |
1..1 | string | Logical id of the resource instance to be invalidated | |
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Display name | ||
| agent |
0..0 | Entity is attributed to this agent | ||
| signature |
0..0 | Signature on target | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.agent.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| 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.
| |||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:status |
0..1 | Coding | Record status URL: https://gen.kanta.fi/fhir/StructureDefinition/extension/Status | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..1 | Reference(Resource) | Unique identifier of the resource to be invalidated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Logical id of the main resource instance to be invalidated | ||||
| display |
0..1 | string | Display name | |||||
| recorded |
1..1 | instant | Creation/recording time | |||||
| activity |
1..1 | CodeableConcept | Reason for invalidation Binding: ProvenanceActivityType (extensible): The activity that took place. | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..1 | Coding | Reason for invalidation | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Code system to be used | |||||
| code |
1..1 | code | Code value of the reason for invalidation | |||||
| display |
1..1 | string | Reason for invalidation | |||||
| text |
0..1 | string | Reason for invalidation | |||||
| Slices for agent |
1..* | BackboneElement | Actor involved Slice: Unordered, Open by value:role.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| who |
1..1 | Reference(KantaPatient | KantaPractitioner | KantaDevice) | Who participated | |||||
| 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 | ||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:Patient |
1..1 | BackboneElement | Customer or patient | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| who |
1..1 | Reference(KantaPatient) {c} | Who participated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| agent:Practitioner |
1..1 | BackboneElement | Person performing the invalidation | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| role |
1..1 | CodeableConcept | What the agents role was Binding: Value Set Kanta Provenance Role Category (required) | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://gen.kanta.fi/figen-cs-provenancerolecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| who |
1..1 | Reference(KantaPractitioner) {c} | Who participated | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| entity |
1..1 | BackboneElement | An entity used in this activity | |||||
| 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. Fixed Value: removal (no extensions allowed) | |||||
| what |
1..1 | Reference(Resource) | Identity of entity | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 1..1 | string | Logical id of the resource instance to be invalidated | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Provenance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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 | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Patient.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.0.0 | This IG |
| Provenance.agent:Practitioner.role | Base | required | Value Set Kanta Provenance Role Category | 📦1.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 Provenance
Summary
Mandatory: 20 elements(4 nested mandatory elements)
Fixed: 5 elements
Prohibited: 48 elements
Structures
This structure refers to these other structures:
- KantaPatient (https://gen.kanta.fi/fhir/StructureDefinition/KantaPatient)
- KantaPractitioner (https://gen.kanta.fi/fhir/StructureDefinition/KantaPractitioner)
- KantaDevice (https://gen.kanta.fi/fhir/StructureDefinition/KantaDevice)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Provenance.agent
Other representations of profile: CSV, Excel, Schematron