Difference between revisions of "Immunization FHIR Resource Proposal"
(initial template creation) |
|||
(3 intermediate revisions by 2 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 | + | 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: | + | [[Category:Approved FHIR Resource Proposal]] |
Line 13: | Line 12: | ||
− | = | + | =Immunization= |
<!-- Resource names should meet the following characteristics: | <!-- Resource names should meet the following characteristics: | ||
− | * | + | * Upper camel case |
* U.S. English | * U.S. English | ||
* Domain-friendly | * Domain-friendly | ||
Line 28: | Line 27: | ||
==Owning committee name== | ==Owning committee name== | ||
− | |||
<!-- 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. --> | ||
− | [[ | + | [[Public_Health_and_Emergency_Response_work_group_(PHER)]] |
==Contributing or Reviewing Work Groups== | ==Contributing or Reviewing Work Groups== | ||
− | + | None | |
− | |||
− | |||
− | |||
− | |||
==FHIR Resource Development Project Insight ID== | ==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. | |
<!-- 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 57: | Line 53: | ||
==RIM scope== | ==RIM scope== | ||
+ | The immunization resource corresponds to the RIM Act of Substance Administration (SBADM) as constrained in the Immunization Domain model POIZ_RM030050UV. | ||
<!-- 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. --> | ||
− | ==Resource appropriateness== | + | ==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. | |
<!-- Does the resource meet the following characteristics? | <!-- Does the resource meet the following characteristics? | ||
Line 76: | Line 73: | ||
==Expected implementations== | ==Expected implementations== | ||
+ | TBD | ||
<!--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. --> | ||
==Content sources== | ==Content sources== | ||
+ | *HL7 v2.x immunization implementation guides | ||
+ | *Normative HL7 v3 POIZ domain | ||
+ | *HL7 Immunization Domain Analysis Model | ||
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult | <!-- 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? --> | 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: | ||
+ | *AdverseReaction | ||
+ | *Patient | ||
+ | *Practioner | ||
+ | *Location | ||
+ | |||
+ | 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 97: | Line 109: | ||
==Timelines== | ==Timelines== | ||
+ | Expected to be part of the September 2013 DSTU ballot. | ||
<!-- 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 --> | ||
==gForge Users== | ==gForge Users== | ||
+ | jmadra | ||
<!-- 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
Contents
- 1 Immunization
- 1.1 Owning committee name
- 1.2 Contributing or Reviewing Work Groups
- 1.3 FHIR Resource Development Project Insight ID
- 1.4 Scope of coverage
- 1.5 RIM scope
- 1.6 Resource appropriateness
- 1.7 Expected implementations
- 1.8 Content sources
- 1.9 Example Scenarios
- 1.10 Resource Relationships
- 1.11 Timelines
- 1.12 gForge Users
- 1.13 Issues
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