This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Immunization FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(initial draft)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
<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 12: Line 12:
  
  
=immunization=
+
=Immunization=
  
 
<!-- Resource names should meet the following characteristics:
 
<!-- Resource names should meet the following characteristics:
* Lower camel case
+
* Upper camel case
 
* U.S. English
 
* U.S. English
 
* Domain-friendly
 
* Domain-friendly
Line 37: Line 37:
  
 
==Scope of coverage==
 
==Scope of coverage==
Administration of vaccines to patients across all healthcare disciplines in all care settings and all regions.
+
Administration of vaccines to patients across all healthcare disciplines in all care settings and all regions.  Includes immunization of both humans and animals.
 +
 
 +
Does not include the administration of non-vaccine agents, even those that may have or claim immunological effects.
  
 
<!-- 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%"
 
<!-- 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%"
Line 83: Line 85:
  
 
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? -->
 +
 +
==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.) -->
  
 
==Resource Relationships==
 
==Resource Relationships==
 
This resource references the following resources:
 
This resource references the following resources:
*adversereaction
+
*AdverseReaction
*patient
+
*Patient
*practioner
+
*Practioner
*location
+
*Location
  
At this point there has not been a determination of which resources would reference the immunization resource.
+
This resource is referenced by the ImmunizationProfile resource.
  
 
<!-- What are the resources do you expect will reference this resource and in what context?
 
<!-- What are the resources do you expect will reference this resource and in what context?
Line 111: Line 117:
  
 
<!-- 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.) -->
 +
 +
==Issues==
 +
* Is the definition of what constitutes a vaccine clearly defined?  I.e. No possibility of confusion
 +
* Need to provide specific RIM constraints.  Referencing an RMIM doesn't identify what's necessary or sufficient.
 +
* Need to fill in the "example scenarios" section

Latest revision as of 05:42, 22 May 2014



Immunization

Owning committee name

Public_Health_and_Emergency_Response_work_group_(PHER)

Contributing or Reviewing Work Groups

None

FHIR Resource Development Project Insight ID

967

Scope of coverage

Administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. Includes immunization of both humans and animals.

Does not include the administration of non-vaccine agents, even those that may have or claim immunological effects.


RIM scope

The immunization resource corresponds to the RIM Act of Substance Administration (SBADM) as constrained in the Immunization Domain model POIZ_RM030050UV.


Resource appropriateness

The immunization resource is expected to cover key concepts related to the creation, revision and querying of a patient's immunization history. This resource - through consultation with the PHER work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v2.x immunization implementation guide, HL7 v3 POIZ domain and Immunization Domain Analysis Model.

Expected implementations

TBD


Content sources

  • HL7 v2.x immunization implementation guides
  • Normative HL7 v3 POIZ domain
  • HL7 Immunization Domain Analysis Model


Example Scenarios

Resource Relationships

This resource references the following resources:

  • AdverseReaction
  • Patient
  • Practioner
  • Location

This resource is referenced by the ImmunizationProfile resource.


Timelines

Expected to be part of the September 2013 DSTU ballot.


gForge Users

jmadra


Issues

  • Is the definition of what constitutes a vaccine clearly defined? I.e. No possibility of confusion
  • Need to provide specific RIM constraints. Referencing an RMIM doesn't identify what's necessary or sufficient.
  • Need to fill in the "example scenarios" section