This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "List 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=
+
=list=
  
 
<!-- 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]]
+
Will be one of [[Public_Health_and_Emergency_Response_work_group_(PHER)|Public Health & Emergency Response]] or [[Patient_Administration|Patient Administration Working Group]] but up to the completion of the first ballot it is temporarily owned by FHIR Core Team
 +
 
 +
[[User:Hugh Glover|Hugh Glover]] 10:55, 18 June 2013 (UTC): I'm assuming List should be owned by the same group as group
  
 
==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
 
* Work Group Name
 
* or link
 
* or link
* or "None"
+
* or "None" -->
 
+
All work groups may have cause to use this resource at some time, but no one group has a special requirement.
 +
 
==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 58:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
A ''list'' represents a collection of resources that is defined by enumeration and may be ordered.  The contents of a list may change over time and there may be a record kept of items that it did contain but have now been deleted. 
 +
 +
A list is similar to a group but is not an exact specialisation of a group.
 +
 +
Groups may have a business identifier and as such constitute an entity in their own right outside FHIR.  In contrast lists which may be of a specific type, but are not identifiable as list instances other than by means of their FHIR URL.
 +
 +
Groups may be defined by criteria for inclusion or by enumeration whereas lists which can only be enumerated.
 +
 +
Groups cannot be ordered, and have no concept of former members who have now been deleted.
 +
 +
[[User:Hugh Glover|Hugh Glover]] 10:55, 18 June 2013 (UTC): Not sure the distinction between group and list is sufficient to justify them being separate resources.
  
 
==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. -->
 +
Act[normalAct() and subsumes(ActClass#_ActClassRecordOrganizer, classCode) and moodCode=EVN]
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 89:
 
* 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  
 
  -->
 
  -->
 +
Dealing with collections of objects is a universal concept both in healthcare and in information modelling. 
  
 
==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. -->
 +
 +
Most real world implementations will have to use this concept at some point.
 +
[[User:Hugh Glover|Hugh Glover]] 10:55, 18 June 2013 (UTC): Any offers for a more specific implementation?
  
 
==Content sources==
 
==Content sources==
Line 84: Line 103:
  
 
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? -->
 +
[[User:Hugh Glover|Hugh Glover]] 10:55, 18 June 2013 (UTC): Dunno - seems like common sense to me!
  
 
==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.) -->
 +
 +
# Keeping a running list of patients in a ward
 +
# Providing a snapshot of the items dispensed to a patient in the last 3 months
 +
# Listing a patient's allergies and intolerances
 +
# Listing changes in a patient's allergies and intolerances since they were last assessed 
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 99: Line 124:
 
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)
 
  -->
 
  -->
 +
[[User:Hugh Glover|Hugh Glover]] 10:55, 18 June 2013 (UTC): This is a very generic - any offers for some additional specific uses ...
 +
#any resource that is an event or entity of some form may be summarised and managed by means of a list.
  
 
==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 -->
 +
Ready for ballot in September 2013
  
 
==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

Revision as of 10:56, 18 June 2013



list

Owning committee name

Will be one of Public Health & Emergency Response or Patient Administration Working Group but up to the completion of the first ballot it is temporarily owned by FHIR Core Team

Hugh Glover 10:55, 18 June 2013 (UTC): I'm assuming List should be owned by the same group as group

Contributing or Reviewing Work Groups

All work groups may have cause to use this resource at some time, but no one group has a special requirement.

FHIR Resource Development Project Insight ID

pending

Scope of coverage

A list represents a collection of resources that is defined by enumeration and may be ordered. The contents of a list may change over time and there may be a record kept of items that it did contain but have now been deleted.

A list is similar to a group but is not an exact specialisation of a group.

Groups may have a business identifier and as such constitute an entity in their own right outside FHIR. In contrast lists which may be of a specific type, but are not identifiable as list instances other than by means of their FHIR URL.

Groups may be defined by criteria for inclusion or by enumeration whereas lists which can only be enumerated.

Groups cannot be ordered, and have no concept of former members who have now been deleted.

Hugh Glover 10:55, 18 June 2013 (UTC): Not sure the distinction between group and list is sufficient to justify them being separate resources.

RIM scope

Act[normalAct() and subsumes(ActClass#_ActClassRecordOrganizer, classCode) and moodCode=EVN]

Resource appropriateness

Dealing with collections of objects is a universal concept both in healthcare and in information modelling.

Expected implementations

Most real world implementations will have to use this concept at some point. Hugh Glover 10:55, 18 June 2013 (UTC): Any offers for a more specific implementation?

Content sources

Hugh Glover 10:55, 18 June 2013 (UTC): Dunno - seems like common sense to me!

Example Scenarios

  1. Keeping a running list of patients in a ward
  2. Providing a snapshot of the items dispensed to a patient in the last 3 months
  3. Listing a patient's allergies and intolerances
  4. Listing changes in a patient's allergies and intolerances since they were last assessed

Resource Relationships

Hugh Glover 10:55, 18 June 2013 (UTC): This is a very generic - any offers for some additional specific uses ...

  1. any resource that is an event or entity of some form may be summarised and managed by means of a list.

Timelines

Ready for ballot in September 2013

gForge Users

n/a