Mobile Cross-Enterprise Document Data Element Extraction (mXDE)
1.3.1-current - ci-build International flag

Mobile Cross-Enterprise Document Data Element Extraction (mXDE), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.3.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.mXDE/ and changes regularly. 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.1-current
Active as of 2024-05-07 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..* Provenance Who, What, When for a set of resources
... modifierExtension 0..0
... target 1..* Reference(Resource) The FHIR Resource elements found in the Document
... policy 1..1 uri Policy or plan the activity was defined by
Required Pattern: urn:ihe:iti:mxde:2023:document-provenance-policy
... activity 1..1 CodeableConcept Activity that occurred
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/w3c-provenance-activity-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Derivation
... Slices for agent 1..* BackboneElement Actor involved
Slice: Unordered, Open by pattern:type
.... agent:theAssembler 1..1 BackboneElement The Assembler of the FHIR Resources
..... type 1..1 CodeableConcept How the agent participated
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: assembler
..... who 1..1 Reference(Device) {c, r} Who participated
... entity 1..1 BackboneElement The DocumentReference from which these resources came
.... role 1..1 code derivation | revision | quotation | source | removal
Required Pattern: source
.... what 1..1 Reference(DocumentReference) Identity of entity
.... agent 0..0

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

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


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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.activityextensiblePattern: Derivation
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent:theAssembler.typeextensiblePattern: assembler
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.rolerequiredPattern: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... target Σ 1..* Reference(Resource) The FHIR Resource elements found in the Document
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant When the activity was recorded / updated
... policy 1..1 uri Policy or plan the activity was defined by

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


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/w3c-provenance-activity-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Derivation
..... 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
... Slices for agent 1..* BackboneElement 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 Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

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


..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:theAssembler 1..1 BackboneElement The Assembler of the FHIR Resources
..... 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 Σ 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: assembler
....... 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 Σ 1..1 Reference(Device) {c, r} Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 1..1 BackboneElement The DocumentReference from which these resources came
.... 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
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensiblePattern: Derivation
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:theAssembler.typeextensiblePattern: assembler
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:theAssembler.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredPattern: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 5 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.agent

Differential View

This structure is derived from Provenance

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

doco Documentation for this format

Key Elements View

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

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


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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.activityextensiblePattern: Derivation
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent:theAssembler.typeextensiblePattern: assembler
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.entity.rolerequiredPattern: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... target Σ 1..* Reference(Resource) The FHIR Resource elements found in the Document
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant When the activity was recorded / updated
... policy 1..1 uri Policy or plan the activity was defined by

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


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/w3c-provenance-activity-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Derivation
..... 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
... Slices for agent 1..* BackboneElement 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 Σ 0..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

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


..... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
.... agent:theAssembler 1..1 BackboneElement The Assembler of the FHIR Resources
..... 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 Σ 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: assembler
....... 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 Σ 1..1 Reference(Device) {c, r} Who participated
..... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 1..1 BackboneElement The DocumentReference from which these resources came
.... 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
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensiblePattern: Derivation
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleProvenanceParticipantType
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.agent:theAssembler.typeextensiblePattern: assembler
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent:theAssembler.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredPattern: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

This structure is derived from Provenance

Summary

Mandatory: 5 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Provenance.agent

 

Other representations of profile: CSV, Excel, Schematron