Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Open by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
end		1..1	dateTime	End time with inclusive boundary, if not ongoing
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation
code		0..1	code	Symbol in syntax defined by the system Fixed Value: UPDATE
Slices for agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
type		1..1	CodeableConcept	How the agent participated
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: author
who
display		0..1	string	Text alternative for the resource
agent:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
type		1..1	CodeableConcept	How the agent participated
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
who
display		0..1	string	Text alternative for the resource
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity:All Slices				Content/Rules for all slices
what		1..1	Reference(Resource)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
identifier
value	S	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied.
display		0..1	string	Text alternative representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
entity:revision		1..1	BackboneElement	An entity used in this activity
role		1..1	code	derivation | revision | quotation | source | removal Fixed Value: revision
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Closed by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
end	ΣC	1..1	dateTime	End time with inclusive boundary, if not ongoing
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed Binding: PurposeOfUse (extensible): The reason the activity took place.
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology Binding: ProvenanceActivityType (extensible): The activity that took place.
Slices for agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
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.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: author
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
display	Σ	0..1	string	Text alternative for the resource
agent:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
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.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
display	Σ	0..1	string	Text alternative for the resource
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity:All Slices				Content/Rules for all slices
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)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
identifier	Σ	0..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 .
value	SΣ	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied. Example General: 123456
display	Σ	0..1	string	Text alternative representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
entity:revision		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: revision
what	Σ	1..1	Reference(Resource)	Identity of entity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent:author.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:custodian.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard
Provenance.entity.what.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Provenance.entity:revision.role	required	Fixed Value: revision http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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)
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Closed by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	1..1	dateTime	End time with inclusive boundary, if not ongoing
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(Location)	Where the activity occurred, if relevant
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed Binding: PurposeOfUse (extensible): The reason the activity took place.
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology Binding: ProvenanceActivityType (extensible): The activity that took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: UPDATE
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 agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
onBehalfOf		0..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who the agent is representing
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: author
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
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	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	Σ	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:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
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
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	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	Σ	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
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity: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
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)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
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	Σ	0..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	Σ	0..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.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied. 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 representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
entity:revision		1..1	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. Fixed Value: revision
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:author.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:author.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:author.who.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.agent:custodian.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:custodian.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:custodian.who.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard
Provenance.entity.what.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.entity.what.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Provenance.entity.what.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Provenance.entity:revision.role	required	Fixed Value: revision http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Summary

Mandatory: 17 elements
Must-Support: 1 element
Fixed: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Provenance.occurred[x]
• The element 1 is sliced based on the value of Provenance.agent (Open at End)
• The element 1 is sliced based on the value of Provenance.entity (Open at End)

Maturity: 0

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Open by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
end		1..1	dateTime	End time with inclusive boundary, if not ongoing
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation
code		0..1	code	Symbol in syntax defined by the system Fixed Value: UPDATE
Slices for agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
type		1..1	CodeableConcept	How the agent participated
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: author
who
display		0..1	string	Text alternative for the resource
agent:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
type		1..1	CodeableConcept	How the agent participated
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
who
display		0..1	string	Text alternative for the resource
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity:All Slices				Content/Rules for all slices
what		1..1	Reference(Resource)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
identifier
value	S	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied.
display		0..1	string	Text alternative representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
entity:revision		1..1	BackboneElement	An entity used in this activity
role		1..1	code	derivation | revision | quotation | source | removal Fixed Value: revision
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	1..*	Reference(Resource)	Target Reference(s) (usually version specific)
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Closed by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
end	ΣC	1..1	dateTime	End time with inclusive boundary, if not ongoing
recorded	Σ	1..1	instant	When the activity was recorded / updated
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed Binding: PurposeOfUse (extensible): The reason the activity took place.
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology Binding: ProvenanceActivityType (extensible): The activity that took place.
Slices for agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
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.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: author
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
display	Σ	0..1	string	Text alternative for the resource
agent:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
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.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
who	Σ	1..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
display	Σ	0..1	string	Text alternative for the resource
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity:All Slices				Content/Rules for all slices
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)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
identifier	Σ	0..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 .
value	SΣ	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied. Example General: 123456
display	Σ	0..1	string	Text alternative representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
entity:revision		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: revision
what	Σ	1..1	Reference(Resource)	Identity of entity
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent:author.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:custodian.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard
Provenance.entity.what.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Provenance.entity:revision.role	required	Fixed Value: revision http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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)
Slices for occurred[x]		1..1	Period	When the activity occurred Slice: Unordered, Closed by type:$this
occurred[x]:occurredPeriod		1..1	Period	Authoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	1..1	dateTime	End time with inclusive boundary, if not ongoing
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(Location)	Where the activity occurred, if relevant
reason		1..1	CodeableConcept	The reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed Binding: PurposeOfUse (extensible): The reason the activity took place.
activity		1..1	CodeableConcept	For a terminology change set, this should always be an update to a terminology Binding: ProvenanceActivityType (extensible): The activity that took place.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-DataOperation
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: UPDATE
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 agent		2..*	BackboneElement	Actor involved Slice: Unordered, Open At End by value:type.coding.code
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who participated
onBehalfOf		0..1	Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	Who the agent is representing
agent:author		1..*	BackboneElement	The individual(s) who contributed changes reflected in the Terminology Change Set
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: author
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
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	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	Σ	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:custodian		1..1	BackboneElement	The entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..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	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: custodian
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
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(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)	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	Σ	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
Slices for entity		1..*	BackboneElement	An entity used in this activity Slice: Unordered, Open At End by value:role
entity: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
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)	The baseline version of the CodeSystem to which this Change Set is intended to be applied.
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	Σ	0..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	Σ	0..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.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	Unique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied. 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 representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
agent		0..*	See agent (Provenance)	Entity is attributed to this agent
entity:revision		1..1	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. Fixed Value: revision
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.reason	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activity	extensible	ProvenanceActivityType http://hl7.org/fhir/ValueSet/provenance-activity-type from the FHIR Standard
Provenance.agent.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:author.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:author.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:author.who.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.agent:custodian.type	extensible	ProvenanceParticipantType http://hl7.org/fhir/ValueSet/provenance-agent-type from the FHIR Standard
Provenance.agent:custodian.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Provenance.agent:custodian.who.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard
Provenance.entity.what.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Provenance.entity.what.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Provenance.entity.what.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Provenance.entity:revision.role	required	Fixed Value: revision http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Provenance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Provenance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Provenance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Provenance	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Summary

Mandatory: 17 elements
Must-Support: 1 element
Fixed: 7 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Provenance.occurred[x]
• The element 1 is sliced based on the value of Provenance.agent (Open at End)
• The element 1 is sliced based on the value of Provenance.entity (Open at End)

Maturity: 0