UCSDI5 Sandbox - Local Development build (v0.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Page standards status: Informative |
The FHIR Provenance Resource tracks information about the activity about a version of a resource, describing the entities and agents involved. FHIR resources also contain elements that represent "small-p provenance" information about how the resource was obtained which overlap with the functionality of the Provenance resource.
This page is divided into two section documenting how the US Core Provenance Profile records changes at the organizational level, and how the US Core Profiles' "small-p provenance" elements record changes at the individual level. The US Core Provenance Profile asserts where the data came from at an organizational or system level. Because systems typically do not use the Provenance Resource to represent this information at an individual level (in other words, activities by the patient or provider), various FHIR resource elements are identified that track the "small p provenance" information at the individual level. The baseline rules and guidance here do not preclude more advanced use cases such as Using Provenance To Target Resource Elements.
The US Core Provenance Profile focuses on a key subset of elements, the "last hop", and specific use cases used to assert changes to the record at the organizational level. Full Provenance of a Resource requires details from the original resource creator and all intermediary actors that updated the Resource. Members of the Argonaut community and the HL7 security working group discussed the current sharing approaches and end-user display. They agreed the most important information is the last organization making a meaningful clinical update to the data and the prior system providing it - the 'last hop'. Participants didn't dispute the potential need to recreate the entire chain but didn't see this as relevant to the immediate end-user.
The guidance for Provenance in US Core focuses on six key elements: Timestamp, the Target Resource, Author, Author Organization, Transmitter, and Transmitter Organization. The Timestamp is the date and time the author created, updated, or deleted the data. The Target Resource is the Resource the Provenance record supports. The Author represents the person(s) responsible for the information. The Author Organization defines the organization the author is associated with when they created, updated, or deleted the data. The Transmitter represents the system responsible for transmitting the information. Finally, the Transmitter Organization defines the organization responsible for the transmission.
Key Provenance elements:
Element | Required | Must Support | Optional | FHIR Element |
---|---|---|---|---|
Target | Resource Provenance record supports |
Provenance.target |
||
Timestamp | Date | Time with timezone offset | Provenance.recorded |
|
Author | Name Identifier |
NPI recommended, additional identifiers allowed | Provenance.agent.who |
|
Author Organization | Name Identifier |
NPI recommended, additional identifiers allowed | Provenance.agent.onBehalfOf |
|
Transmitter | Name Identifier |
NPI recommended, additional identifiers allowed | Provenance.agent.who |
|
Transmitter Organization | Name Identifier |
NPI recommended, additional identifiers allowed | Provenance.agent.onBehalfOf |
The HL7 Basic Provenance Informative implementation guide outlines four use cases: Fax, Health Information Exchange (HIE) redistribution, HIE transformation, and Clinical Information Reconciliation and Incorporation (CIRI). While these use cases may have FHIR implications in the future, CIRI and HIE are the key use cases and are covered in detail here.
(source excel file is here: https://1drv.ms/x/c/deea5e002be8d274/EazOGawVCEBBjJmfJXcI5DQBKbAXNqHGcHr4ioRM6s2m0g)
US Core Profiles contain elements that represent "small-p provenance" information about how the resource was obtained, which overlaps with the functionality of the Provenance resource discussed above. The table below identifies the author and author roles that meet the U.S. Core Data for Interoperability (USCDI) Provenance Author and Author Role Data Elements requirements for individuals. In addition, they are listed in each US Core Profile page's "Profile Specific Implementation Guidance" section. The author is communicated by the elements and the author's role by the target resource type referenced by it (for example, Patient, Practitioner/PractitionerRole, RelatedPerson, Device). Details about the author's role are contained in the target resource's contents. The bold font indicates the elements and target resources that are labeled as Must Support in the respective US Core Profiles. Elements and target resources not labeled as Must Support SHOULD be supported in the profiles when the system captures the data.
This table excludes these US Core Profiles, which are not typically associated with individual authorship:
Red text indicates proposed new Must Support elements and targets
This information is also available as a csv or excel file:
US Core Profile | Surveyed? | Data Element Corresponding to Author Provenance | Target Resource Types Corresponding to Author Role Provenance |
---|---|---|---|
US Core AllergyIntolerance Profile | AllergyIntolerance.asserter |
Practitioner, PractitionerRole, Patient, RelatedPerson | |
US Core CarePlan Profile | CarePlan.contributor |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam, Device, DeviceMetric | |
US Core Condition Encounter Diagnosis Profile | ✓ | Condition.asserter |
Practitioner, PractitionerRole, Patient, RelatedPerson |
US Core Condition Problems and Health Concerns Profile | ✓ | Condition.asserter |
Practitioner, PractitionerRole, Patient, RelatedPerson |
US Core DiagnosticReport Profile for Laboratory Results Reporting | DiagnosticReport.performer* |
Practitioner**, Organization, PractitionerRole, CareTeam | |
US Core DiagnosticReport Profile for Laboratory Results Reporting | DiagnosticReport.resultsInterpreter |
Practitioner, Organization, PractitionerRole, CareTeam | |
US Core DiagnosticReport Profile for Report and Note Exchange | DiagnosticReport.performer* |
Practitioner**, Organization, PractitionerRole, CareTeam | |
US Core DiagnosticReport Profile for Report and Note Exchange | DiagnosticReport.resultsInterpreter |
Practitioner, Organization, PractitionerRole, CareTeam | |
US Core ADI DocumentReference Profile | DocumentReference.author* |
Practitioner**, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam, Device, DeviceMetric | |
US Core DocumentReference Profile | DocumentReference.author* |
Practitioner**, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam, Device, DeviceMetric | |
US Core Goal Profile | Goal.expressedBy |
Practitioner, PractitionerRole, Patient, RelatedPerson | |
US Core Immunization Profile | Immunization.reportOrigin |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam, Device, DeviceMetric | |
US Core Immunization Profile | Immunization.performer.actor |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam, Device, DeviceMetric | |
US Core MedicationDispense Profile | MedicationDispense.performer.actor* |
Practitioner**, Organization**, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric | |
US Core MedicationRequest Profile | ✓ | MedicationRequest.requester* |
Practitioner**, Organization**, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric |
US Core MedicationRequest Profile | ✓ | MedicationRequest.reportedReference* |
Practitioner**, Organization**, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric |
US Core Average Blood Pressure Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Average Blood Pressure Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Blood Pressure Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Blood Pressure Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core BMI Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core BMI Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Body Height Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Body Height Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Body Temperature Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Body Temperature Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Body Weight Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Body Weight Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Care Experience Preference Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Care Experience Preference Profile | Observation.device |
Device, DeviceMetric | |
US Core Head Circumference Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Head Circumference Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Heart Rate Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Heart Rate Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Laboratory Result Observation Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Laboratory Result Observation Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation ADI Documentation Profile | Observation.performer* |
Practitioner**, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation ADI Documentation Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Clinical Result Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation Clinical Result Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Occupation Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation Occupation Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Pregnancy Intent Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation Pregnancy Intent Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Pregnancy Status Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation Pregnancy Status Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Screening Assessment Profile | Observation.performer* |
Practitioner**, Organization, PractitionerRole, Patient**, RelatedPerson, CareTeam | |
US Core Observation Screening Assessment Profile | Observation.device |
Device, DeviceMetric | |
US Core Observation Sexual Orientation Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Observation Sexual Orientation Profile | Observation.device |
Device, DeviceMetric | |
US Core Pediatric BMI for Age Observation Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Pediatric BMI for Age Observation Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Pediatric Head Occipital Frontal Circumference Percentile Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Pediatric Head Occipital Frontal Circumference Percentile Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Pediatric Weight for Height Observation Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Pediatric Weight for Height Observation Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Pulse Oximetry Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Pulse Oximetry Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Respiratory Rate Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Respiratory Rate Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Simple Observation Profile | Observation.performer* |
Practitioner**, Organization, PractitionerRole, Patient**, RelatedPerson, CareTeam | |
US Core Simple Observation Profile | Observation.device |
Device, DeviceMetric | |
US Core Smoking Status Observation Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Smoking Status Observation Profile | Observation.device |
Device, DeviceMetric | |
US Core Treatment Intervention Preference Profile | Observation.performer |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam | |
US Core Treatment Intervention Preference Profile | Observation.device |
Device, DeviceMetric | |
US Core Vital Signs Profile | ✓ | Observation.performer* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, CareTeam |
US Core Vital Signs Profile | ✓ | Observation.device |
Device, DeviceMetric |
US Core Procedure Profile | ✓ | Procedure.asserter |
Practitioner, PractitionerRole, Patient, RelatedPerson |
US Core Procedure Profile | ✓ | Procedure.performer.actor* |
Practitioner, Organization, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric |
US Core QuestionnaireResponse Profile | QuestionnaireResponse.author* |
Practitioner**, Organization, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric | |
US Core QuestionnaireResponse Profile | QuestionnaireResponse.source |
Practitioner, PractitionerRole, Patient, RelatedPerson | |
US Core ServiceRequest Profile | ServiceRequest.requester* |
Practitioner**, Organization, PractitionerRole, Patient, RelatedPerson, Device, DeviceMetric |
* US Core Must Support or Additional USCDI element
** US Core Must Support Target Resource Type