Da Vinci Payer Data Exchange
1.0.0 - STU1
Da Vinci Payer Data Exchange
1.0.0 - STU1
This page is part of the Da Vinci Payer Data Exchange (v1.0.0: STU1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance |
| Version: | 1.0.0 |
| Name: | Provenance |
| Status: | Draft as of 2020-12-22T14:17:18+00:00 |
| Definition: | 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. |
| Publisher: | HL7 International |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProvenance
Summary
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance | 0..* | USCoreProvenance | US Core Provenance | |
  id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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) | The Resource this Provenance record supports |
  occurred[x] | 0..1 | When the activity occurred | ||
 occurredPeriod | Period | |||
 occurredDateTime | dateTime | |||
| recorded | SΣ | 1..1 | instant | Date/Time information was received by Payer |
| 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. | |
 agent | S | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type |
  agent:All Slices | Content/Rules for all slices | |||
  id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) |
| 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 | US Core Practitioner Profile) | Provide US Core Organization. If no Organization provide US Core Practitioner |
 onBehalfOf | SI | 0..1 | Reference(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 | 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://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 | US Core Practitioner Profile) | Who participated |
 onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
 agent:ProvenanceTransmitter | S | 0..1 | BackboneElement | Actor involved |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | US Core Practitioner Profile) | 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 | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ProvenanceSourceFrom | S | 0..1 | CodeableConcept | Entity 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..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 | (Slice Definition) | Source record format from which data was derived Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
| target | Σ | 1..* | Reference(Resource) | The Resource this Provenance record supports |
| recorded | Σ | 1..1 | instant | Date/Time information was received by Payer |
| agent | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type | |
| agent:All Slices | Content/Rules for all slices | |||
| type | Σ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) |
| who | Σ | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile) | Provide US Core Organization. If no Organization provide US Core Practitioner |
| onBehalfOf | I | 0..1 | Reference(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..* | BackboneElement | Actor involved | |
| type | Σ | 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 |
 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 | Σ | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile) | Who participated |
| agent:ProvenanceTransmitter | 0..1 | BackboneElement | Actor involved | |
| type | Σ | 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 |
| 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 | Σ | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile) | Who participated |
| entity | 0..* | BackboneElement | An entity used in this activity | |
| ProvenanceSourceFrom | 0..1 | CodeableConcept | Entity Source format that target resource was created from URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom Binding: Payer source of data (extensible) | |
| Documentation for this format | ||||
This structure is derived from USCoreProvenance
Summary
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreProvenance
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | USCoreProvenance | US Core Provenance | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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) | The Resource this Provenance record supports |
| occurred[x] | 0..1 | When the activity occurred | ||
| occurredPeriod | Period | |||
| occurredDateTime | dateTime | |||
| recorded | SΣ | 1..1 | instant | Date/Time information was received by Payer |
| 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. | |
| agent | S | 1..* | (Slice Definition) | Actor involved Slice: Unordered, Open by pattern:type |
| agent:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 0..1 | CodeableConcept | How the agent participated Binding: US Core Provenance Participant Type Codes (extensible) |
| 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 | US Core Practitioner Profile) | Provide US Core Organization. If no Organization provide US Core Practitioner |
| onBehalfOf | SI | 0..1 | Reference(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 | 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://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 | US Core Practitioner Profile) | Who participated |
| onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
| agent:ProvenanceTransmitter | S | 0..1 | BackboneElement | Actor involved |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | US Core Practitioner Profile) | 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 | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ProvenanceSourceFrom | S | 0..1 | CodeableConcept | Entity 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..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 | (Slice Definition) | Source record format from which data was derived Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension 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 | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet / Code |
| Provenance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Provenance.reason | extensible | PurposeOfUse |
| Provenance.activity | extensible | ProvenanceActivityType |
| Provenance.agent.type | extensible | USCoreProvenancePaticipantTypeCodes |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceAuthor.type | extensible | Pattern: author |
| Provenance.agent:ProvenanceAuthor.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern: transmitter |
| Provenance.agent:ProvenanceTransmitter.role | example | SecurityRoleType |
| Provenance.entity.extension:sourceFormat.value[x]:valueCodeableConcept | required | ProvenancePayerSourceFormat |
| Provenance.entity.role | required | ProvenanceEntityRole |
| Id | Path | Details | Requirements |
| provenance-1 | Provenance.agent.onBehalfOf | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device : ($this.agent.who.resolve().is Practitioner or Device) implies exists() |
IG © 2020+ . Package hl7.fhir.us.davinci-pdex#1.0.0 based on FHIR 4.0.1. Generated 2020-12-22
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change