Da Vinci Payer Data Exchange
2.0.0-ballot - ballot US

This page is part of the Da Vinci Payer Data Exchange (v2.0.0-ballot: STU2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Provenance ( Experimental )

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance Version: 2.0.0-ballot
Draft as of 2022-02-18 Computable Name: Provenance

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.

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*USCoreProvenanceUS Core Provenance
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The Resource this Provenance record supports
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantTimestamp when the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


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

... Slices for agent S1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ0..1CodeableConceptHow the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf SI0..1Reference(US Core Organization Profile)Who the agent is representing
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:ProvenanceAuthor S0..*BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptHow the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: author
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
.... agent:ProvenanceTransmitter S0..1BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptHow 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: transmitter
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ProvenanceSourceFrom S0..1CodeableConceptEntity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
Binding: Payer source of data (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
..... Slices for value[x] 0..1CodeableConceptSource record format from which data was derived
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Payer source of data (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*USCoreProvenanceUS Core Provenance
... target Σ1..*Reference(Resource)The Resource this Provenance record supports
... recorded Σ1..1instantTimestamp when the activity was recorded / updated
... Slices for agent 1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... type Σ0..1CodeableConceptHow the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... who Σ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf I0..1Reference(US Core Organization Profile)Who the agent is representing
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:ProvenanceAuthor 0..*BackboneElementActor involved
..... type Σ1..1CodeableConceptHow the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: author
..... who Σ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
.... agent:ProvenanceTransmitter 0..1BackboneElementActor involved
..... type Σ1..1CodeableConceptHow 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: transmitter
..... who Σ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
.... ProvenanceSourceFrom 0..1CodeableConceptEntity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
Binding: Payer source of data (extensible)

doco Documentation for this format

Differential View

This structure is derived from USCoreProvenance

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*USCoreProvenanceUS Core Provenance
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The Resource this Provenance record supports
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantTimestamp when the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


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

... Slices for agent S1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ0..1CodeableConceptHow the agent participated
Binding: US Core Provenance Participant Type Codes (required)
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Provide US Core Organization. If no Organization provide US Core Practitioner
..... onBehalfOf SI0..1Reference(US Core Organization Profile)Who the agent is representing
provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
.... agent:ProvenanceAuthor S0..*BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptHow the agent participated
Binding: Provenance Agent Type (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: author
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
.... agent:ProvenanceTransmitter S0..1BackboneElementActor involved
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type SΣ1..1CodeableConceptHow 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: transmitter
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who SΣ1..1Reference(US Core Organization Profile | US Core Practitioner Profile)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ProvenanceSourceFrom S0..1CodeableConceptEntity Source format that target resource was created from
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
Binding: Payer source of data (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom"
..... Slices for value[x] 0..1CodeableConceptSource record format from which data was derived
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Payer source of data (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature 0..*SignatureSignature on target

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Max Binding: AllLanguages
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typerequiredUSCoreProvenancePaticipantTypeCodes
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:ProvenanceAuthor.typerequiredPattern: author
Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
Provenance.entity.extension:sourceFormat.value[x]:valueCodeableConceptrequiredProvenancePayerSourceFormat
Provenance.entity.rolerequiredProvenanceEntityRole

Constraints

IdGradePathDetailsRequirements
provenance-1errorProvenance.agent.onBehalfOfonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
: ($this.agent.who.resolve().is Practitioner or Device) implies exists()