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

Difference between revisions of "GraphDefinition FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(3 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
<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 13:
  
  
=PutProposedResourceNameHere=
+
=GraphDefinition=
  
<!-- Resource names should meet the following characteristics:
 
* Lower camel case
 
* U.S. English
 
* Domain-friendly
 
* Short
 
* Clear
 
* Unique
 
* Avoid non-universal abbreviations (e.g. URL would be ok)
 
* Be expressed as a noun
 
* Be consistent with other similar resources
 
-->
 
  
 
==Owning committee name==
 
==Owning committee name==
 +
[[FHIR Infrastructure]]
  
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
 
[[YourCommitteeName]]
 
 
==Committee Approval Date:==
 
==Committee Approval Date:==
<i>Please enter the date that the committee approved this Resource proposal</i>
+
2017-02-20
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
 
+
*PAFM
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the resource (optional) -->
+
*OO
* Work Group Name
+
*CDS
* or link
+
*FM
* or "None"
+
*Security
  
 
==FHIR Resource Development Project Insight ID==
 
==FHIR Resource Development Project Insight ID==
 
+
1207
<!-- 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 -->
 
  
 
==Scope of coverage==
 
==Scope of coverage==
 +
The GraphDefinition resource provides a formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set. The GraphDefinition resource can be used to:
  
<!-- Define the full scope of coverage for the resource.  The scope must be clearly delineated such that it does not overlap with any other existing or expected resource.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%"
+
*Summarize a set of profiles on resources
 
+
*Define a graph of resources to return in a query
Scope should consider numerous aspects of breadth of scope, including:
+
*Define a graph of resources to include in a document
* Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)
+
*Document rules about the relationship between a set of resources e.g. must all resources concern the same patient?
* Disciplines: Environmental Health, Palliative, Respiratory, Psychology, Maternity, Clinical Research
 
* Delivery environment (Community, Geriatric, Home care, Emergency, Inpatient, Intensive, Neonatal, Pediatric, Primary)
 
* Locale: Country, region
 
  
As a rule, resources should encompass all of these aspects.
+
This is a definitional, infrastructure level resource, so it applies across all types of subjects, disciplines, delivery environments, etc.
-->
 
  
 
==RIM scope==
 
==RIM scope==
 
+
This resource lives outside the RIM spaceIt's about defining how resources can be interlinked, so it's essentially a pattern for defining RMIMs in RIM terms
<!-- Identify the formal RIM mapping for the root concept of the resourceThe expectation is that the RIM mapping will be sufficiently precise so as to not overlap with any other resource definition. -->
 
  
 
==Resource appropriateness==
 
==Resource appropriateness==
 +
FHIR breaks concepts down into leaf-level constructs - i.e. resources.  It is quite common in healthcare to have more complex structures such as care plans, protocols, documents, etc. that combine a lot of different types of information.  We convey "instances" of these complex structures using Bundle.  But there's no good way of defining such collections definitionally in FHIR yet without fully profiling every data element that is to be included.
  
<!-- Does the resource meet the following characteristics?
+
Use-cases include the content model for documents, messages, to allow easy querying of particular subsets of data (everything related to a patient's diabetes, all of the information relating to a CarePlan, etc.
  
Must
+
Each Graph will be independently maintained as an infrastructure resource similar to profiles and would share the same sort of metadata.
* Represents a well understood, "important" concept in the business of healthcare
 
* Represents a concept expected to be tracked with distinct, reliable, unique ids
 
* Reasonable for the resource to be independently created, queried and maintained
 
  
Should
+
These graphs will allow providing a high-level view of "how do resources fit together to address an a particular problem space?" which is a question that is starting to be asked with increasing frequency now that the resources themselves are starting to stabilize
* Declared interest in need for standardization of data exchange</span>
 
* Resource is expected to contain an appropriate number of "core" (non-extension) data elements (in most cases, somewhere in the range of 20-50)
 
* Have the characteristics of high cohesion & low coupling – need to explore whether coupling is good some places, not elsewhere – layers from Bo’s document
 
-->
 
  
 
==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. -->
+
This will be used to help define documents and messages as well as to define queries.  We will test it at Connectathon in May
  
 
==Content sources==
 
==Content sources==
 
+
The need for this artifact is driven by FHIR's resource nature and structure, so it can't really be pulled from other designs - the requirement for it is uniquely FHIR
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
 
 
 
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
 
  
 
==Example Scenarios==
 
==Example Scenarios==
 
+
* Define all information that is relevant for hypertension
<!-- 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.) -->
+
* Define the information that should be conveyed in a particular message
 +
* Explain how the notion of CarePlan is expressed in FHIR (not just the resource, but everything that goes around it that is relevant in the minds of clinicians and developers to the notion of CarePlan)
 +
* Grant access to a clinician to "all information related to my diabetes" and be able to use the GraphDefinition to identify which resources fall within that definition
  
 
==Resource Relationships==
 
==Resource Relationships==
 +
Overlaps with StructureDefinition - a fully defined set of profiles with AggregationMode specified can provide a "light-weight" GraphDefinition.
  
<!-- What are the resources do you expect will reference this resource and in what context?
+
GraphDefinition does not reference any resources.  It will likely be referenced by MessageDefinition and StructureDefinition.  It may also be referenced by Contract, Consent and others (either in core or through extensions)
 
 
What resources do you expect this resource reference and in what context?
 
 
 
Note: These may be existing resources or "expected" resource
 
 
 
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
-->
 
  
 
==Timelines==
 
==Timelines==
 
+
Include as draft in STU 3 with expectation to go STU status in the following release
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
  
 
==gForge Users==
 
==gForge Users==
 
+
grahame, lloyd
<!-- Identify the userids who will require commit access to gForge to maintain the resource.  (Ensure all users have registered for gForge.) -->
 
  
 
==When Resource Proposal Is Complete==
 
==When Resource Proposal Is Complete==
 +
Approved by FMG 2017-03-01
 
'''When you have completed your proposal, please send an email to [mailto:FMGcontact@HL7.org FMGcontact@HL7.org]'''
 
'''When you have completed your proposal, please send an email to [mailto:FMGcontact@HL7.org FMGcontact@HL7.org]'''

Latest revision as of 21:35, 1 March 2017



GraphDefinition

Owning committee name

FHIR Infrastructure

Committee Approval Date:

2017-02-20

Contributing or Reviewing Work Groups

  • PAFM
  • OO
  • CDS
  • FM
  • Security

FHIR Resource Development Project Insight ID

1207

Scope of coverage

The GraphDefinition resource provides a formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set. The GraphDefinition resource can be used to:

  • Summarize a set of profiles on resources
  • Define a graph of resources to return in a query
  • Define a graph of resources to include in a document
  • Document rules about the relationship between a set of resources e.g. must all resources concern the same patient?

This is a definitional, infrastructure level resource, so it applies across all types of subjects, disciplines, delivery environments, etc.

RIM scope

This resource lives outside the RIM space. It's about defining how resources can be interlinked, so it's essentially a pattern for defining RMIMs in RIM terms

Resource appropriateness

FHIR breaks concepts down into leaf-level constructs - i.e. resources. It is quite common in healthcare to have more complex structures such as care plans, protocols, documents, etc. that combine a lot of different types of information. We convey "instances" of these complex structures using Bundle. But there's no good way of defining such collections definitionally in FHIR yet without fully profiling every data element that is to be included.

Use-cases include the content model for documents, messages, to allow easy querying of particular subsets of data (everything related to a patient's diabetes, all of the information relating to a CarePlan, etc.

Each Graph will be independently maintained as an infrastructure resource similar to profiles and would share the same sort of metadata.

These graphs will allow providing a high-level view of "how do resources fit together to address an a particular problem space?" which is a question that is starting to be asked with increasing frequency now that the resources themselves are starting to stabilize

Expected implementations

This will be used to help define documents and messages as well as to define queries. We will test it at Connectathon in May

Content sources

The need for this artifact is driven by FHIR's resource nature and structure, so it can't really be pulled from other designs - the requirement for it is uniquely FHIR

Example Scenarios

  • Define all information that is relevant for hypertension
  • Define the information that should be conveyed in a particular message
  • Explain how the notion of CarePlan is expressed in FHIR (not just the resource, but everything that goes around it that is relevant in the minds of clinicians and developers to the notion of CarePlan)
  • Grant access to a clinician to "all information related to my diabetes" and be able to use the GraphDefinition to identify which resources fall within that definition

Resource Relationships

Overlaps with StructureDefinition - a fully defined set of profiles with AggregationMode specified can provide a "light-weight" GraphDefinition.

GraphDefinition does not reference any resources. It will likely be referenced by MessageDefinition and StructureDefinition. It may also be referenced by Contract, Consent and others (either in core or through extensions)

Timelines

Include as draft in STU 3 with expectation to go STU status in the following release

gForge Users

grahame, lloyd

When Resource Proposal Is Complete

Approved by FMG 2017-03-01 When you have completed your proposal, please send an email to FMGcontact@HL7.org