Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Provenance

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-provenance-profile.html Version: 25.0.0
Active as of 2022-03-01 Computable Name: AthenaProvenance

Defines constraints and extensions on the Provenance resource as supported by Athena Products.

This Provenance profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

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.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Provenance resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Provenance resource gives information about who modified target resources and when they were modified. It is derived from the appropriate fields in many database tables in the athenaPractice and athenaFlow products. Multiple fields are used in the various scenarios that create, update, and sign data. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
ele-1: All FHIR elements must have a @value or children
..... profile:athena-provenance Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... target SΣ 1..1 Reference() Target Reference(s) (usually version specific)
ele-1: All FHIR elements must have a @value or children
... recorded SΣ 1..1 instant When the activity was recorded / updated
ele-1: All FHIR elements must have a @value or children
... location 1..1 Reference(Location) Where the activity occurred, if relevant
ele-1: All FHIR elements must have a @value or children
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


ele-1: All FHIR elements must have a @value or children
... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceAuthor 1..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: author
..... who SΣ 1..1 Reference(Practitioner) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceTransmitter 0..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: transmitter
..... who SΣ 1..1 Reference(Practitioner) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceVerifier 0..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: verifier
..... who SΣ 1..1 Reference(Organization) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
... entity 0..1 BackboneElement An entity used in this activity
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


ele-1: All FHIR elements must have a @value or children
Fixed Value: source
.... what Σ 1..1 Reference(Encounter) Identity of entity
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.rolerequiredFixed Value: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 1..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-provenance 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
... target S 1..1 Reference() Target Reference(s) (usually version specific)
... location 1..1 Reference(Location) Where the activity occurred, if relevant
... activity 0..1 CodeableConcept Activity that occurred
... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
.... agent:ProvenanceAuthor 1..1 BackboneElement Actor involved
..... type S 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 S 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceTransmitter 0..1 BackboneElement Actor involved
..... type S 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://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
..... who S 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceVerifier 0..1 BackboneElement Actor involved
..... type S 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: verifier
..... who S 1..1 Reference(Organization) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
... entity 0..1 BackboneElement An entity used in this activity
.... role 1..1 code derivation | revision | quotation | source | removal
Fixed Value: source
.... what 1..1 Reference(Encounter) Identity of entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 1..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 Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-provenance Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
.... 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
... 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 SΣ 1..1 Reference() Target Reference(s) (usually version specific)
... 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 1..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceAuthor 1..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 SΣ 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 SΣ 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceTransmitter 0..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 SΣ 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://hl7.org/fhir/us/core/CodeSystem/us-core-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: transmitter
....... 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 SΣ 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceVerifier 0..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 SΣ 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: verifier
....... 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 SΣ 1..1 Reference(Organization) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
... entity 0..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: source
.... what Σ 1..1 Reference(Encounter) 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

PathConformanceValueSet / CodeURI
Provenance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Provenance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Provenance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredFixed Value: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 11 elements(16 nested mandatory elements)
Must-Support: 12 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.meta.profile
  • The element 1 is sliced based on the value of Provenance.agent

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
ele-1: All FHIR elements must have a @value or children
..... profile:athena-provenance Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... target SΣ 1..1 Reference() Target Reference(s) (usually version specific)
ele-1: All FHIR elements must have a @value or children
... recorded SΣ 1..1 instant When the activity was recorded / updated
ele-1: All FHIR elements must have a @value or children
... location 1..1 Reference(Location) Where the activity occurred, if relevant
ele-1: All FHIR elements must have a @value or children
... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


ele-1: All FHIR elements must have a @value or children
... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceAuthor 1..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: author
..... who SΣ 1..1 Reference(Practitioner) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceTransmitter 0..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: transmitter
..... who SΣ 1..1 Reference(Practitioner) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
.... agent:ProvenanceVerifier 0..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
...... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: verifier
..... who SΣ 1..1 Reference(Organization) Who participated
ele-1: All FHIR elements must have a @value or children
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
ele-1: All FHIR elements must have a @value or children
... entity 0..1 BackboneElement An entity used in this activity
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


ele-1: All FHIR elements must have a @value or children
Fixed Value: source
.... what Σ 1..1 Reference(Encounter) Identity of entity
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.rolerequiredFixed Value: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 1..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-provenance 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
... target S 1..1 Reference() Target Reference(s) (usually version specific)
... location 1..1 Reference(Location) Where the activity occurred, if relevant
... activity 0..1 CodeableConcept Activity that occurred
... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
.... agent:ProvenanceAuthor 1..1 BackboneElement Actor involved
..... type S 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 S 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceTransmitter 0..1 BackboneElement Actor involved
..... type S 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://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: transmitter
..... who S 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceVerifier 0..1 BackboneElement Actor involved
..... type S 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: verifier
..... who S 1..1 Reference(Organization) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
... entity 0..1 BackboneElement An entity used in this activity
.... role 1..1 code derivation | revision | quotation | source | removal
Fixed Value: source
.... what 1..1 Reference(Encounter) Identity of entity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 1..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 Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-provenance Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile
..... profile:us-core-provenance Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
.... 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
... 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 SΣ 1..1 Reference() Target Reference(s) (usually version specific)
... 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 1..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... Slices for agent S 1..2 BackboneElement Actor involved
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceAuthor 1..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 SΣ 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 SΣ 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceTransmitter 0..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 SΣ 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://hl7.org/fhir/us/core/CodeSystem/us-core-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: transmitter
....... 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 SΣ 1..1 Reference(Practitioner) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
.... agent:ProvenanceVerifier 0..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 SΣ 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: verifier
....... 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 SΣ 1..1 Reference(Organization) Who participated
..... onBehalfOf S 0..1 Reference(Organization) Who the agent is representing
... entity 0..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: source
.... what Σ 1..1 Reference(Encounter) 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

PathConformanceValueSet / CodeURI
Provenance.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Provenance.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Provenance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:ProvenanceVerifier.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredFixed Value: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 11 elements(16 nested mandatory elements)
Must-Support: 12 elements
Fixed: 9 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.meta.profile
  • The element 1 is sliced based on the value of Provenance.agent

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Provenance resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Provenance?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Provenance resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
target (reference) Target Reference(s) (usually version specific)
patient (reference) Target Reference(s) (usually version specific)
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.