This wiki has undergone a migration to Confluence found Here

Difference between revisions of "CodeSystem FHIR Resource Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:FHIR Resource Proposal}}")
 
Line 13: Line 13:
  
  
=PutProposedResourceNameHere=
+
=CodeSystem=
 
 
<!-- 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. -->
+
[[Vocabulary]]
[[YourCommitteeName]]
 
  
 
==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) -->
+
* FHIR-Infrastructure
* Work Group Name
 
* 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 -->
+
Pending
  
 
==Scope of coverage==
 
==Scope of coverage==
  
<!-- 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%"
+
The code system resource has the contents of ValueSet.codeSystem, which will be removed once the resource is adopted. The main change, therefore, is moving code system from being inlined in value set to being it's own first class resource. In addition, the scope of the code system representation expands:
  
Scope should consider numerous aspects of breadth of scope, including:
+
* define the kind of filters that are supported by the code system (to allow smarter value set editing)
* Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)
+
* define the kind of properties that the code system defines, and provide properties for the concepts
* 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.
+
As for implementation scope: this is a universal infrastructure piece in a well understood domain (consistent with the v3 core principles, and the basic CTS 2 definitions)
-->
+
 
 +
Note that the scope does not include code system maintenance, only publishing the details of a code system (with or without the actual content)
  
 
==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. -->
+
out of scope for the RIM
  
 
==Resource appropriateness==
 
==Resource appropriateness==
  
<!-- Does the resource meet the following characteristics?
+
Codesystem:
 
 
Must
 
 
* Represents a well understood, "important" concept in the business of healthcare
 
* Represents a well understood, "important" concept in the business of healthcare
 
* Represents a concept expected to be tracked with distinct, reliable, unique ids
 
* Represents a concept expected to be tracked with distinct, reliable, unique ids
* Reasonable for the resource to be independently created, queried and maintained
+
* it is Reasonable for the resource to be independently created, queried and maintained
 
+
* is already widely the subject of exchange and part of the value set resource
Should
+
* is expected to contain an appropriate number of "core" (non-extension) data elements  
* Declared interest in need for standardization of data exchange</span>
+
* has the characteristics of high cohesion & low coupling, and is level 0 (infrastructure)
* 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. -->
+
All the terminology services, and the build tool, will all have to support the code system resource
  
 
==Content sources==
 
==Content sources==
  
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
+
* ValueSet
 +
* CTS 2
 +
* Core principles
 +
* VSD
 +
* implementer feedback about ValueSet.codeSystem
  
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==
  
<!-- What are the resources do you expect will reference this resource and in what context?
+
Resources that will reference CodeSystem:
 +
* ValueSet will reference this resource by canonical URL
 +
* the Coding data type references this resource implicitly by canonical URL
 +
* implementationGuide will reference this resource explicitly for publishing purposes
  
What resources do you expect this resource reference and in what context?
+
The creation of the CodeSystem resource will change the use of NamingSystem resource, since all of it's functionality related to code systems should now be moved to CodeSystem. This resource name should be changed to 'IdentifierSystem' and it's definition tightened accordingly.
  
Note: These may be existing resources or "expected" resource
+
==Timelines==
 
 
Reference to resources is really only relevant at the "same or higher level" (Bo – fix this wording)
 
-->
 
  
==Timelines==
+
Target to trail the resource in the may 2016 connectathon, and to ballot it for DSTU3
  
<!-- Indicate the target date for having the resource complete from a committee perspective and ready for vetting and voting -->
 
  
 
==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.) -->
+
* Grahame Grieve
 +
* Rob Hausam

Revision as of 23:41, 28 January 2016



CodeSystem

Owning committee name

Vocabulary

Contributing or Reviewing Work Groups

  • FHIR-Infrastructure

FHIR Resource Development Project Insight ID

Pending

Scope of coverage

The code system resource has the contents of ValueSet.codeSystem, which will be removed once the resource is adopted. The main change, therefore, is moving code system from being inlined in value set to being it's own first class resource. In addition, the scope of the code system representation expands:

  • define the kind of filters that are supported by the code system (to allow smarter value set editing)
  • define the kind of properties that the code system defines, and provide properties for the concepts

As for implementation scope: this is a universal infrastructure piece in a well understood domain (consistent with the v3 core principles, and the basic CTS 2 definitions)

Note that the scope does not include code system maintenance, only publishing the details of a code system (with or without the actual content)

RIM scope

out of scope for the RIM

Resource appropriateness

Codesystem:

  • Represents a well understood, "important" concept in the business of healthcare
  • Represents a concept expected to be tracked with distinct, reliable, unique ids
  • it is Reasonable for the resource to be independently created, queried and maintained
  • is already widely the subject of exchange and part of the value set resource
  • is expected to contain an appropriate number of "core" (non-extension) data elements
  • has the characteristics of high cohesion & low coupling, and is level 0 (infrastructure)

Expected implementations

All the terminology services, and the build tool, will all have to support the code system resource

Content sources

  • ValueSet
  • CTS 2
  • Core principles
  • VSD
  • implementer feedback about ValueSet.codeSystem


Resource Relationships

Resources that will reference CodeSystem:

  • ValueSet will reference this resource by canonical URL
  • the Coding data type references this resource implicitly by canonical URL
  • implementationGuide will reference this resource explicitly for publishing purposes

The creation of the CodeSystem resource will change the use of NamingSystem resource, since all of it's functionality related to code systems should now be moved to CodeSystem. This resource name should be changed to 'IdentifierSystem' and it's definition tightened accordingly.

Timelines

Target to trail the resource in the may 2016 connectathon, and to ballot it for DSTU3


gForge Users

  • Grahame Grieve
  • Rob Hausam