Da Vinci Payer Data Exchange
2.1.0 - STU2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: PDex Provenance

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance Version: 2.1.0
Standards status: Trial-use Computable Name: Provenance

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Provenance is provided by the payer to identify the source of the information, whether the data came via a clinical record or a claim record and whether the data was subject to manual transcription or other interpretive transformation. This profile adds PayerSourceFormat as an extension on the entity base element.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... agent 1..* BackboneElement (USCDI) Actor involved
.... type 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
.... who 1..1 Reference(US Core Organization Profile(6.1.0) | US Core Practitioner Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
... Slices for agent Content/Rules for all slices
.... agent:ProvenanceAuthor 0..* BackboneElement (USCDI) Actor involved
..... type 1..1 CodeableConcept (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
..... who S 1..1 Reference(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
... Slices for agent Content/Rules for all slices
.... agent:ProvenanceTransmitter 0..* BackboneElement (USCDI) Actor involved
..... who S 1..1 Reference(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Provenance.agent.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typerequiredProvenanceAgentType
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... who SΣ 1..1 Reference(US Core Organization Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf S 0..1 Reference(US Core Organization Profile(6.1.0)) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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(US Core Organization Profile(6.1.0)) Who participated
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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(US Core Organization Profile(6.1.0)) Who participated
... entity 0..* BackboneElement An entity used in this activity
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)
.... 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) Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typerequiredPattern: author
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... 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 SΣC 0..1 string (USCDI) 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
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant (USCDI) Timestamp 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 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 SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... 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 SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf S 0..1 Reference(US Core Organization Profile(6.1.0)) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) 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 (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) 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 (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)
.... 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) 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.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.target.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
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.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typerequiredPattern: author
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
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.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Differential View

This structure is derived from USCoreProvenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... agent 1..* BackboneElement (USCDI) Actor involved
.... type 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
.... who 1..1 Reference(US Core Organization Profile(6.1.0) | US Core Practitioner Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
... Slices for agent Content/Rules for all slices
.... agent:ProvenanceAuthor 0..* BackboneElement (USCDI) Actor involved
..... type 1..1 CodeableConcept (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
..... who S 1..1 Reference(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
... Slices for agent Content/Rules for all slices
.... agent:ProvenanceTransmitter 0..* BackboneElement (USCDI) Actor involved
..... who S 1..1 Reference(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Provenance.agent.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typerequiredProvenanceAgentType
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... reference SΣC 0..1 string (USCDI) Literal reference, Relative, internal or absolute URL
... Slices for agent SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... who SΣ 1..1 Reference(US Core Organization Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf S 0..1 Reference(US Core Organization Profile(6.1.0)) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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(US Core Organization Profile(6.1.0)) Who participated
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) Actor involved
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type SΣ 1..1 CodeableConcept (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... 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(US Core Organization Profile(6.1.0)) Who participated
... entity 0..* BackboneElement An entity used in this activity
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)
.... 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) Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent:ProvenanceAuthor.typerequiredPattern: author
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* USCoreProvenance(6.1.0) US Core Provenance
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) (USCDI) The Resource this Provenance record supports
.... 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 SΣC 0..1 string (USCDI) 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
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant (USCDI) Timestamp 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 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 SC 1..* BackboneElement (USCDI) Actor involved
Slice: Unordered, Open by pattern:type
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... 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 SΣ 0..1 CodeableConcept (USCDI) How the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf S 0..1 Reference(US Core Organization Profile(6.1.0)) (USCDI) Who the agent is representing
.... agent:ProvenanceAuthor S 0..* BackboneElement (USCDI) 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 (USCDI) How the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:ProvenanceTransmitter S 0..* BackboneElement (USCDI) 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 (USCDI) How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... 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(US Core Organization Profile(6.1.0) S | US Core Practitioner Profile(6.1.0)) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... sourceFormat S 0..1 (Complex) Entity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
...... value[x] 0..1 CodeableConcept Source record format from which data was derived
Binding: Payer source of data (required)
.... 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) 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.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.target.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
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.typerequiredUSCoreProvenancePaticipantTypeCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceAuthor.typerequiredPattern: author
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
from this IG
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
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.entity.extension:sourceFormat.value[x]requiredProvenancePayerSourceFormat (a valid code from Provenance Payer Data Source Format)
http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
from this IG
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron