Da Vinci Payer Data Exchange
2.1.0 - STU 2.1
Da Vinci Payer Data Exchange
2.1.0 - STU 2.1
This page is part of the Da Vinci Payer Data Exchange (v2.1.0: STU2.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance | Version: 2.1.0 | |||
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
SC | 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 | |||
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | |
| Provenance.agent:ProvenanceAuthor.type | required | Pattern Value: authorhttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | |
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern Value: transmitterhttp://hl7.org/fhir/ValueSet/provenance-agent-typeFrom the FHIR Standard | |
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Path | Conformance | ValueSet | URI |
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | |
| Provenance.agent:ProvenanceAuthor.type | required | ProvenanceAgentTypehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | |
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 |
SC | 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 | |||||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Provenance.target.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typeFrom the FHIR Standard | ||||
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceAuthor.type | required | Pattern Value: authorhttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | ||||
| Provenance.agent:ProvenanceAuthor.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern Value: transmitterhttp://hl7.org/fhir/ValueSet/provenance-agent-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceTransmitter.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
SC | 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 | |||
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | |
| Provenance.agent:ProvenanceAuthor.type | required | Pattern Value: authorhttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | |
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern Value: transmitterhttp://hl7.org/fhir/ValueSet/provenance-agent-typeFrom the FHIR Standard | |
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Path | Conformance | ValueSet | URI |
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | |
| Provenance.agent:ProvenanceAuthor.type | required | ProvenanceAgentTypehttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | |
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 |
SC | 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 | |||||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Provenance.target.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | extensible | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typeFrom the FHIR Standard | ||||
| Provenance.agent.type | required | USCoreProvenancePaticipantTypeCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceAuthor.type | required | Pattern Value: authorhttp://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentTypeFrom this IG | ||||
| Provenance.agent:ProvenanceAuthor.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern Value: transmitterhttp://hl7.org/fhir/ValueSet/provenance-agent-typeFrom the FHIR Standard | ||||
| Provenance.agent:ProvenanceTransmitter.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Provenance.entity.extension:sourceFormat.value[x] | required | ProvenancePayerSourceFormat(a valid code from Provenance Payer Data Source Format)http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormatFrom this IG | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.1.0 based on FHIR 4.0.1. Generated 2025-06-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change