CTS2/doc/CTS2 SFM PIM FunctionalRequirements

This table provides a cursory analysis of the functional mapping from the HL7 SFM to the OMG CTS2 specification: please consult the specification to confirm mappings suggested here.

Reference	Requirement	CTS2 Functional Profile	CTS2 Structural Profile	Notes
6.1.1	Import Code System	FP_IMPORT	SP_CODE_SYSTEM (for metadata)	CTS2 provides an API for validation and import. Note that the specification does not describe how external formats are represented in CTS2. This is being developed in the follow-on implementation guides.
			SP_CODE_SYSTEM_VERSION (for version metadata)
			SP_ENTITY_DESCRIPTION (for concepts, concept properties and designations)
			SP_ASSOCIATION (for ConceptAssociations)
6.1.2	Import Code System Revision	FP_IMPORT	SP_CODE_SYSTEM, etc.	To the extent the import format supports revisions, the API does not preclude updates.
		FP_UPDATE	(all)	The CTS2 update profile supports the a full semantics for exchanging updates.
6.1.3	Import Value Set Version	FP_IMPORT	SP_VALUE_SET (for value set metadata)
			SP_VALUE_SET_DEFINITION (for value set version and ruleSetId
6.1.4	Import Association Version	FP_IMPORT	SP_ASSOCIATION (for association)
			SP_MAP (for map metadata)
			SP_MAP_VERSION (for map content)
6.1.5	Export Association	FP_EXPORT	SP_ASSOCIATION (for association)
			SP_MAP and SP_MAP_VERSION (for maps)
		FP_READ and FP_QUERY	SP_ASSOCIATION, SP_MAP and SP_MAP_VERSION	Information may be extracted in CTS2 format and then be transformed
6.1.6	Export Code System Content	FP_EXPORT	SP_CODE_SYSTEM (for metadata)
			SP_CODE_SYSTEM_VERSION(for version metadata)
			SP_ENTITY_DESCRIPTION(for concepts, concept properties and designations)
			SP_ASSOCIATION (for ConceptAssociations)
6.1.7	Change Code System Status	FP_UPDATE
6.1.8	Register for Notification	not supported		no client state information found in CTS2
6.1.9	Update Notification Registration	not supported		no client state information found in CTS2
6.1.10	Update Notification Registration Status	not supported		no client state information found in CTS2
6.2.1.1	List Code Systems	FP_READ, FP_QUERY	SP_CODE_SYSTEM	Does this "read" a catalog or "query" for a list of resources?
			SP_CODE_SYSTEM_VERSION
6.2.1.2	Return Code System Details	FP_READ, FP_QUERY	SP_CODE_SYSTEM
			SP_CODE_SYSTEM_VERSION
6.2.1.3	List Code System Concepts	FP_READ, FP_QUERY	SP_CODE_SYSTEM
			SP_CODE_SYSTEM_VERSION
6.2.1.4	Return Concept Details	FP_READ, FP_QUERY	SP_ENTITY_DESCRIPTION
6.2.1.5	List Association Types	FP_READ, FP_QUERY	SP_ASSOCIATION
6.2.1.6	Return Association Type Details	FP_READ, FP_QUERY	SP_ASSOCIATION
6.2.2.1	List Value Sets	FP_READ, FP_QUERY	SP_VALUE_SET
			SP_VALUE_SET_DEFINITION
6.2.2.2	Return Value Set Details	FP_READ, FP_QUERY	SP_VALUE_SET
			SP_VALUE_SET_DEFINITION
6.2.2.3	List Value Set Contents (Expand value set)	FP_READ, FP_QUERY	SP_VALUE_SET_RESOLUTION
6.2.2.4	Check Value Set Subsumption	FP_QUERY	SP_VALUE_SET_DEFINITION
			SP_VALUE_SET_RESOLUTION
6.2.2.5	Check Concept Value Set Membership	FP_QUERY	SP_VALUE_SET_DEFINITION
			SP_VALUE_SET_RESOLUTION
6.2.3.1	List Concept Domains	FP_READ, FP_QUERY	SP_CONCEPT_DOMAIN
6.2.3.2	Return Concept Domain Details	FP_READ, FP_QUERY	SP_CONCEPT_DOMAIN
6.2.3.3	List Usage Contexts	FP_QUERY	SP_CONCEPT_DOMAIN_BINDING
6.2.3.4	Return Usage Context Details	FP_READ, FP_QUERY	SP_CONCEPT_DOMAIN_BINDING
6.2.3.5	List Concept Domain Bindings	FP_QUERY	SP_CONCEPT_DOMAIN_BINDING
6.2.3.5.1	Check Concept to Concept Domain Association	FP_QUERY	SP_CONCEPT_DOMAIN_BINDING
			SP_VALUE_SET_RESOLUTION
6.2.4.1	List Associations	FP_QUERY	SP_ASSOCIATION
6.2.4.2	Determine Transitive Concept Relationship	FP_QUERY	SP_CODE_SYSTEM_VERSION
			SP_ASSOCIATION
6.2.4.3	Compute Subsumption Relationship	FP_QUERY	SP_CODE_SYSTEM_VERSION
			SP_ASSOCIATION
6.2.4.4	Return Association Details	FP_READ	SP_ASSOCIATION
6.3.1.1	Create Code System	FP_AUTHORING	SP_CODE_SYSTEM
6.3.1.2	Maintain Code System Version	FP_AUTHORING	SP_CODE_SYSTEM_VERSION
6.3.1.3	Update Code System Version Status	FP_UPDATE	SP_CODE_SYSTEM_VERSION
6.3.1.4	Create Code System Supplement	FP_AUTHORING	SP_CODE_SYSTEM
6.3.1.5	Maintain Code System Supplement	FP_AUTHORING	SP_CODE_SYSTEM_VERSION
6.3.1.6	Create Concept	FP_AUTHORING	SP_ENTITY_DESCRIPTION
6.3.1.7	Maintain Concept	FP_UPDATE	SP_ENTITY_DESCRIPTION
6.3.1.8	Update Concept Status	FP_UPDATE	SP_ENTITY_DESCRIPTION
6.3.1.9	Create Association Type	FP_AUTHORING	SP_ENTITY_DESCRIPTION
6.3.1.10	Maintain Association Type	FP_AUTHORING	SP_ENTITY_DESCRIPTION
6.3.2.1	Create Value Set	FP_AUTHORING	SP_VALUE_SET
			SP_VALUE_SET_DEFINITION
6.3.2.2	Maintain Value Set	FP_UPDATE	SP_VALUE_SET
			SP_VALUE_SET_DEFINITION
6.3.2.3	Update Value Set Status	FP_UPDATE	SP_VALUE_SET
6.3.3.1	Create Concept Domain	FP_AUTHORING	SP_CONCEPT_DOMAIN
6.3.3.2	Maintain Concept Domain	FP_UPDATE	SP_CONCEPT_DOMAIN
6.3.3.3	Create Usage Context	FP_AUTHORING	SP_CONCEPT_DOMAIN_BINDING
6.3.3.4	Maintain Usage Context	FP_UPDATE	SP_CONCEPT_DOMAIN_BINDING
6.3.4.1	Update Association Status	FP_UPDATE	SP_ASSOCIATION
6.3.4.2	Create Association	FP_AUTHORING	SP_ASSOCIATION
6.3.4.3	Create Lexical Association between Coded Concepts	FP_AUTHORING	SP_ASSOCIATION	Uses defined algorithm for generating associations
6.3.4.4	Create Rules Based Association between Coded Concepts	FP_AUTHORING	SP_ASSOCIATION	Uses defined algorithm for generating associations

---

Navigation – Common Terminology Services (CTS2)

Home
About CTS2
Purpose
CTS2 History
Business Case
How it works
Federation
Functionality
Implementing CTS2
Architecture
Development
Resources
Purpose
FAQ
Business Case
Glossary of Terms
Specification
REST
SOAP
HL7 SFM
Development
CTS2 Development Framework
Implementations
Github Page
Community
Who is Using CTS2?
Get Help
Links