US Core Implementation Guide
5.0.0 - STU5 Release United States of America flag

US Core Implementation Guide, published by HL7 International - Cross-Group Projects. This is not an authorized publication; it is the continuous build for version 5.0.0). This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Provenance Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance Version: 5.0.0
Active as of 2022-04-20 Computable Name: USCoreProvenance

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

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.

Example Usage Scenarios:

The following are example usage scenarios for the this profile:

  • Query for the Provenance records associated with an Allergy
  • Query for the Provenance records associated with a Problem

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e. data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Provenance must have:

  1. a reference to the resource(s) the Provenance record is supporting (target)
  2. a date and time for the activity

Each Provenance must support:

  1. the author organization responsible for the information
  2. the transmitter that provided the information
  3. the transmitter organization responsible for the transmission (if the transmitter is a device the transmitter organization must also be valued).

Profile specific implementation guidance:

  • The US Core Provenance resource SHALL be supported for these US Core
  • resources:

    • US Core CarePlan Profile
    • US Core DiagnosticReport Profile for Laboratory Results Reporting
    • US Core Encounter Profile
    • US Core Observation Sexual Orientation Profile
    • US Core Head Circumference Profile
    • US Core ServiceRequest Profile
    • US Core Vital Signs Profile
    • US Core DiagnosticReport Profile for Report and Note Exchange
    • US Core Implantable Device Profile
    • US Core Observation Imaging Result Profile
    • US Core CareTeam Profile
    • US Core Pulse Oximetry Profile
    • US Core BMI Profile
    • US Core Blood Pressure Profile
    • US Core Body Weight Profile
    • US Core RelatedPerson Profile
    • US Core Pediatric BMI for Age Observation Profile
    • US Core MedicationRequest Profile
    • US Core Condition Encounter Diagnosis Profile
    • US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
    • US Core Procedure Profile
    • US Core Laboratory Result Observation Profile
    • US Core Body Height Profile
    • US Core Observation SDOH Assessment Profile
    • US Core Observation Survey Profile
    • US Core Body Temperature Profile
    • US Core Condition Problems and Health Concerns Profile
    • US Core Pediatric Weight for Height Observation Profile
    • US Core Goal Profile
    • US Core AllergyIntolerance Profile
    • US Core Immunization Profile
    • US Core Observation Social History Profile
    • US Core Heart Rate Profile
    • US Core Smoking Status Observation Profile
    • US Core Patient Profile
    • US Core QuestionnaireResponse Profile
    • US Core Respiratory Rate Profile
    • US Core Observation Clinical Test Result Profile
    • US Core DocumentReference Profile
    • If a system receives a provider in Provenance.agent.who as free text they must capture who sent them the information as the organization. On request they SHALL provide this organization as the source and MAY include the free text provider.
    • Systems that need to know the activity has occurred SHOULD populate the activity.

    Usage:

    • This Resource Profile is not used by any profiles in this Implementation Guide

    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..*ProvenanceUS Core Provenance
    ... target S1..*Reference(Resource)The Resource this Provenance record supports
    .... reference S0..1stringLiteral reference, Relative, internal or absolute URL
    ... recorded S1..1instantTimestamp when the activity was recorded / updated
    ... Slices for agent SI1..*BackboneElementActor involved
    Slice: Unordered, Open by pattern:type
    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    .... agent:All Slices Content/Rules for all slices
    ..... type S0..1CodeableConceptHow the agent participated
    Binding: US Core Provenance Participant Type Codes (extensible)
    ..... who S1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device)Who participated
    ..... onBehalfOf S0..1Reference(US Core Organization Profile)Who the agent is representing
    .... agent:ProvenanceAuthor S0..*BackboneElementActor involved
    ..... type S1..1CodeableConceptHow the agent participated
    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: author
    .... agent:ProvenanceTransmitter S0..*BackboneElementActor involved
    ..... type S1..1CodeableConceptHow the agent participated
    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: transmitter

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Provenance 0..*ProvenanceUS Core Provenance
    ... id Σ0..1stringLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... language 0..1codeLanguage of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    ... text 0..1NarrativeText summary of the resource, for human interpretation
    ... contained 0..*ResourceContained, inline Resources
    ... extension 0..*ExtensionAdditional content defined by implementations
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... target SΣ1..*Reference(Resource)The Resource this Provenance record supports
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... reference SΣI0..1stringLiteral reference, Relative, internal or absolute URL
    .... type Σ0..1uriType the reference refers to (e.g. "Patient")
    Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

    .... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
    .... display Σ0..1stringText alternative for the resource
    ... occurred[x] 0..1When the activity occurred
    .... occurredPeriodPeriod
    .... occurredDateTimedateTime
    ... recorded SΣ1..1instantTimestamp when the activity was recorded / updated
    ... policy 0..*uriPolicy or plan the activity was defined by
    ... location 0..1Reference(Location)Where the activity occurred, if relevant
    ... reason 0..*CodeableConceptReason the activity is occurring
    Binding: PurposeOfUse (extensible): The reason the activity took place.


    ... activity 0..1CodeableConceptActivity that occurred
    Binding: ProvenanceActivityType (extensible): The activity that took place.

    ... Slices for agent SI1..*BackboneElementActor involved
    Slice: Unordered, Open by pattern:type
    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    .... agent:All Slices Content/Rules for all slices
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ0..1CodeableConceptHow the agent participated
    Binding: US Core Provenance Participant Type Codes (extensible)
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who SΣ1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device)Who participated
    ..... onBehalfOf S0..1Reference(US Core Organization Profile)Who the agent is representing
    .... agent:ProvenanceAuthor S0..*BackboneElementActor involved
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... id0..1stringUnique id for inter-element referencing
    ...... extension0..*ExtensionAdditional content defined by implementations
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... id0..1stringUnique id for inter-element referencing
    ....... extension0..*ExtensionAdditional content defined by implementations
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
    ....... version0..1stringVersion of the system - if relevant
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: author
    ....... display0..1stringRepresentation defined by the system
    ....... userSelected0..1booleanIf this coding was chosen directly by the user
    ...... text0..1stringPlain text representation of the concept
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
    ..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
    .... agent:ProvenanceTransmitter S0..*BackboneElementActor involved
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... id0..1stringUnique id for inter-element referencing
    ...... extension0..*ExtensionAdditional content defined by implementations
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... id0..1stringUnique id for inter-element referencing
    ....... extension0..*ExtensionAdditional content defined by implementations
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
    ....... version0..1stringVersion of the system - if relevant
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: transmitter
    ....... display0..1stringRepresentation defined by the system
    ....... userSelected0..1booleanIf this coding was chosen directly by the user
    ...... text0..1stringPlain text representation of the concept
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
    ..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
    ... entity 0..*BackboneElementAn entity used in this activity
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... role Σ1..1codederivation | revision | quotation | source | removal
    Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

    .... what Σ1..1Reference(Resource)Identity of entity
    .... agent 0..*See agent (Provenance)Entity is attributed to this agent
    ... signature 0..*SignatureSignature on target

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Provenance 0..*ProvenanceUS Core Provenance
    ... target Σ1..*Reference(Resource)The Resource this Provenance record supports
    .... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
    ... recorded Σ1..1instantTimestamp when the activity was recorded / updated
    ... Slices for agent I1..*BackboneElementActor involved
    Slice: Unordered, Open by pattern:type
    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    .... agent:All Slices Content/Rules for all slices
    ..... type Σ0..1CodeableConceptHow the agent participated
    Binding: US Core Provenance Participant Type Codes (extensible)
    ..... who Σ1..1Reference(US Core Practitioner Profile)Who participated
    ..... onBehalfOf 0..1Reference(US Core Organization Profile)Who the agent is representing
    .... agent:ProvenanceAuthor 0..*BackboneElementActor involved
    ..... type Σ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: author
    .... agent:ProvenanceTransmitter 0..*BackboneElementActor involved
    ..... type Σ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: transmitter

    doco Documentation for this format

    Differential View

    This structure is derived from Provenance

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Provenance 0..*ProvenanceUS Core Provenance
    ... target S1..*Reference(Resource)The Resource this Provenance record supports
    .... reference S0..1stringLiteral reference, Relative, internal or absolute URL
    ... recorded S1..1instantTimestamp when the activity was recorded / updated
    ... Slices for agent SI1..*BackboneElementActor involved
    Slice: Unordered, Open by pattern:type
    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    .... agent:All Slices Content/Rules for all slices
    ..... type S0..1CodeableConceptHow the agent participated
    Binding: US Core Provenance Participant Type Codes (extensible)
    ..... who S1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device)Who participated
    ..... onBehalfOf S0..1Reference(US Core Organization Profile)Who the agent is representing
    .... agent:ProvenanceAuthor S0..*BackboneElementActor involved
    ..... type S1..1CodeableConceptHow the agent participated
    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: author
    .... agent:ProvenanceTransmitter S0..*BackboneElementActor involved
    ..... type S1..1CodeableConceptHow the agent participated
    Required Pattern: At least the following
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: transmitter

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Provenance 0..*ProvenanceUS Core Provenance
    ... id Σ0..1stringLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... language 0..1codeLanguage of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    ... text 0..1NarrativeText summary of the resource, for human interpretation
    ... contained 0..*ResourceContained, inline Resources
    ... extension 0..*ExtensionAdditional content defined by implementations
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... target SΣ1..*Reference(Resource)The Resource this Provenance record supports
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... reference SΣI0..1stringLiteral reference, Relative, internal or absolute URL
    .... type Σ0..1uriType the reference refers to (e.g. "Patient")
    Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

    .... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
    .... display Σ0..1stringText alternative for the resource
    ... occurred[x] 0..1When the activity occurred
    .... occurredPeriodPeriod
    .... occurredDateTimedateTime
    ... recorded SΣ1..1instantTimestamp when the activity was recorded / updated
    ... policy 0..*uriPolicy or plan the activity was defined by
    ... location 0..1Reference(Location)Where the activity occurred, if relevant
    ... reason 0..*CodeableConceptReason the activity is occurring
    Binding: PurposeOfUse (extensible): The reason the activity took place.


    ... activity 0..1CodeableConceptActivity that occurred
    Binding: ProvenanceActivityType (extensible): The activity that took place.

    ... Slices for agent SI1..*BackboneElementActor involved
    Slice: Unordered, Open by pattern:type
    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    .... agent:All Slices Content/Rules for all slices
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ0..1CodeableConceptHow the agent participated
    Binding: US Core Provenance Participant Type Codes (extensible)
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who SΣ1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device)Who participated
    ..... onBehalfOf S0..1Reference(US Core Organization Profile)Who the agent is representing
    .... agent:ProvenanceAuthor S0..*BackboneElementActor involved
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... id0..1stringUnique id for inter-element referencing
    ...... extension0..*ExtensionAdditional content defined by implementations
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... id0..1stringUnique id for inter-element referencing
    ....... extension0..*ExtensionAdditional content defined by implementations
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
    ....... version0..1stringVersion of the system - if relevant
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: author
    ....... display0..1stringRepresentation defined by the system
    ....... userSelected0..1booleanIf this coding was chosen directly by the user
    ...... text0..1stringPlain text representation of the concept
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
    ..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
    .... agent:ProvenanceTransmitter S0..*BackboneElementActor involved
    ..... id 0..1stringUnique id for inter-element referencing
    ..... extension 0..*ExtensionAdditional content defined by implementations
    ..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    ..... type SΣ1..1CodeableConceptHow the agent participated
    Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


    Required Pattern: At least the following
    ...... id0..1stringUnique id for inter-element referencing
    ...... extension0..*ExtensionAdditional content defined by implementations
    ...... coding1..*CodingCode defined by a terminology system
    Fixed Value: (complex)
    ....... id0..1stringUnique id for inter-element referencing
    ....... extension0..*ExtensionAdditional content defined by implementations
    ....... system1..1uriIdentity of the terminology system
    Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
    ....... version0..1stringVersion of the system - if relevant
    ....... code1..1codeSymbol in syntax defined by the system
    Fixed Value: transmitter
    ....... display0..1stringRepresentation defined by the system
    ....... userSelected0..1booleanIf this coding was chosen directly by the user
    ...... text0..1stringPlain text representation of the concept
    ..... role 0..*CodeableConceptWhat the agents role was
    Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


    ..... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
    ..... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
    ... entity 0..*BackboneElementAn entity used in this activity
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... role Σ1..1codederivation | revision | quotation | source | removal
    Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

    .... what Σ1..1Reference(Resource)Identity of entity
    .... agent 0..*See agent (Provenance)Entity is attributed to this agent
    ... signature 0..*SignatureSignature on target

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSet / Code
    Provenance.languagepreferredCommonLanguages
    Max Binding: AllLanguages
    Provenance.target.typeextensibleResourceType
    Provenance.reasonextensiblePurposeOfUse
    Provenance.activityextensibleProvenanceActivityType
    Provenance.agent.typeextensibleUSCoreProvenancePaticipantTypeCodes
    Provenance.agent.roleexampleSecurityRoleType
    Provenance.agent:ProvenanceAuthor.typeextensiblePattern: author
    Provenance.agent:ProvenanceAuthor.roleexampleSecurityRoleType
    Provenance.agent:ProvenanceTransmitter.typeextensiblePattern: transmitter
    Provenance.agent:ProvenanceTransmitter.roleexampleSecurityRoleType
    Provenance.entity.rolerequiredProvenanceEntityRole

    Constraints

    IdGradePathDetailsRequirements
    provenance-1errorProvenance.agentonBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device
    : ((who.resolve() is Practitioner) or (who.resolve() is Device)) implies onBehalfOf.exists()

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • The syntax used to describe the interactions is described here.
    • See the General Requirements section for additional rules and expectations when a server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    Mandatory Search Parameters:

    The following search parameters, search parameter combinations SHALL be supported. Any listed search parameter modifiers, comparators, chains and composites SHALL also be supported UNLESS they are listed as “optional” in which case they SHOULD be supported:

    1. SHALL support searching for all US Core Profile resource types listed above for a patient and all the Provenance records for those resources using a combination of the patient and [_revinclude] search parameters:

      GET [base]/[Resource]?patient=[id]&_revinclude=Provenance:target

      Example:

      1. GET [base]/AllergyIntolerance?patient=[id]5&_revinclude=Provenance:target

      Implementation Notes: Fetches a bundle of all resources of a particular type for the specified patient (how to search by reference) and any corresponding Provenance resources.

    2. SHALL support searching for a particular instance of a US Core Profile resource type listed above and all its Provenance resources using combination of the _id and the [_revinclude] search parameters:

      GET [base]/[Resource]?_id=[id]&_revinclude=Provenance:target

      Example:

      1. GET [base]/AllergyIntolerance?_id=[id]&_revinclude=Provenance:target

      Implementation Notes: Fetches a bundle of a resource of a particular type (within the clients authorization scope) and any corresponding Provenance resources. (how to search by token)