This wiki has undergone a migration to Confluence found Here

Difference between revisions of "MessageHeader FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
 
(24 intermediate revisions by 3 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 a [[:category:Pending FHIR Resource Proposal|Pending]] [[:category:FHIR Resource Proposal|FHIR Resource Proposal]]
+
This page documents a [[: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:Pending FHIR Resource Proposal]]
+
[[Category:Approved FHIR Resource Proposal]]
  
  
Line 13: Line 12:
  
  
=Message=
+
=MessageRoot=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 29: Line 28:
 
==Owning committee name==
 
==Owning committee name==
  
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
+
Infrastructure and Messaging (currently handled by Core Team)
[[YourCommitteeName]]
 
  
 
==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
+
FMG, OO, MnM, ...
* 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 -->
 +
 +
pending
  
 
==Scope of coverage==
 
==Scope of coverage==
Line 55: Line 53:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
A transmission requesting action on a bundle of one or more resources or a response to such a request.
 +
 +
In FHIR messaging, a "request message" is sent from a source application to a destination application when an event happens. Events mostly correspond to things that happen in the real world. The request message consists of a bundle of resources, with the first resource in the bundle being this Message resource. The Message resource has a code - the message event - that identifies the nature of the request message and carries additional request metadata. The other resources in the bundle depend on the type of the request.
 +
 +
MessageRoot is distinct from DocumentRoot in that Message is event focused and has a specific receiver in mind and an expected response.  DocumentRoot is focused on content and persistence with no defined consumer or behavior. Both, however, are specified to be the first resource in the bundle that contains their 'child' resources, and it is the presence of the resource that designates the bundle as a 'FHIR Document' or a 'FHIR Message'
  
 
==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. -->
 +
Message
 +
 +
Detailed message resource mappings (for v3 & v2) can be found at: http://www.hl7.org/implement/standards/fhir/message-mappings.htm
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 80:
 
* 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  
 
  -->
 
  -->
 +
 +
The messaging paradigm embodied in v2 is widely understood and used within contemporary healthcare. Given that wide base of knowledge and experience it is reasonable to assume that members of the v2 community will experiment and likely adopt use of FHIR resources using this paradigm.
 +
 +
The message resource will allow development of FHIR based messaging likely within healthcare entities and across organizational boundaries over time.
  
 
==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. -->
 +
Core Infrastructure.  Needed to satisfy R2 and some R3 requirements.
 +
 +
Needed for v2 replacement
  
 
==Content sources==
 
==Content sources==
Line 84: Line 97:
  
 
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? -->
 +
V2 (MSH) V3 (Transmission wrappers)
  
 
==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.) -->
 +
Using the message resource it is reasonable to expect development of scenarios similar to
 +
v2 messaging exchanges.
 +
 +
1) Patient Administration - Admission, Discharge and Transfer scenarios
 +
 +
2) Order entry - for labs, pharmacy, imaging, etc.
 +
 +
3) Observation reporting - lab results, microbiology, imaging results, etc.
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 99: Line 121:
 
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)
 
  -->
 
  -->
 +
 +
Messages point to the resources contained in the message as well as (potentially) to the message they're responding to.
  
 
==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 -->
 +
Part of the first DSTU
  
 
==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.) -->
 +
N/A

Latest revision as of 17:55, 11 March 2015



MessageRoot

Owning committee name

Infrastructure and Messaging (currently handled by Core Team)

Contributing or Reviewing Work Groups

FMG, OO, MnM, ...

FHIR Resource Development Project Insight ID

pending

Scope of coverage

A transmission requesting action on a bundle of one or more resources or a response to such a request.

In FHIR messaging, a "request message" is sent from a source application to a destination application when an event happens. Events mostly correspond to things that happen in the real world. The request message consists of a bundle of resources, with the first resource in the bundle being this Message resource. The Message resource has a code - the message event - that identifies the nature of the request message and carries additional request metadata. The other resources in the bundle depend on the type of the request.

MessageRoot is distinct from DocumentRoot in that Message is event focused and has a specific receiver in mind and an expected response. DocumentRoot is focused on content and persistence with no defined consumer or behavior. Both, however, are specified to be the first resource in the bundle that contains their 'child' resources, and it is the presence of the resource that designates the bundle as a 'FHIR Document' or a 'FHIR Message'

RIM scope

Message

Detailed message resource mappings (for v3 & v2) can be found at: http://www.hl7.org/implement/standards/fhir/message-mappings.htm

Resource appropriateness

The messaging paradigm embodied in v2 is widely understood and used within contemporary healthcare. Given that wide base of knowledge and experience it is reasonable to assume that members of the v2 community will experiment and likely adopt use of FHIR resources using this paradigm.

The message resource will allow development of FHIR based messaging likely within healthcare entities and across organizational boundaries over time.

Expected implementations

Core Infrastructure. Needed to satisfy R2 and some R3 requirements.

Needed for v2 replacement

Content sources

V2 (MSH) V3 (Transmission wrappers)

Example Scenarios

Using the message resource it is reasonable to expect development of scenarios similar to v2 messaging exchanges.

1) Patient Administration - Admission, Discharge and Transfer scenarios

2) Order entry - for labs, pharmacy, imaging, etc.

3) Observation reporting - lab results, microbiology, imaging results, etc.

Resource Relationships

Messages point to the resources contained in the message as well as (potentially) to the message they're responding to.

Timelines

Part of the first DSTU

gForge Users

N/A