Da Vinci Payer Data Exchange
2.1.1 - STU 2.1

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.1 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 ( Experimental )

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance | Version: 2.1.1
Standards status: Informative | 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.

Usages:

- Examples for this Profile: Provenance/1000001, Provenance/1000002, Provenance/1000003, Provenance/1000004... Show 5 more, Provenance/1000005, Provenance/1000006, Provenance/1000016, Provenance/1000017 and Provenance/1000101
- CapabilityStatements using this Profile: PDex Server CapabilityStatement with US core 6.1 support and PDEX Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.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) | The Resource this Provenance record supports
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
recorded | S Σ | 1..1 | instant | Timestamp when the activity was recorded / updated
Slices for agent | S C | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1
agent:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (required)
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
onBehalfOf | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | Who the agent is representing
agent:ProvenanceAuthor | S | 0..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | CodeableConcept | 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
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
agent:ProvenanceTransmitter | S | 0..* | BackboneElement | Actor involved
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. 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
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
entity |  | 0..* | BackboneElement | An entity used in this activity
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 |  | Extension Slice: Unordered, Open by value:url
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.agent:ProvenanceTransmitter.​type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std.
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCoreProvenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.0) | US Core Provenance
agent |  | 1..* | BackboneElement | Actor involved
type |  | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (required)
who |  | 1..1 | Reference(US Core Organization Profile(7.0.0) | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
Slices for agent |  |  |  | Content/Rules for all slices
agent:ProvenanceAuthor |  | 0..* | BackboneElement | Actor involved
type |  | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Agent Type (required)
who | S | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
agent:ProvenanceTransmitter |  | 0..* | BackboneElement | Actor involved
who | S | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
entity |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.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
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | 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 | 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 | 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 | S C | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1
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 | 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(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
onBehalfOf | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | Who the agent is representing
agent:ProvenanceAuthor | S | 0..* | 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: 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(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
onBehalfOf |  | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing
agent:ProvenanceTransmitter | S | 0..* | 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. 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(7.0.0) S | US Core Practitioner Profile(7.0.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
extension: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 |  | Extension Slice: Unordered, Open by value:url
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Provenance.target.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.3
Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std.
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent.role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.agent:ProvenanceAuthor.​role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceTransmitter.​type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceTransmitter.​role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCoreProvenance

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.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) | The Resource this Provenance record supports
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
recorded | S Σ | 1..1 | instant | Timestamp when the activity was recorded / updated
Slices for agent | S C | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1
agent:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (required)
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
onBehalfOf | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | Who the agent is representing
agent:ProvenanceAuthor | S | 0..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | CodeableConcept | 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
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
agent:ProvenanceTransmitter | S | 0..* | BackboneElement | Actor involved
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. 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
who | S Σ | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
entity |  | 0..* | BackboneElement | An entity used in this activity
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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 |  | Extension Slice: Unordered, Open by value:url
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.agent:ProvenanceTransmitter.​type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std.
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

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

Differential View

This structure is derived from USCoreProvenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.0) | US Core Provenance
agent |  | 1..* | BackboneElement | Actor involved
type |  | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (required)
who |  | 1..1 | Reference(US Core Organization Profile(7.0.0) | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
Slices for agent |  |  |  | Content/Rules for all slices
agent:ProvenanceAuthor |  | 0..* | BackboneElement | Actor involved
type |  | 1..1 | CodeableConcept | How the agent participated Binding: Provenance Agent Type (required)
who | S | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
agent:ProvenanceTransmitter |  | 0..* | BackboneElement | Actor involved
who | S | 1..1 | Reference(US Core Organization Profile(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
entity |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension: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)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | USCoreProvenance(7.0.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
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | 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 | 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 | 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 | S C | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type Constraints: provenance-1
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 | 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(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Provide US Core Organization. If no Organization provide US Core Practitioner
onBehalfOf | S | 0..1 | Reference(US Core Organization Profile(7.0.0)) | Who the agent is representing
agent:ProvenanceAuthor | S | 0..* | 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: 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(7.0.0) S | US Core Practitioner Profile(7.0.0)) | Who participated
onBehalfOf |  | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing
agent:ProvenanceTransmitter | S | 0..* | 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. 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(7.0.0) S | US Core Practitioner Profile(7.0.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
extension: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 |  | Extension Slice: Unordered, Open by value:url
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Provenance.target.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std.
Provenance.reason | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v6.3
Provenance.activity | Base | extensible | Provenance activity type | 📦4.0.1 | FHIR Std.
Provenance.agent.type | Base | required | US Core Provenance Participant Type Codes | 📦7.0.0 | US Core v7.0
Provenance.agent.role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceAuthor.​type | Base | required | Provenance Agent Type | 📦2.1.1 | This IG
Provenance.agent:ProvenanceAuthor.​role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceTransmitter.​type | Base | extensible | Provenance participant type | 📦4.0.1 | FHIR Std.
Provenance.agent:ProvenanceTransmitter.​role | Base | example | SecurityRoleType | 📦4.0.1 | FHIR Std.
Provenance.entity.extension:sourceFormat.​value[x] | Base | required | Payer source of data | 📦2.1.1 | This IG
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

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

This structure is derived from USCoreProvenance

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom

Other representations of profile: CSV, Excel, Schematron