This wiki has undergone a migration to Confluence found Here

Difference between revisions of "DocumentReference FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
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>
Line 13: Line 12:
  
  
=putProposedResourceNameHere=
+
=DocumentReference=
  
 
<!-- 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. -->
[[YourCommitteeName]]
+
[http://www.ihe.net IHE IT Infrastructure Technical Committee]
 +
 
  
 
==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) -->
* Work Group Name
+
* [[EHR]]
* or link
 
* or "None"
 
  
 
==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 -->
 +
 +
unclear how to reference external organization ownership
  
 
==Scope of coverage==
 
==Scope of coverage==
Line 55: Line 55:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
This resource includes a set of metadata about a patient specific medical 'document'. This document might be CDA based, or might be of some other format including DICOM and PDF. The metadata that describes the 'document' is not a replacement for the document. This resource contained metadata is descriptive of the document provenance, patient identity, security & privacy, content format, content purpose, and document lifecycle.
  
 
==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. -->
 +
This resource is not directly related to the RIM, but will leverage RIM concepts as appropriate.
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 76:
 
* 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  
 
  -->
 
  -->
 +
A reference to a document.
 +
 +
A document reference is a reference to a document defined in some other format, or stored in some other system. Typically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and also to refer to:
 +
 +
* CDA documents in FHIR systems
 +
* FHIR documents stored in other systems
 +
* PDF documents
 +
* DICOM structured reports stored in PACS
 +
* Other kinds of documents, such as records of prescriptions.
 +
 +
FHIR defines both a document format and this document reference. FHIR documents are for documents that are authored and assembled in FHIR. This resource is for general references to other documents.
 +
 +
Note that there is no formal or limited definition of what a document is.
 +
 +
The document that is a target of the reference can be a reference to a FHIR document served by another server, or the target can be stored in the special FHIR Binary Resource, or the target can be stored on some other server system. The document reference is also able to address documents that are retrieved by a service call such as an XDS.b RetrieveDocumentSet, or a DICOM exchange, or a v2 message query, though the way each of these works must be specified in an implementation guide.
  
 
==Expected implementations==
 
==Expected implementations==
Line 84: Line 101:
  
 
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? -->
 +
* [http://wiki.ihe.net/index.php?title=Cross-Enterprise_Document_Sharing IHE Cross-Enterprise Document Sharing (XDS)]
 +
* [http://wiki.ihe.net/index.php?title=XCA IHE Cross-Community Document Access (XCA)]
 +
* [http://wiki.ihe.net/index.php?title=XDR IHE Cross-Enterprise Document Reliable Interchange (XDR)]
 +
* [http://wiki.ihe.net/index.php?title=XDM IHE Cross-Enterprise Document Media Interchange (XDM)]
 +
* [http://wiki.ihe.net/index.php?title=MHD IHE Mobile access to Health Documents {MHD}]
 +
* [http://dublincore.org/documents/abstract-model/ Dublin Core - Abstract Model]
 +
* [http://www.ietf.org/rfc/rfc5013.txt RFC 5013] The Dublin Core Metadata Element Set
 +
* [http://www.iso.org/iso/search.htm?qt=15836&searchSubmit=Search&sort=rel&type=simple&published=on ISO15836] Information and documentation -- The Dublin Core metadata element set
  
 
==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.) -->
 +
* submit a new document and metadata from the mobile device to a document receiver,
 +
* get the metadata for an identified document,
 +
* find document entries containing metadata based on query parameters, and
 +
* retrieve a copy of a specific document.
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 99: Line 128:
 
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)
 
  -->
 
  -->
 +
unknown at this time
  
 
==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 -->
 +
urgent
  
 
==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.) -->
 +
john_moehrke

Revision as of 17:51, 27 May 2013



DocumentReference

Owning committee name

IHE IT Infrastructure Technical Committee


Contributing or Reviewing Work Groups

FHIR Resource Development Project Insight ID

unclear how to reference external organization ownership

Scope of coverage

This resource includes a set of metadata about a patient specific medical 'document'. This document might be CDA based, or might be of some other format including DICOM and PDF. The metadata that describes the 'document' is not a replacement for the document. This resource contained metadata is descriptive of the document provenance, patient identity, security & privacy, content format, content purpose, and document lifecycle.

RIM scope

This resource is not directly related to the RIM, but will leverage RIM concepts as appropriate.

Resource appropriateness

A reference to a document.

A document reference is a reference to a document defined in some other format, or stored in some other system. Typically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and also to refer to:

  • CDA documents in FHIR systems
  • FHIR documents stored in other systems
  • PDF documents
  • DICOM structured reports stored in PACS
  • Other kinds of documents, such as records of prescriptions.

FHIR defines both a document format and this document reference. FHIR documents are for documents that are authored and assembled in FHIR. This resource is for general references to other documents.

Note that there is no formal or limited definition of what a document is.

The document that is a target of the reference can be a reference to a FHIR document served by another server, or the target can be stored in the special FHIR Binary Resource, or the target can be stored on some other server system. The document reference is also able to address documents that are retrieved by a service call such as an XDS.b RetrieveDocumentSet, or a DICOM exchange, or a v2 message query, though the way each of these works must be specified in an implementation guide.

Expected implementations

Content sources

Example Scenarios

  • submit a new document and metadata from the mobile device to a document receiver,
  • get the metadata for an identified document,
  • find document entries containing metadata based on query parameters, and
  • retrieve a copy of a specific document.

Resource Relationships

unknown at this time

Timelines

urgent

gForge Users

john_moehrke