Common Terminology Services 2 CTS2

Submission Team Status UpdateHL7 Vocabulary Working Group

May 17, 2011

Goals

• Brief History• Review timeline and next steps• Specification layout and approach• HL7 Vocabulary Structures in CTS 2

– Code System, Concept, Concept Domain, Value Set, Binding

– HL7 Change Set

2© Copyright 2011, Mayo Clinic2011/05/17

History

Working through the HSSP Process…• Work actually began around 2006 in HL7• Issued by HL7 as a Service Functional Model (SFM) in

Fall 2009 – SFM• RFP issued by OMG 2010 • Preliminary submissions June 2010

– Mayo Clinic– II4SM

• Final submissions due May 23, 2011– For June OMG meeting

3© Copyright 2011, Mayo Clinic2011/05/17

Current Activities

Mayo working on completing, packaging and publishing documentation and examples

• Submit OMG CTS2 Revised Submission on May 23, 2011.

• Four weeks to provide minimal changes to the revised submission.

• Final Submission presented to OMG during Technical Meeting June 20 -24.

2011/05/17 © Copyright 2011, Mayo Clinic 4

OMG Timeline

5© Copyright 2011, Mayo Clinic

Event or Activity Date Purpose

Revised Submissions Due May 23, 2011 Submit final submission.

OMG Technical Meeting (Salt Lake City, UT) June 20-24, 2011To present final revised submission to OMG and obtain numerous votes.

Revised Submission Presentation June 20-24, 2011 Present CTS 2 final submission.

Final evaluation and selection by TF / Recommendation to AB and TC

June 20 and 23, 2011

OMG Process

TC Vote to recommend specification June 20, 2011 OMG Process

[Anticipated] Approval of recommendation by Architecture Board / Review by TC

June 23, 2011 OMG Process

Platform Technical Committee Adoption Vote

June 24, 2011

OMG Process

Assign Charter Finalization Task ForceFollowing the passing of the spec, a finalization task force is chartered (FTF) to address technical issues that arise from implementation feedback based upon the publicly available spec.

Publication of Beta Specification to OMG website July 2011 Specification available for implementers.

OMG Technical Meeting (Jacksonville, FL) September 10-14, 2012

Attend Healthcare DTF and Ontology PSIG meetings. Attend final vote by Board of Directors to adopt specification.

2011/05/17

Specification Layout

• Platform Independent Model (PIM)– (Very) formal specification– Purpose is to, as unambiguously as possible,

define the meaning and behavior (semantics) of any compliant implementation.

– View as the equivalent of a formal specification for implementing a language (C, Java, etc.)

2011/05/17 © Copyright 2011, Mayo Clinic 6

Specification Layout• REST PSM

– Based on “Representational State Transfer” (REST)– Basic model:

• Resources – one XML Schema per component• Functionality – mapping to URLs that accomplish all

functionality

• SOAP PSM– Web services. Same schema, but functionality is

invoked via SOAP procedure calls– Targeting cross platform federation (mix of REST

and SOAP nodes7© Copyright 2011, Mayo Clinic2011/05/17

Compliance

Resource orientation provides fine-grained implementation / compliance points

• Semantic Components – Which resources are represented by the service

• Functional Components - What functionality the service provides

8© Copyright 2011, Mayo Clinic2011/05/17

CTS2 Semantic Components

Code System Catalog– a catalog of terminologies, who publishes them, how often

Code System Version – information about code system releases

Entity Description – Concepts, textual definitions, terms (concept + description + language tables)

Association – formal concept / concept relationships (relationship and ancillary)

9© Copyright 2011, Mayo Clinic2011/05/17

CTS2 Semantic Components(continued)

Value Set Catalog– a catalog of value sets, their purpose, etc.

Value Set Definition – the formal rules for creating and resolving value sets

Map Catalog– a catalog of maps, their purpose, etc.

Map Version – map rules – based on a combination of the RF2 extended map model and GEM

10© Copyright 2011, Mayo Clinic2011/05/17

CTS2 Semantic Components(continued)

Concept Domain Catalog– a catalog of abstract data elements and their meanings.

Concept Domain Binding – the association of concept domains and value sets (w/ optional

Statement – the interface between RDF rendering and structured XML

11© Copyright 2011, Mayo Clinic2011/05/17

CTS2 Functional Components

• Read – retrieval by URI or primary identifier• Query – ability to construct queries and filters• Import/Export – import and export from

different formats such as RF2• Incremental Update – push/pull updates

across federated nodes• History – what happened and when• Temporal – what the service looked like on a

given date12© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Code System

• Core Principles Definition: “A Code System is a managed collection of Concept Representations, including codes, but sometimes more complex sets of rules and references, optionally including additional Concept Representations playing various roles including identifiers of the concepts, human-readable text, etc.”

13© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Code System

14© Copyright 2011, Mayo Clinic2011/05/17

class CodeSystem

AbstractResourceDescription

CodeSystem

codeSystemName: CodeSystemNamecodeSystemType: CodeSystemType [0..1]designedForOntologyTask: OntologyTaskReference [0..*]hasOntologyLanguage: OntologyLanguageReference [0..1]ontologyDomain: OntologyDomainReference [0..*]ontologyType: OntologyTypeReference [0..1]versions: CodeSystemDirectoryURI [0..1]::AbstractResourceDescriptionreleaseDocumentation: OpaqueData [0..1]releaseFormat: SourceAndNotation [0..*]::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

«enumeration»CodeSystemType

FOPLDL_ONTOLOGYTERMINOLOGYCLASSIFICATIONTHESAURUSTAXONOMYSUBJECT_HEADING_SYSTEMFLAT_CONCEPT_LIST

Refer to Sue Ellen Wright's KOS and DCR

class CodeSystemVersion

ResourceVersionDescription

CodeSystemVersion

associations: AssociationDirectoryURI [0..1]classes: EntityDirectoryURI [0..1]codeSystemVersionName: CodeSystemVersionNamedefaultLanguage: LanguageReference [0..1]entityDescriptions: EntityDirectoryURI [0..1]imports: CodeSystemVersionReference [0..*]individuals: EntityDirectoryURI [0..1]roles: EntityDirectoryURI [0..1]versionOf: CodeSystemReference::ResourceVersionDescriptiondocumentURI: DocumentURIofficialActivationDate: DateAndTime [0..1]officialReleaseDate: DateAndTime [0..1]officialResourceVersionId: String [0..1]predecessor: NameAndMeaningReference [0..1]sourceAndNotation: SourceAndNotation::Finalizablestate: FinalizableState::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

How do we handle partitioning? (Lloyd) - OID is the same Canadian or IHTSDO - distributed separately.

/imports0..*

HL7 Vocabulary Structures in CTS 2Concept

• Core Principles Definition: “A Concept is a unitary mental representation of a real or abstract thing – an atomic unit of thought. It should be unique in a given Code System.”

15© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Concept

16© Copyright 2011, Mayo Clinic2011/05/17

class EntityDescription

EntityDescriptionBase

about: URI {readOnly}alternateEntityId: ScopedEntityName [0..*]ancestors: EntityDirectoryURI [0..1] {readOnly}children: EntityDirectoryURI [0..1] {readOnly}definition: Definition [0..*]descendants: EntityDirectoryURI [0..1] {readOnly}describingCodeSystemVersion: CodeSystemVersionReference {readOnly}designation: Designation [0..*]entityDescriptionType: EntityDescriptionType {readOnly}entityId: ScopedEntityName {readOnly}entityType: EntityReference [1..*]equivalentEntities: EntityReference [0..*] {readOnly}example: Example [0..*]instances: EntityDirectoryURI [0..1] {readOnly}note: Comment [0..*]parent: EntityReference [0..*] {readOnly}predicateOf: AssociationDirectoryURI [0..1] {readOnly}property: Property [0..*]sourceStatements: StatementDirectoryURI [0..1] {readOnly}subjectOf: AssociationDirectoryURI [0..1] {readOnly}targetOf: AssociationDirectoryURI [0..1] {readOnly}

AnonymousEntityDescriptionChangeable

NamedEntityDescription

«enumeration»EntityDescriptionType

NAMED_ENTITY_DESCRIPTIONANONYMOUS_ENTITY_DESCRIPTION

HL7 Vocabulary Structures in CTS 2Concept Domain

• Core Principles Definition: “An HL7 Concept Domain is a named category of like concepts (a semantic type) that is specified in the Vocabulary Declaration of an attribute in an information model or property in a data type, whose data types are coded or potentially coded, and may be used in a Context Binding.”

17© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Concept Domain

18© Copyright 2011, Mayo Clinic2011/05/17

class ConceptDomain

AbstractResourceDescription

ConceptDomain

bindings: ConceptDomainBindingDirectoryURI [0..1]conceptDomainName: ConceptDomainNamedefiningEntity: EntityReference [0..1]::AbstractResourceDescriptionreleaseDocumentation: OpaqueData [0..1]releaseFormat: SourceAndNotation [0..*]::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

HL7 Vocabulary Structures in CTS 2Binding

• Core Principles Definition: “Vocabulary Binding is the mechanism of identifying specific codes to be used to express the semantics of coded model elements in HL7 information models or coded data type properties.”

19© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Binding

20© Copyright 2011, Mayo Clinic2011/05/17

class ConceptDomainBinding

ResourceVersionDescription

ConceptDomainBinding

applicableContext: ContextReference [0..*]bindingFor: ConceptDomainReferencebindingQualifier: BindingQualifierReference [0..1]boundValueSet: ValueSetReferenceboundValueSetDefinition: ValueSetDefinitionReference [0..1]useCodeSystemVersion: CodeSystemVersionReference [0..*]::ResourceVersionDescriptiondocumentURI: DocumentURIofficialActivationDate: DateAndTime [0..1]officialReleaseDate: DateAndTime [0..1]officialResourceVersionId: String [0..1]predecessor: NameAndMeaningReference [0..1]sourceAndNotation: SourceAndNotation::Finalizablestate: FinalizableState::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

HL7 Vocabulary Structures in CTS 2Value Set

• Core Principles Definition: “A Value Set represents a uniquely identifiable set of valid concept identifiers, where any concept identifier in a coded element can be tested to determine whether it is a member of the Value Set at a specific point in time.”

21© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2Value Set

22© Copyright 2011, Mayo Clinic2011/05/17

class ValueSetDefinition

ResourceVersionDescription

ValueSetDefinition

definedValueSet: ValueSetReference::ResourceVersionDescriptiondocumentURI: DocumentURIofficialActivationDate: DateAndTime [0..1]officialReleaseDate: DateAndTime [0..1]officialResourceVersionId: String [0..1]predecessor: NameAndMeaningReference [0..1]sourceAndNotation: SourceAndNotation::Finalizablestate: FinalizableState::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

ValueSetDefinitionEntry

entryType: ValueSetDefinitionEntryTypeoperator: SetOperator

entry 1..* {ordered}

class ValueSet

AbstractResourceDescription

ValueSet

definitions: ValueSetDefinitionDirectoryURI [0..*] {readOnly}valueSetName: ValueSetName::AbstractResourceDescriptionreleaseDocumentation: OpaqueData [0..1]releaseFormat: SourceAndNotation [0..*]::ResourceDescriptionabout: ExternalURI {readOnly}additionalDocumentation: PersistentURI [0..*]describedResourceType: CTS2ResourceType {readOnly}formalName: String [0..1]keyword: String [0..*]note: Comment [0..*]property: Property [0..*]resourceID: LocalIdentifier {readOnly}resourceSynopsis: EntryDescription [0..1]resourceType: EntityReference [1..*]rights: OpaqueData [0..1]sourceAndRole: SourceAndRoleReference [0..*]sourceStatements: StatementDirectory [0..1] {readOnly}::ChangeableentryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

Look at PHIN VADs document todetermine what additional metadata is needed in terms of use, categorizationand the like.

HL7 Vocabulary Structures in CTS 2VML

• HL7 employs Vocabulary Maintenance Language (VML) to structure changes to the vocabulary elements.

23© Copyright 2011, Mayo Clinic2011/05/17

HL7 Vocabulary Structures in CTS 2VML

24© Copyright 2011, Mayo Clinic2011/05/17

class Updates

«mixin»Changeable

entryID: PersistentURI {readOnly}entryState: EntryStatestatus: StatusReference [0..1]

ChangeSet

changeInstructions: OpaqueData [0..1]changeSetURI: ChangeSetURI {readOnly}closeDate: DateAndTime [0..1] {readOnly}creationDate: DateAndTime {readOnly}creator: SourceReference [0..1]entryCount: NaturalNumber {readOnly}officialEffectiveDate: DateAndTime [0..1]::Finalizablestate: FinalizableState

ChangeDescription

changeDate: DateAndTime [0..1]changeNotes: OpaqueData [0..1]changeSource: SourceReference [0..1]changeType: ChangeTypeclonedResource: NameAndMeaningReference [0..1]committed: ChangeCommittedcontainingChangeSet: ChangeSetURIeffectiveDate: DateAndTime [0..1]prevChangeSet: ChangeSetURI [0..1]

«enumeration»ChangeType

CREATEUPDATEMETADATADELETECLONEIMPORT

«enumeration»EntryState

INACTIVEACTIVE

«enumeration»ChangeCommitted

PENDINGCOMMITTED

«mixin»Finalizable

state: FinalizableState

«enumeration»FinalizableState

OPENFINAL

member 0..* {ordered}

prevImage

0..1

changeDescription

0..1

/containingChangeSet

1

/prevChangeSet

0..1

Submission Resources

• CTS 2 Submission Wiki– http://informatics.mayo.edu/cts2/index.php/Main_Page

• HL7 CTS 2 SFM (DSTU)– http://www.hl7.org/documentcenter/ballots/2009may/downloads/V3_CTS_R

2_DSTU_2009OCT.pdf

• OMG RFP for CTS 2– http://www.omg.org/cgi-bin/doc?ad/2009-9-17

• CTS 2 Submission Team– Harold Solbrig (solbrig.harold@mayo.edu)– Kevin Peterson (peterson.kevin@mayo.edu)– Russ Hamm (rhamm@apelon.com)– Rick Kiefer (Kiefer.Richard@mayo.edu)– Craig Stancl (stancl.craig@mayo.edu)

25© Copyright 2011, Mayo Clinic2011/05/17