Tiro.health Implementation Guide
0.1.0 - ci-build

Tiro.health Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Form Provenance

Official URL: http://fhir.tiro.health/StructureDefinition/form-provenance Version: 0.1.0
Draft as of 2025-11-06 Computable Name: FormProvenance

Profile for tracking the origin and method of data entry for form fields to support audit trails and transparency

Track the origin and method of data entry for form fields to support audit trails and transparency

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..* Provenance Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... recorded SΣ 1..1 instant When the activity was recorded / updated
... activity S 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (example): The activity that took place.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity SΣ 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
..... coding:isoLifecycle SΣ 0..1 Coding ISO 21089 lifecycle event
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
... agent SΣC 1..* BackboneElement Actor involved
Constraints: prov-1, prov-2, prov-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... who SΣC 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf SC 0..1 Reference(Practitioner | Organization) The agent that delegated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base example ValueSet of sample of representative activity type codes. 📍5.0.0 FHIR Std.
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prov-1 error Provenance.agent Who and onBehalfOf cannot be the same who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()
prov-2 error Provenance.agent If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()
prov-3 error Provenance.agent If who is an organization, onBehalfOf can't be a PractitionerRole within that organization who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve()

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 1..* Reference(QuestionnaireResponse) Target Reference(s) (usually version specific)
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
... recorded S 1..1 instant When the activity was recorded / updated
... activity S 1..1 CodeableConcept Activity that occurred
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity S 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
..... coding:isoLifecycle S 0..1 Coding ISO 21089 lifecycle event
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
.... type S 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... who S 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf S 0..1 Reference(Practitioner | Organization) The agent that delegated

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 SΣ 1..* Reference(QuestionnaireResponse) Target Reference(s) (usually version specific)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... authorization 0..* CodeableReference() Authorization (purposeOfUse) related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
... activity S 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (example): The activity that took place.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity SΣ 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... id 0..1 id 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
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:isoLifecycle SΣ 0..1 Coding ISO 21089 lifecycle event
...... id 0..1 id 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
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 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
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient 0..1 Reference(Patient) The patient is the subject of the data created/updated (.target) by the activity
... encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
... agent SΣC 1..* BackboneElement Actor involved
Constraints: prov-1, prov-2, prov-3
.... 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 SΣ 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
.... who SΣC 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf SC 0..1 Reference(Practitioner | Organization) The agent that delegated
... 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 revision | quotation | source | instantiates | 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 required All Languages 📍5.0.0 FHIR Std.
Provenance.target.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Provenance.authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
Provenance.activity Base example ValueSet of sample of representative activity type codes. 📍5.0.0 FHIR Std.
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG
Provenance.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
Provenance.entity.role Base required Provenance Entity Role 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prov-1 error Provenance.agent Who and onBehalfOf cannot be the same who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()
prov-2 error Provenance.agent If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()
prov-3 error Provenance.agent If who is an organization, onBehalfOf can't be a PractitionerRole within that organization who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve()

This structure is derived from Provenance

Summary

Mandatory: 7 elements(1 nested mandatory element)
Must-Support: 11 elements

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.activity.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... recorded SΣ 1..1 instant When the activity was recorded / updated
... activity S 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (example): The activity that took place.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity SΣ 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
..... coding:isoLifecycle SΣ 0..1 Coding ISO 21089 lifecycle event
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
... agent SΣC 1..* BackboneElement Actor involved
Constraints: prov-1, prov-2, prov-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... who SΣC 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf SC 0..1 Reference(Practitioner | Organization) The agent that delegated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Provenance.activity Base example ValueSet of sample of representative activity type codes. 📍5.0.0 FHIR Std.
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prov-1 error Provenance.agent Who and onBehalfOf cannot be the same who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()
prov-2 error Provenance.agent If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()
prov-3 error Provenance.agent If who is an organization, onBehalfOf can't be a PractitionerRole within that organization who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve()

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... target S 1..* Reference(QuestionnaireResponse) Target Reference(s) (usually version specific)
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
... recorded S 1..1 instant When the activity was recorded / updated
... activity S 1..1 CodeableConcept Activity that occurred
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity S 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
..... coding:isoLifecycle S 0..1 Coding ISO 21089 lifecycle event
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
.... type S 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... who S 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf S 0..1 Reference(Practitioner | Organization) The agent that delegated

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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 SΣ 1..* Reference(QuestionnaireResponse) Target Reference(s) (usually version specific)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:targetElement S 1..1 uri Specific item.linkId within the QuestionnaireResponse
URL: http://hl7.org/fhir/StructureDefinition/targetElement
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... authorization 0..* CodeableReference() Authorization (purposeOfUse) related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
... activity S 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (example): The activity that took place.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:tiroActivity SΣ 1..1 Coding Activity that was performed on the form field
Binding: Form Activity ValueSet (required)
...... id 0..1 id 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
Required Pattern: http://fhir.tiro.health/CodeSystem/form-activity
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:isoLifecycle SΣ 0..1 Coding ISO 21089 lifecycle event
...... id 0..1 id 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
Required Pattern: http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle
...... version Σ 0..1 string Version of the system - if relevant
...... code ΣC 0..1 code Symbol in syntax defined by the system
...... display ΣC 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
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient 0..1 Reference(Patient) The patient is the subject of the data created/updated (.target) by the activity
... encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
... agent SΣC 1..* BackboneElement Actor involved
Constraints: prov-1, prov-2, prov-3
.... 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 SΣ 0..1 CodeableConcept Type of agent (for automated systems)
Binding: Agent Types ValueSet (extensible)
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.
.... who SΣC 1..1 Reference(Practitioner | Patient | Device) The agent that participated in the event
.... onBehalfOf SC 0..1 Reference(Practitioner | Organization) The agent that delegated
... 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 revision | quotation | source | instantiates | 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 required All Languages 📍5.0.0 FHIR Std.
Provenance.target.type Base extensible Resource Types 📍5.0.0 FHIR Std.
Provenance.authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
Provenance.activity Base example ValueSet of sample of representative activity type codes. 📍5.0.0 FHIR Std.
Provenance.activity.​coding:tiroActivity Base required Form Activity ValueSet 📦0.1.0 This IG
Provenance.agent.type Base extensible Agent Types ValueSet 📦0.1.0 This IG
Provenance.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
Provenance.entity.role Base required Provenance Entity Role 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prov-1 error Provenance.agent Who and onBehalfOf cannot be the same who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()
prov-2 error Provenance.agent If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()
prov-3 error Provenance.agent If who is an organization, onBehalfOf can't be a PractitionerRole within that organization who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve()

This structure is derived from Provenance

Summary

Mandatory: 7 elements(1 nested mandatory element)
Must-Support: 11 elements

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.activity.coding

 

Other representations of profile: CSV, Excel, Schematron