description: This profile sets minimum expectations for the Provenance resource to record, search, and fetch Provenance information associated with a record to promote interoperability and adoption through common implementation.  It identifies which core elements, extensions, vocabularies and value sets **SHALL** be present in the resource when using this profile.  This FHIR Provenance profile here covers the minimal (basic) information to support lineage of information.  It provides the floor for standards development for specific uses cases.  Prior to reviewing this profile, implementers are encouraged to read the Basic Provenance guidance page which documents several key use cases, specifically, what organization was responsible for the most recent action on the resource.
package_name: hl7.fhir.us.core
derivation: constraint
name: USCoreProvenance
type: Provenance
elements:
  target:
    short: The Resource this Provenance record supports
    mustSupport: true
    index: 0
    elements:
      reference: {mustSupport: true, index: 1}
  recorded: {short: Timestamp when the activity was recorded / updated, mustSupport: true, index: 2}
  agent:
    constraint:
      provenance-1: {human: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device, severity: error, expression: ((who.resolve() is Practitioner) or (who.resolve() is Device)) implies onBehalfOf.exists()}
    mustSupport: true
    index: 3
    elements:
      type:
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type'}
        mustSupport: true
        index: 4
      who:
        type: Reference
        mustSupport: true
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole', 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson']
        index: 5
      onBehalfOf:
        type: Reference
        mustSupport: true
        refers: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization']
        index: 6
    slicing:
      rules: open
      discriminator:
      - {path: type, type: pattern}
      min: null
      slices:
        ProvenanceAuthor:
          match:
            type:
              coding:
              - {code: author, system: 'http://terminology.hl7.org/CodeSystem/provenance-participant-type'}
          schema:
            mustSupport: true
            array: true
            index: 7
            elements:
              type:
                type: CodeableConcept
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: author, system: 'http://terminology.hl7.org/CodeSystem/provenance-participant-type'}
                index: 8
            required: [type]
        ProvenanceTransmitter:
          match:
            type:
              coding:
              - {code: transmitter, system: 'http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type'}
          schema:
            mustSupport: true
            index: 9
            elements:
              type:
                type: CodeableConcept
                mustSupport: true
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: transmitter, system: 'http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type'}
                index: 10
            required: [type]
package_version: 5.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
base: http://hl7.org/fhir/StructureDefinition/Provenance
version: 5.0.0