Athena Core Implementation Guide - Local Development build (v2.33.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: athenahealth Provenance

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. For example, a Provenance record could include the name of the organization, provider, or staff that created a FHIR Resource record and the timestamp of which it was created.

The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved. This information can be used to form assessments about its quality, reliability, trustworthiness, or to provide pointers for where to go to further investigate the origins of the resource and the information in it. While Provenance resources can be retrieved directly from athena’s systems by ID, it is generally unlikely for FHIR consumers to know the ID of a provenance resource ahead of time. Typically, Provenance resources are included in bundle reesponses using ‘_revinclude’ to search interactions for ‘other’ FHIR resources. As an example, to retrieve a patient’s Condition resources along with the Provenance resources for those conditions, the user would execute a search like ‘GET /Condition?patient={fhir patient id}&_revinclude=Provenance:target’

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
meta
lastUpdated		0..1	instant	When the resource version last changed
occurred[x]		0..0
policy		0..0
location		0..0
reason		0..0
activity		0..0
agent
role		0..0
who		1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
entity		0..0
signature		0..0
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)
recorded	Σ	1..1	instant	When the activity was recorded / updated
agent		1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

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
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	Σ	0..*	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. 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)
recorded	Σ	1..1	instant	When the activity was recorded / updated
agent		1..*	BackboneElement	Actor involved
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
who	Σ	1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Provenance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.agent.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

This structure is derived from Provenance

Summary

Prohibited: 8 elements

Differential View

This structure is derived from Provenance

Name	Flags	Card.	Type	Description & Constraints
Provenance		0..*	Provenance	Who, What, When for a set of resources
meta
lastUpdated		0..1	instant	When the resource version last changed
occurred[x]		0..0
policy		0..0
location		0..0
reason		0..0
activity		0..0
agent
role		0..0
who		1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
entity		0..0
signature		0..0
Documentation for this format

Key Elements View

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)
recorded	Σ	1..1	instant	When the activity was recorded / updated
agent		1..*	BackboneElement	Actor involved
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
who	Σ	1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.entity.role	required	ProvenanceEntityRole http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1 from the FHIR Standard

Snapshot View

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
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	Σ	0..*	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. 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)
recorded	Σ	1..1	instant	When the activity was recorded / updated
agent		1..*	BackboneElement	Actor involved
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	CodeableConcept	How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.
who	Σ	1..1	Reference(Practitioner | Organization)	Who participated
onBehalfOf		0..1	Reference(Organization)	Who the agent is representing
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Provenance.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Provenance.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Provenance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Provenance.agent.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

This structure is derived from Provenance

Summary

Prohibited: 8 elements

​Other representations of profile: CSV, Excel, Schematron