This wiki has undergone a migration to Confluence found Here
Difference between revisions of "Provenance FHIR Resource Proposal"
Jump to navigation
Jump to search
JohnMoehrke (talk | contribs) (Created page with "{{subst::Template:FHIR Resource Proposal}}") |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
<div class="messagebox cleanup metadata"> | <div class="messagebox cleanup metadata"> | ||
<div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div> | <div style="float: left;">[[Image:OpenHotTopic.GIF|35px| ]]</div> | ||
<div style="background:#F0F0F0"> | <div style="background:#F0F0F0"> | ||
| − | This page documents | + | This page documents an [[:category:Approved FHIR Resource Proposal|Approved]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]] |
</div> | </div> | ||
</div> | </div> | ||
[[Category:FHIR Resource Proposal]] | [[Category:FHIR Resource Proposal]] | ||
| − | [[Category: | + | [[Category:Approved FHIR Resource Proposal]] |
| Line 13: | Line 12: | ||
| − | = | + | =Provenance= |
<!-- Resource names should meet the following characteristics: | <!-- Resource names should meet the following characteristics: | ||
| Line 30: | Line 29: | ||
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. --> | <!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. --> | ||
| − | [[ | + | [[Modelling and Methodology]] |
==Contributing or Reviewing Work Groups== | ==Contributing or Reviewing Work Groups== | ||
<!-- Additional work groups that may have an interest in contributing to, or reviewing the content of the resource (optional) --> | <!-- Additional work groups that may have an interest in contributing to, or reviewing the content of the resource (optional) --> | ||
| − | * | + | *[[Community-Based Collaborative Care]], which has the development of FHIR Provenance Resource within scope of [http://gforge.hl7.org/gf/download/docmanfileversion/8267/12090/HL7%20Project%20Scope%20Statement%20Data%20Provenance%206-18-2014.doc Project ID: 1093 “Provenance for Clinical Document Architecture (CDA R2) Implementation Guide”] |
| − | * | + | * [[Security]], which is a co-sponsor of Project 1093 |
| − | * | + | * [[Structured Documents]], which is a co-sponsor of Project 1093 |
| + | * [[EHR]] | ||
==FHIR Resource Development Project Insight ID== | ==FHIR Resource Development Project Insight ID== | ||
<!-- Please specify the id of your work group’s PSS for doing FHIR work. (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc --> | <!-- Please specify the id of your work group’s PSS for doing FHIR work. (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc --> | ||
| + | pending | ||
==Scope of coverage== | ==Scope of coverage== | ||
| Line 55: | Line 56: | ||
As a rule, resources should encompass all of these aspects. | As a rule, resources should encompass all of these aspects. | ||
--> | --> | ||
| + | Provenance refers to the sources of information, such as entities and processes, involved in producing or delivering an artifact. The provenance of information is crucial in deciding whether information is to be trusted, how it should be integrated with other diverse information sources, and how to give credit to its originators when reusing it. | ||
| + | |||
| + | In some scenarios the provenance resource is unnecessary as the resource itself contains the required 'background' information - such as author, time of recording etc. However, any resource can be associated with a provenance if required (though note that the relation is from the provenance to the resource and not the other way around 0 except in the case of the DocumentRoot resource) | ||
==RIM scope== | ==RIM scope== | ||
<!-- Identify the formal RIM mapping for the root concept of the resource. The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. --> | <!-- Identify the formal RIM mapping for the root concept of the resource. The expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. --> | ||
| + | The provenance resource is based on known practices in the HL7 implementation space, particularly those found in the v2 EVN segment, the v3 ControlAct Wrapper, and the CDA header. | ||
==Resource appropriateness== | ==Resource appropriateness== | ||
| Line 74: | Line 79: | ||
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document | * Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document | ||
--> | --> | ||
| + | Provenance is used by Security, Privacy, Medical Records, Medical Ethics, and good documentation practices. | ||
==Expected implementations== | ==Expected implementations== | ||
<!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. --> | <!--Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. Provide named implementations if possible - ideally provide multiple independent implementations. --> | ||
| + | The Provenance resource is expected to be used to prove Integrity, Authenticity, and to give credit when sighting a resource content. | ||
==Content sources== | ==Content sources== | ||
| Line 84: | Line 91: | ||
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? --> | Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? --> | ||
| + | The conceptual model underlying the design is the [http://www.w3.org/2011/prov/wiki/Main_Page W3C Provenance Specification]. Though the content and format of the resource is designed to meet specific requirements for FHIR, all the parts of the resource are formally mapped to the PROV-O specification, and FHIR resources can be transformed to their W3C PROV equivalent. | ||
==Example Scenarios== | ==Example Scenarios== | ||
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource. They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | <!-- Provide a listing of the types of scenarios to be represented in the examples produced for this resource. They should demonstrate the full scope of the resource and allow exercising of the resources capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | ||
| + | Access Control decisions based on Integrity assertions of the resource | ||
| + | Access Control decisions based on the Privacy policy including restricted rules on source of resource | ||
| + | Medical Records regulations proof of authorship of a resource | ||
| + | Medical Ethics decisions based on proof of authorship and integrity of a resource | ||
==Resource Relationships== | ==Resource Relationships== | ||
| Line 99: | Line 111: | ||
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording) | Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording) | ||
--> | --> | ||
| + | All resources may/should/shall have a Provenance resource | ||
| + | |||
| + | Note that there is no link from a provenance resource to the resource/s it describes. They need to be queried separately. | ||
==Timelines== | ==Timelines== | ||
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting --> | <!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting --> | ||
| + | 2014 | ||
==gForge Users== | ==gForge Users== | ||
<!-- Identify the userids who will require commit access to gForge to maintain the resource. (Ensure all users have registered for gForge.) --> | <!-- Identify the userids who will require commit access to gForge to maintain the resource. (Ensure all users have registered for gForge.) --> | ||
| + | unknown | ||
Latest revision as of 17:55, 6 October 2014
This page documents an Approved FHIR Resource Proposal
Contents
- 1 Provenance
- 1.1 Owning committee name
- 1.2 Contributing or Reviewing Work Groups
- 1.3 FHIR Resource Development Project Insight ID
- 1.4 Scope of coverage
- 1.5 RIM scope
- 1.6 Resource appropriateness
- 1.7 Expected implementations
- 1.8 Content sources
- 1.9 Example Scenarios
- 1.10 Resource Relationships
- 1.11 Timelines
- 1.12 gForge Users
Provenance
Owning committee name
Contributing or Reviewing Work Groups
- Community-Based Collaborative Care, which has the development of FHIR Provenance Resource within scope of Project ID: 1093 “Provenance for Clinical Document Architecture (CDA R2) Implementation Guide”
- Security, which is a co-sponsor of Project 1093
- Structured Documents, which is a co-sponsor of Project 1093
- EHR
FHIR Resource Development Project Insight ID
pending
Scope of coverage
Provenance refers to the sources of information, such as entities and processes, involved in producing or delivering an artifact. The provenance of information is crucial in deciding whether information is to be trusted, how it should be integrated with other diverse information sources, and how to give credit to its originators when reusing it.
In some scenarios the provenance resource is unnecessary as the resource itself contains the required 'background' information - such as author, time of recording etc. However, any resource can be associated with a provenance if required (though note that the relation is from the provenance to the resource and not the other way around 0 except in the case of the DocumentRoot resource)
RIM scope
The provenance resource is based on known practices in the HL7 implementation space, particularly those found in the v2 EVN segment, the v3 ControlAct Wrapper, and the CDA header.
Resource appropriateness
Provenance is used by Security, Privacy, Medical Records, Medical Ethics, and good documentation practices.
Expected implementations
The Provenance resource is expected to be used to prove Integrity, Authenticity, and to give credit when sighting a resource content.
Content sources
The conceptual model underlying the design is the W3C Provenance Specification. Though the content and format of the resource is designed to meet specific requirements for FHIR, all the parts of the resource are formally mapped to the PROV-O specification, and FHIR resources can be transformed to their W3C PROV equivalent.
Example Scenarios
Access Control decisions based on Integrity assertions of the resource Access Control decisions based on the Privacy policy including restricted rules on source of resource Medical Records regulations proof of authorship of a resource Medical Ethics decisions based on proof of authorship and integrity of a resource
Resource Relationships
All resources may/should/shall have a Provenance resource
Note that there is no link from a provenance resource to the resource/s it describes. They need to be queried separately.
Timelines
2014
gForge Users
unknown
