- COMPANION SLIDE DECK that aligns with outline. August2021_CodeSystemIdentifierBoF.pptx September BoF Poll Questions.pptx
- Purpose of Webinar/Background - Why are we presenting this material
- The Art of Vocabulary in Implementation Guides, Profiles or Resources
- CodeSystem (cc: go find official definitions)
- Internal
- External
- ValueSet
- Concepts (this will not be discussed)
- Concept Map (this will not be discussed)
- Not talking about binding strength (there will be a separate webinar)
- Acronyms - Define
- UTG, THO, UP, HSRC, HTA
- UTG is the project initiated to get us to a new process
- UTG
- Remind people of UTG, why it was created, when it was announced, when it went live, etc.
- Problem it was designed to solve
- Fragmented sources of terminology content, difficult to discover
- Terminology review (harmonization) bound to ballot cycle (V3, CDA)
- Minimal FHIR terminology review outside of ballot comments
- Dependent on ballot commenters, some of whom do not review terminology artifacts
- Shifting responsibility to IG authors/team, sponsoring work groups
- Contact voters, etc.
- Unfortunately not streamlined at this point
- Provide a reference to the V3 harmonization process which was replaced by UTG
- Solution
- PSS approved 2016
- ONC funded
- Create a consensus, continual process to manage terminology change
- UP JIRA project
- Point to the documentation (submitters, reviewers, approvers)
- Note the videos are out of date
- Create THO to be the single source of truth for HL7 terminology
- Imported V2, CoreMIF, some of FHIR terminology
- FHIR Structural/ballot bound terminology is not in THO (provide an example)
- Required bindings to code datatype elements
- Benefits
- Most HL7 terminology in one place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- 7/19/2021: can't remember the point of this bullet, ask Frank and Mary Kay
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Unify terminology process across all product families
- Unify content (ObservationInterpretation)
- Exposing stale content that should be updated or replaced or retired
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- PresentOnAdmission
- Moving forward - prevent chaos - not attempting to fix existing situation
- However, in some cases, work groups and Accelerators are fixing what needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- What THO IS NOT!
- Not a terminology server
- The THO Code Systems contents are in tx.fhir.org
- We have to ask GG to confirm what from THO is in tx.fhir.org. Ted Kleinmight know
- Optionally THO Code Systems in the CI build may be in tx.fhir.org
- Does not make CodeSystem version information available (internal and external) (check - need to be careful with an example) (can't look up a CPT code from 2 years ago)
- Example from MK - demonstrating where example codes are used
- http://hl7.org/fhir/ValueSet/claim-careteamrole - all codes drawn from ClaimCareTeamRoleCodes
- http://terminology.hl7.org/CodeSystem/claimcareteamrole
- Example codes, clearly noted. Used in multiple IGs.
- Ended up in the CARIN-BB IG as the codes to use
- http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInstitutionalCareTeamRole
- bound with required binding strength to EOB role code
- http://hl7.org/fhir/us/carin-bb/STU1/StructureDefinition-C4BB-ExplanationOfBenefit-Inpatient-Institutional.html
- Second example?
- CodeSystem Types
- External:
- Content is managed by some organization other than HL7
- Follows HTA process (see previous webinar/education session)
- Example: SNOMED CT, LOINC, CPT, HCPCS
- Internal:
- Content is managed by HL7
- UTG, THO, Specification
- Two types of internal code systems
- Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Status
- Codes whose change management is not bound to ballot cycle
- ObservationInterpretation
- Example
- Do we need to describe Example Code System
- Why create?
- FHIR core spec requirements (can't reference proprietary codes)
- No known code system covers the domain
- Provides guidance to implementers
- Expectations for use
- Example codes that will never and should never be used in a production system
- Example codes that may be used in a production system
- Using CodeSystems
- You need to reference coded concepts in your IG/resource/profile
- Most likely need to reference a CodeSystem
- Look for a source for your concepts (define concept & code, and the difference)
- Preference: Use a CodeSystem where the CodeSystem identifier is in THO
- Exception: Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Use the identifier as defined in THO
- Check published version and CI build
- If you can't use a CodeSystem where the identifier is in THO, (walk through the flow chart)
- External:
- HTA process
- Acknowledge we're in a transition phase
- Timing is critical, start the process as soon as you are sure you will use concepts from an external code system
- Pull in suggested process places for the HTA process
- Must engage HTA to obtain a url/identifier for an external code system - do not make one up
- JIRA, and email?
- HTA process overview
- Contact the owner
- If no response after X days/weeks, assign an identifier/url
- Supply metadata, create an HTA page, establish the CodeSystem identifier and metadata in THO
- temporary url assignment
- Internal
- terminology.hl7.org - engage with the UTG Process
- Before ballot: Identifier/NamingSystem in THO (UTG process - pending Code System notification)
- Pro-forma code system request
- Before publish: Content in THO, UTG request
- Example
- last resort
- When in doubt -
- What do you do? Who do you call? UTG ticket; contact Vocab Co-chairs Zulip Terminology Track
- Benefits
- All HL7 terminology in place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- Notify community
- Encourage people to sign up for JIRA notifications (not sure this is a smooth process now - would have to sign up for notifications)
- Moving forward - prevent chaos - not attempting to fix existing mess
- Fixing only what absolutely needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- Identifier Systems
- Removed from the FHIR spec in R5
- https://www.hl7.org/fhir/identifier-registry.html
- Brought into the UTG process
- In THO
- Examples: Social Security Number, Driver's License Numbers,
- HTA is not going to manage the process for assigning identifiers for identifier systems
- This may become part of the TSMG responsibilities?
- Will be removed from the FHIR specification
- Straighten out the IdentifierSystems, define them,
- https://www.hl7.org/fhir/v2/0203/index.html#SB
- is being used as the system value for an identifier (are these identifier systems?)
- Value Sets
- terminology.hl7.org
- Plug for the UTG education materials, join the meetings
- Other misc. documentation
- How to make sure people move forward with the right stuff, rather than copying incorrect stuff from prior publications? (e.g. NUBC PresentOnAdmission)
- Reporting issues: UTG, waiting for input status. (we would need to create a dashboard.....)
- Review FHIR Code System page Policy for terminology in FHIR IGs
- This info has a slightly different topic than the CodeSystem identifier focus for this team -
- Polls during the webinar
- Before and after
- What is THO,
- Where do you request a CodeSystem identifer for an external code system
- When did the UTG project start?
- Who worked on the UTG project
- Incorporate this material into the FHIR certification
- COMPANION SLIDE DECK that aligns with outline. August2021_CodeSystemIdentifierBoF.pptx
- Purpose of Webinar/Background - Why are we presenting this material
- The Art of Vocabulary in Implementation Guides, Profiles or Resources
- CodeSystem (cc: go find official definitions)
- Internal
- External
- ValueSet
- Concepts (this will not be discussed)
- Concept Map (this will not be discussed)
- Not talking about binding strength (there will be a separate webinar)
- Acronyms - Define
- UTG, THO, UP, HSRC, HTA
- UTG is the project initiated to get us to a new process
- UTG
- Remind people of UTG, why it was created, when it was announced, when it went live, etc.
- Problem it was designed to solve
- Fragmented sources of terminology content, difficult to discover
- Terminology review (harmonization) bound to ballot cycle (V3, CDA)
- Minimal FHIR terminology review outside of ballot comments
- Dependent on ballot commenters, some of whom do not review terminology artifacts
- Shifting responsibility to IG authors/team, sponsoring work groups
- Contact voters, etc.
- Unfortunately not streamlined at this point
- Provide a reference to the V3 harmonization process which was replaced by UTG
- Solution
- PSS approved 2016
- ONC funded
- Create a consensus, continual process to manage terminology change
- UP JIRA project
- Point to the documentation (submitters, reviewers, approvers)
- Note the videos are out of date
- Create THO to be the single source of truth for HL7 terminology
- Imported V2, CoreMIF, some of FHIR terminology
- FHIR Structural/ballot bound terminology is not in THO (provide an example)
- Required bindings to code datatype elements
- Benefits
- Most HL7 terminology in one place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- 7/19/2021: can't remember the point of this bullet, ask Frank and Mary Kay
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Unify terminology process across all product families
- Unify content (ObservationInterpretation)
- Exposing stale content that should be updated or replaced or retired
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- PresentOnAdmission
- Moving forward - prevent chaos - not attempting to fix existing situation
- However, in some cases, work groups and Accelerators are fixing what needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- What THO IS NOT!
- Not a terminology server
- The THO Code Systems contents are in tx.fhir.org
- We have to ask GG to confirm what from THO is in tx.fhir.org. Ted Kleinmight know
- Optionally THO Code Systems in the CI build may be in tx.fhir.org
- Does not make CodeSystem version information available (internal and external) (check - need to be careful with an example) (can't look up a CPT code from 2 years ago)
- Example from MK - demonstrating where example codes are used
- http://hl7.org/fhir/ValueSet/claim-careteamrole - all codes drawn from ClaimCareTeamRoleCodes
- http://terminology.hl7.org/CodeSystem/claimcareteamrole
- Example codes, clearly noted. Used in multiple IGs.
- Ended up in the CARIN-BB IG as the codes to use
- http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInstitutionalCareTeamRole
- bound with required binding strength to EOB role code
- http://hl7.org/fhir/us/carin-bb/STU1/StructureDefinition-C4BB-ExplanationOfBenefit-Inpatient-Institutional.html
- Second example?
- CodeSystem Types
- External:
- Content is managed by some organization other than HL7
- Follows HTA process (see previous webinar/education session)
- Example: SNOMED CT, LOINC, CPT, HCPCS
- Internal:
- Content is managed by HL7
- UTG, THO, Specification
- Two types of internal code systems
- Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Status
- Codes whose change management is not bound to ballot cycle
- ObservationInterpretation
- Example
- Do we need to describe Example Code System
- Why create?
- FHIR core spec requirements (can't reference proprietary codes)
- No known code system covers the domain
- Provides guidance to implementers
- Expectations for use
- Example codes that will never and should never be used in a production system
- Example codes that may be used in a production system
- Using CodeSystems
- You need to reference coded concepts in your IG/resource/profile
- Most likely need to reference a CodeSystem
- Look for a source for your concepts (define concept & code, and the difference)
- Preference: Use a CodeSystem where the CodeSystem identifier is in THO
- Exception: Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Use the identifier as defined in THO
- Check published version and CI build
- If you can't use a CodeSystem where the identifier is in THO, (walk through the flow chart)
- External:
- HTA process
- Acknowledge we're in a transition phase
- Timing is critical, start the process as soon as you are sure you will use concepts from an external code system
- Pull in suggested process places for the HTA process
- Must engage HTA to obtain a url/identifier for an external code system - do not make one up
- JIRA, and email?
- HTA process overview
- Contact the owner
- If no response after X days/weeks, assign an identifier/url
- Supply metadata, create an HTA page, establish the CodeSystem identifier and metadata in THO
- temporary url assignment
- Internal
- terminology.hl7.org - engage with the UTG Process
- Before ballot: Identifier/NamingSystem in THO (UTG process - pending Code System notification)
- Pro-forma code system request
- Before publish: Content in THO, UTG request
- Example
- last resort
- When in doubt -
- What do you do? Who do you call? UTG ticket; contact Vocab Co-chairs Zulip Terminology Track
- Benefits
- All HL7 terminology in place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- Notify community
- Encourage people to sign up for JIRA notifications (not sure this is a smooth process now - would have to sign up for notifications)
- Moving forward - prevent chaos - not attempting to fix existing mess
- Fixing only what absolutely needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- Identifier Systems
- Removed from the FHIR spec in R5
- https://www.hl7.org/fhir/identifier-registry.html
- Brought into the UTG process
- In THO
- Examples: Social Security Number, Driver's License Numbers,
- HTA is not going to manage the process for assigning identifiers for identifier systems
- This may become part of the TSMG responsibilities?
- Will be removed from the FHIR specification
- Straighten out the IdentifierSystems, define them,
- https://www.hl7.org/fhir/v2/0203/index.html#SB
- is being used as the system value for an identifier (are these identifier systems?)
- Value Sets
- terminology.hl7.org
- Plug for the UTG education materials, join the meetings
- Other misc. documentation
- How to make sure people move forward with the right stuff, rather than copying incorrect stuff from prior publications? (e.g. NUBC PresentOnAdmission)
- Reporting issues: UTG, waiting for input status. (we would need to create a dashboard.....)
- Review FHIR Code System page Policy for terminology in FHIR IGs
- This info has a slightly different topic than the CodeSystem identifier focus for this team -
- Polls during the webinar
- Before and after
- What is THO,
- Where do you request a CodeSystem identifer for an external code system
- When did the UTG project start?
- Who worked on the UTG project
- Incorporate this material into the FHIR certification
- COMPANION SLIDE DECK that aligns with outline. August2021_CodeSystemIdentifierBoF.pptx
- Purpose of Webinar/Background - Why are we presenting this material
- The Art of Vocabulary in Implementation Guides, Profiles or Resources
- CodeSystem (cc: go find official definitions)
- Internal
- External
- ValueSet
- Concepts (this will not be discussed)
- Concept Map (this will not be discussed)
- Not talking about binding strength (there will be a separate webinar)
- Acronyms - Define
- UTG, THO, UP, HSRC, HTA
- UTG is the project initiated to get us to a new process
- UTG
- Remind people of UTG, why it was created, when it was announced, when it went live, etc.
- Problem it was designed to solve
- Fragmented sources of terminology content, difficult to discover
- Terminology review (harmonization) bound to ballot cycle (V3, CDA)
- Minimal FHIR terminology review outside of ballot comments
- Dependent on ballot commenters, some of whom do not review terminology artifacts
- Shifting responsibility to IG authors/team, sponsoring work groups
- Contact voters, etc.
- Unfortunately not streamlined at this point
- Provide a reference to the V3 harmonization process which was replaced by UTG
- Solution
- PSS approved 2016
- ONC funded
- Create a consensus, continual process to manage terminology change
- UP JIRA project
- Point to the documentation (submitters, reviewers, approvers)
- Note the videos are out of date
- Create THO to be the single source of truth for HL7 terminology
- Imported V2, CoreMIF, some of FHIR terminology
- FHIR Structural/ballot bound terminology is not in THO (provide an example)
- Required bindings to code datatype elements
- Benefits
- Most HL7 terminology in one place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- 7/19/2021: can't remember the point of this bullet, ask Frank and Mary Kay
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Unify terminology process across all product families
- Unify content (ObservationInterpretation)
- Exposing stale content that should be updated or replaced or retired
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- PresentOnAdmission
- Moving forward - prevent chaos - not attempting to fix existing situation
- However, in some cases, work groups and Accelerators are fixing what needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- What THO IS NOT!
- Not a terminology server
- The THO Code Systems contents are in tx.fhir.org
- We have to ask GG to confirm what from THO is in tx.fhir.org. Ted Kleinmight know
- Optionally THO Code Systems in the CI build may be in tx.fhir.org
- Does not make CodeSystem version information available (internal and external) (check - need to be careful with an example) (can't look up a CPT code from 2 years ago)
- Example from MK - demonstrating where example codes are used
- http://hl7.org/fhir/ValueSet/claim-careteamrole - all codes drawn from ClaimCareTeamRoleCodes
- http://terminology.hl7.org/CodeSystem/claimcareteamrole
- Example codes, clearly noted. Used in multiple IGs.
- Ended up in the CARIN-BB IG as the codes to use
- http://hl7.org/fhir/us/carin-bb/ValueSet/C4BBClaimInstitutionalCareTeamRole
- bound with required binding strength to EOB role code
- http://hl7.org/fhir/us/carin-bb/STU1/StructureDefinition-C4BB-ExplanationOfBenefit-Inpatient-Institutional.html
- Second example?
- CodeSystem Types
- External:
- Content is managed by some organization other than HL7
- Follows HTA process (see previous webinar/education session)
- Example: SNOMED CT, LOINC, CPT, HCPCS
- Internal:
- Content is managed by HL7
- UTG, THO, Specification
- Two types of internal code systems
- Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Status
- Codes whose change management is not bound to ballot cycle
- ObservationInterpretation
- Example
- Do we need to describe Example Code System
- Why create?
- FHIR core spec requirements (can't reference proprietary codes)
- No known code system covers the domain
- Provides guidance to implementers
- Expectations for use
- Example codes that will never and should never be used in a production system
- Example codes that may be used in a production system
- Using CodeSystems
- You need to reference coded concepts in your IG/resource/profile
- Most likely need to reference a CodeSystem
- Look for a source for your concepts (define concept & code, and the difference)
- Preference: Use a CodeSystem where the CodeSystem identifier is in THO
- Exception: Codes whose change management is bound to ballot cycle (aka structural codes, ballot bound codes)
- Use the identifier as defined in THO
- Check published version and CI build
- If you can't use a CodeSystem where the identifier is in THO, (walk through the flow chart)
- External:
- HTA process
- Acknowledge we're in a transition phase
- Timing is critical, start the process as soon as you are sure you will use concepts from an external code system
- Pull in suggested process places for the HTA process
- Must engage HTA to obtain a url/identifier for an external code system - do not make one up
- JIRA, and email?
- HTA process overview
- Contact the owner
- If no response after X days/weeks, assign an identifier/url
- Supply metadata, create an HTA page, establish the CodeSystem identifier and metadata in THO
- temporary url assignment
- Internal
- terminology.hl7.org - engage with the UTG Process
- Before ballot: Identifier/NamingSystem in THO (UTG process - pending Code System notification)
- Pro-forma code system request
- Before publish: Content in THO, UTG request
- Example
- last resort
- When in doubt -
- What do you do? Who do you call? UTG ticket; contact Vocab Co-chairs Zulip Terminology Track
- Benefits
- All HL7 terminology in place (moon or mars landing)
- IG authors, implementers have one place to go to find terminology
- Connectathon for terminology, test it out, community consensus
- Saves time (reduce duplicative work/code systems), saves aggravation, enhance relationships with external code system owners, IP respect
- Move terminology review earlier in the process, collaborative, get community feedback, crowd sourcing
- Notify community
- Encourage people to sign up for JIRA notifications (not sure this is a smooth process now - would have to sign up for notifications)
- Moving forward - prevent chaos - not attempting to fix existing mess
- Fixing only what absolutely needs to be fixed
- Changing CodeSystem identifiers **
- Enable change management-
- change is inevitable -
- minimize impact
- Provide an example of name changes, url changes (UCUM?)
- NamingSystem clearly documents CodeSystem identifiers, their life cycle, and important metadata
- Identifier Systems
- Removed from the FHIR spec in R5
- https://www.hl7.org/fhir/identifier-registry.html
- Brought into the UTG process
- In THO
- Examples: Social Security Number, Driver's License Numbers,
- HTA is not going to manage the process for assigning identifiers for identifier systems
- This may become part of the TSMG responsibilities?
- Will be removed from the FHIR specification
- Straighten out the IdentifierSystems, define them,
- https://www.hl7.org/fhir/v2/0203/index.html#SB
- is being used as the system value for an identifier (are these identifier systems?)
- Value Sets
- terminology.hl7.org
- Plug for the UTG education materials, join the meetings
- Other misc. documentation
- How to make sure people move forward with the right stuff, rather than copying incorrect stuff from prior publications? (e.g. NUBC PresentOnAdmission)
- Reporting issues: UTG, waiting for input status. (we would need to create a dashboard.....)
- Review FHIR Code System page Policy for terminology in FHIR IGs
- This info has a slightly different topic than the CodeSystem identifier focus for this team -
- Polls during the webinar
- Before and after
- What is THO,
- Where do you request a CodeSystem identifer for an external code system
- When did the UTG project start?
- Who worked on the UTG project
- Incorporate this material into the FHIR certification
{"serverDuration": 273, "requestCorrelationId": "c6c2eb27a2cec020"}