profile-Provenance
type: StructureDefinition
node role: treeRoot
id:
  v: profile-Provenance
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition profile-Provenance Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Provenance 0..* Provenance Who, What, When for a set of resources #xD; period #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:occurred 0..1 dateTime R4: occurred additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.occurred #xD; reason #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:reason 0..* CodeableConcept R4: reason additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.reason Binding: R4V3PurposeOfUseForR3 (0.1.0) (extensible): The reason the activity took place. #xD; activity #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:activity 0..1 CodeableConcept R4: activity additional types URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.activity Binding: R4ProvenanceActivityTypeForR3 (0.1.0) (extensible): The activity that took place. #xD; agent #xD; whoReference #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: who URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; onBehalfOfReference #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: onBehalfOf URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: fhir
extension:
  extension:
    url:
      v: packageId
      l: packageId
    value: Id
      v: hl7.fhir.uv.xver-r4.r3
  extension:
    url:
      v: version
      l: version
    value: String
      v: 0.1.0
  url:
    v: http://hl7.org/fhir/StructureDefinition/package-source
    l: package-source
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 0
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Uri
        v: http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3
        l: hl7.fhir.uv.xver-r4.r3
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Uri
        v: http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3
        l: hl7.fhir.uv.xver-r4.r3
url:
  v: http://hl7.org/fhir/4.0/StructureDefinition/profile-Provenance
  l: profile-Provenance
version:
  v: 0.1.0
name:
  v: Profile_R4_Provenance_R3
title:
  v: Cross-version Profile for R4.Provenance for use in FHIR STU3
status:
  v: active
experimental:
  v: false
date:
  v: 2026-03-17T16:03:29.8128917-05:00
publisher:
  v: FHIR Infrastructure
contact:
  name:
    v: FHIR Infrastructure
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
description:
  v: This cross-version profile allows R4 Provenance content to be represented via FHIR STU3 Provenance resources.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 3.0.2
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w3c.prov
  uri:
    v: http://www.w3.org/ns/prov
    l: prov
  name:
    v: W3C PROV
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/w5
    l: w5
  name:
    v: W5 Mapping
mapping:
  identity:
    v: fhirauditevent
  uri:
    v: http://hl7.org/fhir/auditevent
    l: auditevent
  name:
    v: FHIR AuditEvent
kind:
  v: resource
abstract:
  v: false
type:
  v: Provenance
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Provenance
  l: Provenance
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Provenance
    path:
      v: Provenance
    short:
      v: Who, What, When for a set of resources
    definition:
      v: Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
    comment:
      v: Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.
    alias:
      v: History
    alias:
      v: Event
    alias:
      v: Activity
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Provenance
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-1
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain any narrative
      expression:
        v: contained.text.empty()
      xpath:
        v: not(parent::f:contained and f:text)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()

v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))

key:
  v: dom-3
severity:
  v: error
human:
  v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
expression:
  v: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
xpath:
  v: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: rim
map:
  v: ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]

identity:
  v: w3c.prov
map:
  v: Activity

identity:
  v: w5
map:
  v: infrastructure.information

id:
  v: Provenance.id
path:
  v: Provenance.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: id
    l: id
is summary:
  v: true

id:
  v: Provenance.meta
path:
  v: Provenance.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
is summary:
  v: true

id:
  v: Provenance.implicitRules
path:
  v: Provenance.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is modifier:
  v: true
is summary:
  v: true

id:
  v: Provenance.language
path:
  v: Provenance.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Reference
      l: 3.0
      l: .2
      reference:
        v: http://hl7.org/fhir/ValueSet/all-languages|3.0.2
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: extensible
  description:
    v: A human language.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/languages|3.0.2

id:
  v: Provenance.text
path:
  v: Provenance.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
    l: Narrative
condition:
  v: dom-1
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Provenance.contained
path:
  v: Provenance.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Provenance.extension
path:
  v: Provenance.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Provenance.modifierExtension
path:
  v: Provenance.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Provenance.target
path:
  v: Provenance.target
short:
  v: Target Reference(s) (usually version specific)
definition:
  v: The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
comment:
  v: Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Provenance.target
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: ./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.entity.reference
mapping:
  identity:
    v: w3c.prov
  map:
    v: Entity Created/Updated
mapping:
  identity:
    v: w5
  map:
    v: what

id:
  v: Provenance.period
path:
  v: Provenance.period
short:
  v: When the activity occurred
definition:
  v: The period during which the activity occurred.
comment:
  v: The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Provenance.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
mapping:
  identity:
    v: rim
  map:
    v: ./effectiveTime[type=IVL_TS]
mapping:
  identity:
    v: w3c.prov
  map:
    v: Activity.startTime & Activity.endTime
mapping:
  identity:
    v: w5
  map:
    v: when.done

id:
  v: Provenance.period.id
path:
  v: Provenance.period.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.period.extension
path:
  v: Provenance.period.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Provenance.period.extension:occurred
path:
  v: Provenance.period.extension
slice name:
  v: occurred
short:
  v: R4: occurred additional types
definition:
  v: R4: `Provenance.occurred[x]` additional types (dateTime) additional types from child elements (value)
comment:
  v: Element `Provenance.occurred[x]` is mapped to FHIR STU3 element `Provenance.period` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.occurred[x]` do not cover the following types: dateTime. The mappings for `Provenance.occurred[x]` do not cover the following types based on type expansion: value. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.occurred|0.1.0
    l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.occurred

id:
  v: Provenance.period.start
path:
  v: Provenance.period.start
short:
  v: Starting time with inclusive boundary
definition:
  v: The start of the period. The boundary is inclusive.
comment:
  v: If the low element is missing, the meaning is that the low boundary is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Period.start
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
condition:
  v: per-1
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: DR.1
mapping:
  identity:
    v: rim
  map:
    v: ./low

id:
  v: Provenance.period.end
path:
  v: Provenance.period.end
short:
  v: End time with inclusive boundary, if not ongoing
definition:
  v: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
comment:
  v: The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Period.end
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
meaning when missing:
  v: If the end of the period is missing, it means that the period is ongoing
condition:
  v: per-1
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: DR.2
mapping:
  identity:
    v: rim
  map:
    v: ./high

id:
  v: Provenance.recorded
path:
  v: Provenance.recorded
short:
  v: When the activity was recorded / updated
definition:
  v: The instant of time at which the activity was recorded.
comment:
  v: This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Provenance.recorded
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: instant
    l: instant
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.recorded
mapping:
  identity:
    v: w3c.prov
  map:
    v: Activity.when
mapping:
  identity:
    v: w5
  map:
    v: when.recorded

id:
  v: Provenance.policy
path:
  v: Provenance.policy
short:
  v: Policy or plan the activity was defined by
definition:
  v: Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
comment:
  v: For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.policy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: uri
    l: uri
mapping:
  identity:
    v: rim
  map:
    v: ./inboundRelationship[isNormalActRelationship() and typeCode="SUBJ"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.agent.policy

id:
  v: Provenance.location
path:
  v: Provenance.location
short:
  v: Where the activity occurred, if relevant
definition:
  v: Where the activity occurred, if relevant.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Provenance.location
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: Location
mapping:
  identity:
    v: rim
  map:
    v: unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode="LOC" and determinerCode="INST"]
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.agent.location
mapping:
  identity:
    v: w3c.prov
  map:
    v: Activity.location
mapping:
  identity:
    v: w5
  map:
    v: where

id:
  v: Provenance.reason
path:
  v: Provenance.reason
short:
  v: Reason the activity is occurring
definition:
  v: The reason that the activity was taking place.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.reason
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ProvenanceReason
  strength:
    v: extensible
  description:
    v: The reason the activity took place.
  value set: Reference
    l: 2014
    l: -03
    l: -26
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-PurposeOfUse|2014-03-26
mapping:
  identity:
    v: rim
  map:
    v: unique(./reasonCode)
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.purposeOfEvent
mapping:
  identity:
    v: w3c.prov
  map:
    v: Activity.Activity
mapping:
  identity:
    v: w5
  map:
    v: why

id:
  v: Provenance.reason.id
path:
  v: Provenance.reason.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.reason.extension
path:
  v: Provenance.reason.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Provenance.reason.extension:reason
path:
  v: Provenance.reason.extension
slice name:
  v: reason
short:
  v: R4: reason additional types
definition:
  v: R4: `Provenance.reason` additional types (CodeableConcept) additional types from child elements (text)
comment:
  v: Element `Provenance.reason` is mapped to FHIR STU3 element `Provenance.reason` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.reason` do not cover the following types: CodeableConcept. The mappings for `Provenance.reason` do not cover the following types based on type expansion: text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.reason|0.1.0
    l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.reason

id:
  v: Provenance.reason.system
path:
  v: Provenance.reason.system
short:
  v: Identity of the terminology system
definition:
  v: The identification of the code system that defines the meaning of the symbol in the code.
comment:
  v: The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
requirements:
  v: Need to be unambiguous about the source of the definition of the symbol.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.3
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystem
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

id:
  v: Provenance.reason.version
path:
  v: Provenance.reason.version
short:
  v: Version of the system - if relevant
definition:
  v: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
comment:
  v: Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.version
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.7
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystemVersion
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

id:
  v: Provenance.reason.code
path:
  v: Provenance.reason.code
short:
  v: Symbol in syntax defined by the system
definition:
  v: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
requirements:
  v: Need to refer to a particular code in the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.1
mapping:
  identity:
    v: rim
  map:
    v: ./code
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

id:
  v: Provenance.reason.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Provenance.reason.display
short:
  v: Representation defined by the system
definition:
  v: A representation of the meaning of the code in the system, following the rules of the system.
requirements:
  v: Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.2 - but note this is not well followed
mapping:
  identity:
    v: rim
  map:
    v: CV.displayName
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

id:
  v: Provenance.reason.userSelected
path:
  v: Provenance.reason.userSelected
short:
  v: If this coding was chosen directly by the user
definition:
  v: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
comment:
  v: Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
requirements:
  v: This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.userSelected
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Sometimes implied by being first
mapping:
  identity:
    v: rim
  map:
    v: CD.codingRationale
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

id:
  v: Provenance.activity
path:
  v: Provenance.activity
short:
  v: Activity that occurred
definition:
  v: An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Provenance.activity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ProvenanceActivity
  strength:
    v: extensible
  description:
    v: The activity that took place.
  value set: Reference
    l: 1.1
    l: .0
    reference:
      v: http://hl7.org/fhir/ValueSet/provenance-activity-type|1.1.0
mapping:
  identity:
    v: rim
  map:
    v: Act.code
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.purposeOfEvent
mapping:
  identity:
    v: w3c.prov
  map:
    v: Activity.Activity
mapping:
  identity:
    v: w5
  map:
    v: why

id:
  v: Provenance.activity.id
path:
  v: Provenance.activity.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.activity.extension
path:
  v: Provenance.activity.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Provenance.activity.extension:activity
path:
  v: Provenance.activity.extension
slice name:
  v: activity
short:
  v: R4: activity additional types
definition:
  v: R4: `Provenance.activity` additional types (CodeableConcept) additional types from child elements (text)
comment:
  v: Element `Provenance.activity` is mapped to FHIR STU3 element `Provenance.activity` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.activity` do not cover the following types: CodeableConcept. The mappings for `Provenance.activity` do not cover the following types based on type expansion: text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.activity|0.1.0
    l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.activity

id:
  v: Provenance.activity.system
path:
  v: Provenance.activity.system
short:
  v: Identity of the terminology system
definition:
  v: The identification of the code system that defines the meaning of the symbol in the code.
comment:
  v: The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
requirements:
  v: Need to be unambiguous about the source of the definition of the symbol.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.3
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystem
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

id:
  v: Provenance.activity.version
path:
  v: Provenance.activity.version
short:
  v: Version of the system - if relevant
definition:
  v: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
comment:
  v: Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.version
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.7
mapping:
  identity:
    v: rim
  map:
    v: ./codeSystemVersion
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

id:
  v: Provenance.activity.code
path:
  v: Provenance.activity.code
short:
  v: Symbol in syntax defined by the system
definition:
  v: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
requirements:
  v: Need to refer to a particular code in the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.1
mapping:
  identity:
    v: rim
  map:
    v: ./code
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

id:
  v: Provenance.activity.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: Provenance.activity.display
short:
  v: Representation defined by the system
definition:
  v: A representation of the meaning of the code in the system, following the rules of the system.
requirements:
  v: Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: C*E.2 - but note this is not well followed
mapping:
  identity:
    v: rim
  map:
    v: CV.displayName
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

id:
  v: Provenance.activity.userSelected
path:
  v: Provenance.activity.userSelected
short:
  v: If this coding was chosen directly by the user
definition:
  v: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
comment:
  v: Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
requirements:
  v: This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Coding.userSelected
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Sometimes implied by being first
mapping:
  identity:
    v: rim
  map:
    v: CD.codingRationale
mapping:
  identity:
    v: orim
  map:
    v: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

id:
  v: Provenance.agent
path:
  v: Provenance.agent
short:
  v: Actor involved
definition:
  v: An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
comment:
  v: Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.
requirements:
  v: An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Provenance.agent
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: rim
  map:
    v: ./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.agent
mapping:
  identity:
    v: w3c.prov
  map:
    v: Agent
mapping:
  identity:
    v: w5
  map:
    v: who

id:
  v: Provenance.agent.id
path:
  v: Provenance.agent.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.agent.extension
path:
  v: Provenance.agent.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.agent.modifierExtension
path:
  v: Provenance.agent.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Provenance.agent.role
path:
  v: Provenance.agent.role
short:
  v: What the agents role was
definition:
  v: The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
comment:
  v: For example: author, performer, enterer, attester, doctor, nurse, clerk, etc.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.agent.role
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ProvenanceAgentRole
  strength:
    v: extensible
  description:
    v: The role that a provenance agent played with respect to the activity.
  value set: Reference
    l: 1.8
    l: .0
    reference:
      v: http://hl7.org/fhir/ValueSet/security-role-type|1.8.0
mapping:
  identity:
    v: rim
  map:
    v: .role and/or .typecode
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.agent.role
mapping:
  identity:
    v: w3c.prov
  map:
    v: Agent.Attribution

id:
  v: Provenance.agent.who[x]
path:
  v: Provenance.agent.who[x]
short:
  v: Who participated
definition:
  v: The individual, device or organization that participated in the event.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Provenance.agent.who[x]
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .id
mapping:
  identity:
    v: w5
  map:
    v: who.actor

id:
  v: Provenance.agent.who[x].id
path:
  v: Provenance.agent.who[x].id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.agent.who[x].extension
path:
  v: Provenance.agent.who[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Provenance.agent.who[x].extension:alternateReference
path:
  v: Provenance.agent.who[x].extension
slice name:
  v: alternateReference
short:
  v: R4: who
definition:
  v: R4: `Provenance.agent.who`
comment:
  v: Element `Provenance.agent.who` is mapped to FHIR STU3 element `Provenance.agent.who[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Provenance.agent.who` with unmapped reference targets: PractitionerRole. Source element `Provenance.agent.who` has unmapped reference types. While the target element `Provenance.agent.who[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. whoIdentity should be used when the agent is not a Resource type.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Provenance.agent.onBehalfOf[x]
path:
  v: Provenance.agent.onBehalfOf[x]
short:
  v: Who the agent is representing
definition:
  v: The individual, device, or organization for whom the change was made.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Provenance.agent.onBehalfOf[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
mapping:
  identity:
    v: rim
  map:
    v: Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]

id:
  v: Provenance.agent.onBehalfOf[x].id
path:
  v: Provenance.agent.onBehalfOf[x].id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.agent.onBehalfOf[x].extension
path:
  v: Provenance.agent.onBehalfOf[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension

id:
  v: Provenance.agent.onBehalfOf[x].extension:alternateReference
path:
  v: Provenance.agent.onBehalfOf[x].extension
slice name:
  v: alternateReference
short:
  v: R4: onBehalfOf
definition:
  v: R4: `Provenance.agent.onBehalfOf`
comment:
  v: Element `Provenance.agent.onBehalfOf` is mapped to FHIR STU3 element `Provenance.agent.onBehalfOf[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Provenance.agent.onBehalfOf` with unmapped reference targets: PractitionerRole. Source element `Provenance.agent.onBehalfOf` has unmapped reference types. While the target element `Provenance.agent.onBehalfOf[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. onBehalfOfIdentity should be used when the agent is not a Resource type.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference

id:
  v: Provenance.agent.relatedAgentType
path:
  v: Provenance.agent.relatedAgentType
short:
  v: Type of relationship between agents
definition:
  v: The type of relationship between agents.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Provenance.agent.relatedAgentType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RelatedAgentType
  strength:
    v: example
  description:
    v: Type of relationship between two provenance agents.
  value set: Reference
    l: 2016
    l: -11
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-RoleLinkType|2016-11-11
mapping:
  identity:
    v: rim
  map:
    v: .typeCode
mapping:
  identity:
    v: w3c.prov
  map:
    v: type

id:
  v: Provenance.entity
path:
  v: Provenance.entity
short:
  v: An entity used in this activity
definition:
  v: An entity used in this activity.
comment:
  v: Multiple userIds may be associated with the same Practitioner or other individual across various appearances, each with distinct privileges.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.entity
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: rim
  map:
    v: ./subjectOf
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.entity
mapping:
  identity:
    v: w3c.prov
  map:
    v: Entity

id:
  v: Provenance.entity.id
path:
  v: Provenance.entity.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
definition:
  v: unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.entity.extension
path:
  v: Provenance.entity.extension
short:
  v: Additional Content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Provenance.entity.modifierExtension
path:
  v: Provenance.entity.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Provenance.entity.role
path:
  v: Provenance.entity.role
short:
  v: derivation | revision | quotation | source | removal
definition:
  v: How the entity was used during the activity.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Provenance.entity.role
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ProvenanceEntityRole
  strength:
    v: required
  description:
    v: How an entity was used in an activity.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/provenance-entity-role|3.0.2
mapping:
  identity:
    v: rim
  map:
    v: ./typeCode
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.entity.lifecycle
mapping:
  identity:
    v: w3c.prov
  map:
    v: Entity.role

id:
  v: Provenance.entity.what[x]
path:
  v: Provenance.entity.what[x]
short:
  v: Identity of entity
definition:
  v: Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
comment:
  v: Identity may be a reference to a resource or to something else, depending on the type.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Provenance.entity.what[x]
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: ./text/reference
mapping:
  identity:
    v: fhirauditevent
  map:
    v: AuditEvent.entity.reference
mapping:
  identity:
    v: w3c.prov
  map:
    v: Entity.Identity

id:
  v: Provenance.entity.agent
path:
  v: Provenance.entity.agent
short:
  v: Entity is attributed to this agent
definition:
  v: The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
comment:
  v: A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.entity.agent
  min:
    v: 0
  max:
    v: *
content reference:
  v: http://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent
  l: Provenance.agent
mapping:
  identity:
    v: rim
  map:
    v: ./author/role

id:
  v: Provenance.signature
path:
  v: Provenance.signature
short:
  v: Signature on target
definition:
  v: A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Provenance.signature
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Signature
    l: Signature
mapping:
  identity:
    v: rim
  map:
    v: ./signatureText

element:
  id:
    v: Provenance
  path:
    v: Provenance
element:
  id:
    v: Provenance.period.extension
  path:
    v: Provenance.period.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: Provenance.period.extension:occurred
  path:
    v: Provenance.period.extension
  slice name:
    v: occurred
  short:
    v: R4: occurred additional types
  definition:
    v: R4: `Provenance.occurred[x]` additional types (dateTime) additional types from child elements (value)
  comment:
    v: Element `Provenance.occurred[x]` is mapped to FHIR STU3 element `Provenance.period` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.occurred[x]` do not cover the following types: dateTime. The mappings for `Provenance.occurred[x]` do not cover the following types based on type expansion: value. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
  min:
    v: 0
  max:
    v: 1
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.occurred|0.1.0
      l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.occurred
element:
  id:
    v: Provenance.reason.extension
  path:
    v: Provenance.reason.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: Provenance.reason.extension:reason
  path:
    v: Provenance.reason.extension
  slice name:
    v: reason
  short:
    v: R4: reason additional types
  definition:
    v: R4: `Provenance.reason` additional types (CodeableConcept) additional types from child elements (text)
  comment:
    v: Element `Provenance.reason` is mapped to FHIR STU3 element `Provenance.reason` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.reason` do not cover the following types: CodeableConcept. The mappings for `Provenance.reason` do not cover the following types based on type expansion: text.
  min:
    v: 0
  max:
    v: *
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.reason|0.1.0
      l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.reason
element:
  id:
    v: Provenance.activity.extension
  path:
    v: Provenance.activity.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: Provenance.activity.extension:activity
  path:
    v: Provenance.activity.extension
  slice name:
    v: activity
  short:
    v: R4: activity additional types
  definition:
    v: R4: `Provenance.activity` additional types (CodeableConcept) additional types from child elements (text)
  comment:
    v: Element `Provenance.activity` is mapped to FHIR STU3 element `Provenance.activity` as `SourceIsBroaderThanTarget`. The mappings for `Provenance.activity` do not cover the following types: CodeableConcept. The mappings for `Provenance.activity` do not cover the following types based on type expansion: text.
  min:
    v: 0
  max:
    v: 1
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.activity|0.1.0
      l: http://hl7.org/fhir/4.0/StructureDefinition/extension-Provenance.activity
element:
  id:
    v: Provenance.agent.whoReference.extension
  path:
    v: Provenance.agent.whoReference.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: Provenance.agent.whoReference.extension:alternateReference
  path:
    v: Provenance.agent.whoReference.extension
  slice name:
    v: alternateReference
  short:
    v: R4: who
  definition:
    v: R4: `Provenance.agent.who`
  comment:
    v: Element `Provenance.agent.who` is mapped to FHIR STU3 element `Provenance.agent.who[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Provenance.agent.who` with unmapped reference targets: PractitionerRole. Source element `Provenance.agent.who` has unmapped reference types. While the target element `Provenance.agent.who[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. whoIdentity should be used when the agent is not a Resource type.
  base:
    path:
      v: DomainResource.extension
    min:
      v: 0
    max:
      v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/alternate-reference
      l: alternate-reference

id:
  v: Provenance.agent.onBehalfOfReference.extension
path:
  v: Provenance.agent.onBehalfOfReference.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
min:
  v: 0
max:
  v: *

id:
  v: Provenance.agent.onBehalfOfReference.extension:alternateReference
path:
  v: Provenance.agent.onBehalfOfReference.extension
slice name:
  v: alternateReference
short:
  v: R4: onBehalfOf
definition:
  v: R4: `Provenance.agent.onBehalfOf`
comment:
  v: Element `Provenance.agent.onBehalfOf` is mapped to FHIR STU3 element `Provenance.agent.onBehalfOf[x]` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Provenance.agent.onBehalfOf` with unmapped reference targets: PractitionerRole. Source element `Provenance.agent.onBehalfOf` has unmapped reference types. While the target element `Provenance.agent.onBehalfOf[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it. onBehalfOfIdentity should be used when the agent is not a Resource type.
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/alternate-reference
    l: alternate-reference