Mobile Cross-Enterprise Document Data Element Extraction (mXDE)
1.3.0 - Trial-Implementation International flag

This page is part of the Mobile Cross-Enterprise Document Data Element Extraction (mXDE) (v1.3.0: Publication) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: mXDE Provenance

Official URL: https://profiles.ihe.net/ITI/mXDE/StructureDefinition/IHE.ITI.mXDE.Provenance Version: 1.3.0
Active as of 2023-08-04 Computable Name: IHE_mXDE_Provenance

Provenance profile for use in mXDE when the data-elements (Resources pointed to by target) come from an XDS or MHD document. There will be one Provenance record for each document that has been decomposed by mXDE.

  • policy will be urn:ihe:iti:mxde:2023:document-provenance-policy to indicate mXDE produced provenance
  • target will point at ALL of the data found within the document
    • some target resources will be only found in the document
    • some target resources may have been found in other documents
  • activity will be Derivation to indicate the target resources were derived from documents
  • recorded will indicate when the document was decomposed into these target resources
  • agent will identify the software/service that implements the decomposition of the documents
    • this agent would be type assembler as it has assembled the FHIR Resources
    • this agent should describe the version of the software so as to understand data translation rules used
    • this agent may be a Resource or may be Contained depending on environment policy
  • other agent elements may be included
  • entity will point at the DocumentReference for the document from which the target data came

Usage:

Formal Views of Profile Content

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

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... modifierExtension 0..0
... target 1..*Reference(Resource)The FHIR Resource elements found in the Document
... policy 1..1uriPolicy or plan the activity was defined by
Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... activity 1..1CodeableConceptActivity that occurred
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/w3c-provenance-activity-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
... Slices for agent 1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... type 1..1CodeableConceptHow the agent participated
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: assembler
..... who 1..1Reference(Device) {c, r}Who participated
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... role 1..1codederivation | revision | quotation | source | removal
Required Pattern: source
.... what 1..1Reference(DocumentReference)Identity of entity
.... agent 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... target Σ1..*Reference(Resource)The FHIR Resource elements found in the Document
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 1..1uriPolicy or plan the activity was defined by

Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... activity 1..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


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/w3c-provenance-activity-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
... Slices for agent 1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... 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://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: assembler
..... who Σ1..1Reference(Device) {c, r}Who participated
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... 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.


Required Pattern: source
.... what Σ1..1Reference(DocumentReference)Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.activityextensiblePattern: Derivation
Provenance.agent:theAssembler.typeextensiblePattern: assembler
Provenance.entity.rolerequiredPattern: source
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... target Σ1..*Reference(Resource)The FHIR Resource elements found in the Document
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 1..1uriPolicy or plan the activity was defined by

Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... 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 1..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


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/w3c-provenance-activity-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... Slices for agent 1..*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 Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... 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 Σ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://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: assembler
....... 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 Σ1..1Reference(Device) {c, r}Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... 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
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DocumentReference)Identity of entity
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensiblePattern: Derivation
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:theAssembler.typeextensiblePattern: assembler
Provenance.agent:theAssembler.roleexampleSecurityRoleType
Provenance.entity.rolerequiredPattern: source

This structure is derived from Provenance

Summary

Mandatory: 5 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element Provenance.agent is sliced based on the value of pattern:type

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... modifierExtension 0..0
... target 1..*Reference(Resource)The FHIR Resource elements found in the Document
... policy 1..1uriPolicy or plan the activity was defined by
Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... activity 1..1CodeableConceptActivity that occurred
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/w3c-provenance-activity-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
... Slices for agent 1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... type 1..1CodeableConceptHow the agent participated
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: assembler
..... who 1..1Reference(Device) {c, r}Who participated
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... role 1..1codederivation | revision | quotation | source | removal
Required Pattern: source
.... what 1..1Reference(DocumentReference)Identity of entity
.... agent 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... target Σ1..*Reference(Resource)The FHIR Resource elements found in the Document
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 1..1uriPolicy or plan the activity was defined by

Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... activity 1..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


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/w3c-provenance-activity-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
... Slices for agent 1..*BackboneElementActor involved
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... 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://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: assembler
..... who Σ1..1Reference(Device) {c, r}Who participated
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... 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.


Required Pattern: source
.... what Σ1..1Reference(DocumentReference)Identity of entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.activityextensiblePattern: Derivation
Provenance.agent:theAssembler.typeextensiblePattern: assembler
Provenance.entity.rolerequiredPattern: source

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... target Σ1..*Reference(Resource)The FHIR Resource elements found in the Document
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 1..1uriPolicy or plan the activity was defined by

Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... 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 1..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.


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/w3c-provenance-activity-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: Derivation
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... Slices for agent 1..*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 Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

..... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
.... agent:theAssembler 1..1BackboneElementThe Assembler of the FHIR Resources
..... 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 Σ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://terminology.hl7.org/CodeSystem/provenance-participant-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: assembler
....... 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 Σ1..1Reference(Device) {c, r}Who participated
..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 1..1BackboneElementThe DocumentReference from which these resources came
.... 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
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


Required Pattern: source
.... what Σ1..1Reference(DocumentReference)Identity of entity
... signature 0..*SignatureSignature on target

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensiblePattern: Derivation
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.agent:theAssembler.typeextensiblePattern: assembler
Provenance.agent:theAssembler.roleexampleSecurityRoleType
Provenance.entity.rolerequiredPattern: source

This structure is derived from Provenance

Summary

Mandatory: 5 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element Provenance.agent is sliced based on the value of pattern:type

 

Other representations of profile: CSV, Excel, Schematron