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

Difference between revisions of "ActivityDefinition FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(4 intermediate revisions by 2 users 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=
+
=ActivityDefinition=
 +
 
 +
The ActivityDefinition defines a template for the creation of intent resources (such as requests, plans, or proposals). The structure contains generic information that can be applied to any intent resource, as well as some specific structures to support the definition of more complex activities such as MedicationRequest.
 +
 
 +
The resource can be used independently, but it can also be combined with multiple definitions using the PlanDefinition resource to describe order sets, protocols, or decision support rules.
 +
 
 +
The intent of the resource is to provide reusable activity definitions to enable automated sharing of knowledge artifacts such as order sets, protocols, and decision support rules.
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
Line 30: Line 36:
  
 
<!-- 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]]
+
[[Clinical_Decision_Support_Workgroup|Clinical Decision Support Work Group]]
 +
 
 
==Committee Approval Date:==
 
==Committee Approval Date:==
<i>Please enter the date that the committee approved this Resource proposal</i>
+
* Resource Proposal: 2016-07-06
 +
* STU3 Ballot Submission: 2016-08-03
  
 
==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
+
*[[Clinical_Quality_Information_Work_Group|Clinical Quality Information Work Group]]
* 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 -->
+
[http://www.hl7.org/Special/committees/dss/projects.cfm?action=edit&ProjectNumber=1234 1234: FHIR-Based Clinical Quality Framework (CQF-on-FHIR)]
  
 
==Scope of coverage==
 
==Scope of coverage==
Line 57: Line 63:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
 +
An ActivityDefinition is a knowledge artifact that enables the representation and sharing of pre-defined templates for intent resources. It differs from the intent resources in that it is not specific to a given patient or particular type of resource, rather it defines a template for constructing a specific intent resource for a patient.
 +
 +
ActivityDefinitions can be used both within and between healthcare delivery environments, both as part of a catalog, as well as by content providers for sharing and distribution of activity templates.
 +
 +
The resource is flexible enough to be used to describe activity definitions for any discipline and locale, as well as for any resource type. The structure is generally high-level and conceptual, though it does contain specific structures for more complex intent resources such as MedicationOrder. As these more specific types are introduced, it may make sense to break the resource into several more specific resources.
  
 
==RIM scope==
 
==RIM scope==
Line 76: Line 88:
 
* 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 notion of a "template" for a clinical activity is an important aspect of describing and sharing clinical knowledge. The concept appears in multiple settings and the resource should be general to handle a broad variety of use cases. In particular, the concept is key to modeling protocols, order sets, and decision support rules.
  
 
==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. -->
 +
 +
Motive Medical
 +
Cognitive Medical
 +
NCCN
 +
Plexina
  
 
==Content sources==
 
==Content sources==
Line 86: Line 105:
  
 
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://www.hl7.org/implement/standards/product_brief.cfm?product_id=391 Clinical Quality Common Metadata Conceptual Model]
 +
*[http://www.hl7.org/implement/standards/product_brief.cfm?product_id=337 Clinical Decision Support Knowledge Artifact Specification]
 +
*[http://www.hl7.org/implement/standards/product_brief.cfm?product_id=287 Order Set Publication]
  
 
==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.) -->
 +
 +
The resource will be used for the same example scenarios as the PlanDefinition resource, namely:
 +
 +
===Low Suicide Risk===
 +
When assessing a patient for suicide risk, the actions that should be taken as a result of the assessment is defined as an order set.
 +
 +
===Obesity Determination Protocol===
 +
Example of A medical algorithm for assessment and treatment of overweight and obesity
 +
 +
===Research Protocols===
 +
Clinical trials and other types of research specify protocols to ensure the research produces valid data. The resource can be used to specify actions to be taken in the clinical trial.
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 101: Line 135:
 
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)
 
  -->
 
  -->
 +
 +
This resource will make use of the [http://hl7.org/fhir/library.html Library] resource to represent any logic involved in defining the behavior of the plan definition.
 +
 +
This resource will also be referenced by the [http://hl7.org/fhir/plandefinition.html PlanDefinition] resource to represent the target of each action within the plan definition.
 +
 +
* [http://hl7.org/fhir/contactdetail.html ContactDetail]
 +
* [http://hl7.org/fhir/contributor.html Contributor]
 +
* [http://hl7.org/fhir/relatedresource.html RelatedResource]
 +
* [http://hl7.org/fhir/usagecontext.html UsageContext]
 +
* [http://hl7.org/fhir/triggerdefinition.html TriggerDefinition]
  
 
==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 -->
 +
 +
September 2016 Ballot Cycle in support of the [http://hl7.org/fhir/cqif/cqif.html CQF IG].
  
 
==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.) -->
 +
brynrhodes
  
 
==When Resource Proposal Is Complete==
 
==When Resource Proposal Is Complete==
 
'''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 14:50, 21 August 2017



ActivityDefinition

The ActivityDefinition defines a template for the creation of intent resources (such as requests, plans, or proposals). The structure contains generic information that can be applied to any intent resource, as well as some specific structures to support the definition of more complex activities such as MedicationRequest.

The resource can be used independently, but it can also be combined with multiple definitions using the PlanDefinition resource to describe order sets, protocols, or decision support rules.

The intent of the resource is to provide reusable activity definitions to enable automated sharing of knowledge artifacts such as order sets, protocols, and decision support rules.


Owning committee name

Clinical Decision Support Work Group

Committee Approval Date:

  • Resource Proposal: 2016-07-06
  • STU3 Ballot Submission: 2016-08-03

Contributing or Reviewing Work Groups

FHIR Resource Development Project Insight ID

1234: FHIR-Based Clinical Quality Framework (CQF-on-FHIR)

Scope of coverage

An ActivityDefinition is a knowledge artifact that enables the representation and sharing of pre-defined templates for intent resources. It differs from the intent resources in that it is not specific to a given patient or particular type of resource, rather it defines a template for constructing a specific intent resource for a patient.

ActivityDefinitions can be used both within and between healthcare delivery environments, both as part of a catalog, as well as by content providers for sharing and distribution of activity templates.

The resource is flexible enough to be used to describe activity definitions for any discipline and locale, as well as for any resource type. The structure is generally high-level and conceptual, though it does contain specific structures for more complex intent resources such as MedicationOrder. As these more specific types are introduced, it may make sense to break the resource into several more specific resources.

RIM scope

Resource appropriateness

The notion of a "template" for a clinical activity is an important aspect of describing and sharing clinical knowledge. The concept appears in multiple settings and the resource should be general to handle a broad variety of use cases. In particular, the concept is key to modeling protocols, order sets, and decision support rules.

Expected implementations

Motive Medical Cognitive Medical NCCN Plexina

Content sources

Example Scenarios

The resource will be used for the same example scenarios as the PlanDefinition resource, namely:

Low Suicide Risk

When assessing a patient for suicide risk, the actions that should be taken as a result of the assessment is defined as an order set.

Obesity Determination Protocol

Example of A medical algorithm for assessment and treatment of overweight and obesity

Research Protocols

Clinical trials and other types of research specify protocols to ensure the research produces valid data. The resource can be used to specify actions to be taken in the clinical trial.

Resource Relationships

This resource will make use of the Library resource to represent any logic involved in defining the behavior of the plan definition.

This resource will also be referenced by the PlanDefinition resource to represent the target of each action within the plan definition.

Timelines

September 2016 Ballot Cycle in support of the CQF IG.

gForge Users

brynrhodes

When Resource Proposal Is Complete

When you have completed your proposal, please send an email to FMGcontact@HL7.org