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

Difference between revisions of "Substance FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
 
(13 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 an [[: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:
  
  
−
=putProposedResourceNameHere=
+
=Substance=
−
 
 
−
<!-- 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==
  
−
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the resources. -->
+
[[Orders & Observations WG]]
−
[[YourCommitteeName]]
 
  
 
==Interested Work Groups==
 
==Interested Work Groups==
  
−
<!-- Additional work groups that may have an interest in assisting with the content of the resource (optional) -->
+
* Anatomic Pathology
−
* Work Group Name
+
* Clinical Genomics
−
* or link
+
* Imaging Integration
−
* or "None"
+
* Pharmacy
 +
* Public Health and Emergency Response
  
 
==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 -->
+
952
  
 
==Scope of coverage==
 
==Scope of coverage==
Line 55: Line 42:
 
As a rule, resources should encompass all of these aspects.
 
As a rule, resources should encompass all of these aspects.
 
  -->
 
  -->
 +
 +
DEFINITION (SUBSTANCE):
 +
This resource will cover data elements, structures and relationships required to uniquely define and identify substances and specified substances within medicinal products or used for medicinal purposes, dietary supplements, food and feed additives, cosmetics, etc.
 +
 +
Any material is a substance.  Substances come in a wide variety of physical forms and can pass through different states (ie. Gas, liquid, solid) while still retaining their physical composition and material characteristics.
 +
 +
Examples: Pharmaceutical substances, disposable supplies, durable equipment, implantable devices, food items, waste, traded goods
 +
 +
Substance is used when the focus is the material as opposed to the source of the material and the processing done on it - in which case Specimen is more appropriate.
  
 
==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. -->
 +
Entity: Material (EntityClass="MAT")
  
 
==Resource appropriateness==
 
==Resource appropriateness==
Line 74: Line 71:
 
* 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  
 
  -->
 
  -->
 +
In healthcare, substances are used to treat patients, substances are analyzed for diagnostic, treatment, and research, subjects come in contact with certain substance thereby causing a need for healthcare, and so forth.
  
 
==Expected implementations==
 
==Expected implementations==
  
 
<!-- For resources not deemed "key", what interest is there by implementers in using this particular resource.  (Should ideally have multiple independent implementations) -->
 
<!-- For resources not deemed "key", what interest is there by implementers in using this particular resource.  (Should ideally have multiple independent implementations) -->
 +
 +
Commonly as part of the use of other resources - such as MedicationPrescription or MedicationAdministration. A substance might also be related to dietary observations or adverse reactions.
  
 
==Content sources==
 
==Content sources==
Line 84: Line 84:
  
 
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? -->
 +
 +
*HL7 v3 Laboratory Standard - Normative
 +
*HL7 v3 IDMP Standard
 +
*HL7 v2.x
 +
*openEhr archetypes
 +
 +
==Example Scenarios==
 +
* A person believes that their hayfever is an allergy to pollen. An allergy test is performed using a number of different substances to determine if there is a specific cause.
 +
* A clinician has a specific 'recipe' for a wart treatment. This involves the creation of a solution form a number of different substances, not all of which are coded in commonly user terminologies.
 +
  
 
==Resource Relationships==
 
==Resource Relationships==
Line 95: Line 105:
 
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)
 
  -->
 
  -->
 +
*Order
 +
*DiagnosticOrder
 +
*DiagnosticReport
 +
*ImagingStudy
 +
*Medication
 +
*Supply
 +
*Device
 +
*AdverseReaction
  
 
==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 -->
 +
 +
*Approved by OO WG: May 2013 WGM
 +
*Planned Ballot: 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.) -->
 +
*Lorraine Constable
 +
*Patrick Loyd
 +
 +
==Issues==
 +
* Scope Challenge: When to use substance vs medication.  Medication is a subtype of substance.  Also need to come up with better differentiation between this and Specimen
 +
* Need explanation of relations to other resources

Latest revision as of 05:51, 22 May 2014

OpenHotTopic.GIF

This page documents an Approved FHIR Resource Proposal



Substance

Owning committee name

Orders & Observations WG

Interested Work Groups

  • Anatomic Pathology
  • Clinical Genomics
  • Imaging Integration
  • Pharmacy
  • Public Health and Emergency Response

FHIR Resource Development Project Insight ID

952

Scope of coverage

DEFINITION (SUBSTANCE): This resource will cover data elements, structures and relationships required to uniquely define and identify substances and specified substances within medicinal products or used for medicinal purposes, dietary supplements, food and feed additives, cosmetics, etc.

Any material is a substance. Substances come in a wide variety of physical forms and can pass through different states (ie. Gas, liquid, solid) while still retaining their physical composition and material characteristics.

Examples: Pharmaceutical substances, disposable supplies, durable equipment, implantable devices, food items, waste, traded goods

Substance is used when the focus is the material as opposed to the source of the material and the processing done on it - in which case Specimen is more appropriate.

RIM scope

Entity: Material (EntityClass="MAT")

Resource appropriateness

In healthcare, substances are used to treat patients, substances are analyzed for diagnostic, treatment, and research, subjects come in contact with certain substance thereby causing a need for healthcare, and so forth.

Expected implementations

Commonly as part of the use of other resources - such as MedicationPrescription or MedicationAdministration. A substance might also be related to dietary observations or adverse reactions.

Content sources

  • HL7 v3 Laboratory Standard - Normative
  • HL7 v3 IDMP Standard
  • HL7 v2.x
  • openEhr archetypes

Example Scenarios

  • A person believes that their hayfever is an allergy to pollen. An allergy test is performed using a number of different substances to determine if there is a specific cause.
  • A clinician has a specific 'recipe' for a wart treatment. This involves the creation of a solution form a number of different substances, not all of which are coded in commonly user terminologies.


Resource Relationships

  • Order
  • DiagnosticOrder
  • DiagnosticReport
  • ImagingStudy
  • Medication
  • Supply
  • Device
  • AdverseReaction

Timelines

  • Approved by OO WG: May 2013 WGM
  • Planned Ballot: September 2013

gForge Users

  • Lorraine Constable
  • Patrick Loyd

Issues

  • Scope Challenge: When to use substance vs medication. Medication is a subtype of substance. Also need to come up with better differentiation between this and Specimen
  • Need explanation of relations to other resources
Retrieved from "https://wiki.hl7.org/w/index.php?title=Substance_FHIR_Resource_Proposal&oldid=86971"