HL 7 Terminology Authority External Terminologies Information data

HL 7 Terminology Authority External Terminologies Information data elements and FHIR mapping Reuben Daniels 16 November 2020

HTA-managed external terminology information data elements Existing data elements # Data element (DE) Issues Recommendation 1 Name: Terminology owner/maintenance organisation Name, contact details, website Suggested cardinality: 1. . 1 Suggested data type: String • The DE is composed of at least 6 separate DEs. • If kept as a single DE machine processing and conformance testing constituent components will be challenging. • The DE should be split into three mandatory composite DEs corresponding to the owner, maintainer/steward and publisher organizations. • The sub DEs of each of the above should include name, contact details and website using appropriate datatypes. 2 Name Formal name of the code system Suggested cardinality: 1. . 1 Suggested data type: String • It is unclear whether this DE is intended purely for human readability or also for machine processing. • The DE should be retained as mandatory with a string datatype. • Clarity should be sought on whether this DE is intended for machine processing. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 2

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 3 Name: Short name or abbreviation of the code system name Suggested cardinality: 1. . * Suggested datatype: String • It is unclear whether this DE is intended purely for human readability or also for machine processing. • The DE should be retained with a string datatype. • Clarity should be sought on whether this DE is intended for machine processing. 4 Name: Technical identifier/s for the code system Suggested cardinality: 1. . * Suggested datatype: String • The DE is composed of multiple DEs. • URI (including URN and URL) and OID identifiers are supported. • The DE should be retained with an identifier datatype with a cardinality of 2. . *. • Identifier should have an attributes for type (URI and OID) and HTA-endorsed (true/false). © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 3

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 5 Name: Scope/domain statement for the code system (Official or from HTA) Suggested cardinality: 0. . 1 Suggested datatype: String • None • The DE should be retained with a text datatype. • The values for this DE should be a description of the code system. 6 Name: Link to information about the code system including how to obtain the content Suggested cardinality: 0. . 1 Suggested datatype: String / URL • Most current values are website URLs but some are text with explanatory text or multiple URLs. • The DE should be retained with a cardinality of 1. . * • The DE should be composed of two DEs: a mandatory link and an optional note which are URL and string datatypes respectively. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 4

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 7 Name: Arrangement or agreements with HL 7 for use of content Suggested cardinality: 0. . 1 Suggested datatype: String • None • The DE should be retained as an optional DE with a string datatype. 8 Name: Version management - timing and identification of versions. Suggested cardinality: 0. . 1 Suggested datatype: String • Current values indicate inconsistency in which information is carried by this data element i. e. some include only timing (release frequency), others only identification (format) of version values, and others both. • The DE should be retained as a mandatory DE with a string datatype. • Values of this DE should always include timing as well identification of version values. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 5

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 9 Name: IP Information and Licensing Information Suggested cardinality: 0. . 1 Suggested datatype: String • Current values include various combinations of copyright statement, IP ownership, obtaining a license and links to further information. • The DE should be split into distinct new mandatory DEs each with a string datatype • copyright statement (no links) • copyright information (including links) • IP information (including ownership and links) • Licensing information (including obtaining a license and links) 10 Name: HL 7 users of this information - which HL 7 products use this link (if known) Suggested cardinality: 0. . 1 Suggested datatype: String • Current values are mostly not present. • When present the values are often to entire product families e. g. V 2, FHIR, etc. • The DE should be retired as keeping this information up to date is challenging. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 6

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 11 Name: Process to request content change Suggested cardinality: 0. . 1 Suggested datatype: String • Current values suggest emailing a stated email address, visiting a particular link, or no value is provided. • The DE should be retired as keeping this information up to date is challenging. • Instead, as a policy position, parties in HL 7 who wish to request content changes should contact the HTA who can provide update to date information. 12 Name: Other useful Information Suggested cardinality: 0. . 1 Suggested datatype: String • Current values extended descriptions, or no value is provided. • The DE should be retired and additional information provided as part of the scope/domain description of the terminology. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 7

HTA-managed external terminology information data elements Existing data elements continued. # Data element (DE) Issues Recommendation 13 Name: Information current as at (date) Suggested cardinality: 0. . 1 Suggested datatype: String • Current values are free text or multiple formats of dates. • The DE should be retained as a mandatory value with a date datatype. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 8

HTA-managed external terminology information data elements Proposed data elements # Data element (DE) Need Values 1 -1 Name: Terminology Owner Proposed cardinality: 1. . 1 Suggested data type: Reference(Organization): • The organization which owns the IP for the terminology. • Organization details include name, address, contact details, web site, etc. 1 -2 Name: Terminology Maintainer Proposed cardinality: 1. . 1 Suggested data type: Reference(Organization): • The organization responsible for maintaining the content in the terminology – the steward. • Organization details include name, address, contact details, web site, etc. 1 -3 Name: Terminology Publisher Proposed cardinality: 1. . 1 Suggested data type: Reference(Organization): • The organization responsible for publishing the terminology. • Organization details include name, address, contact details, web site, etc. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 9

HTA-managed external terminology information data elements Proposed data elements continued. # Data element (DE) Need Values 9 -1 Name: Copyright statement Proposed cardinality: 1. . 1 Suggested data type: String • The terminology’s standard copyright statement. • Text ideally provided by the terminology owner or terminology maintainer. 9 -2 Name: Copyright information Proposed cardinality: 0. . 1 Suggested data type: String • Additional information relating to copyright 9 -3 Name: Intellectual Property (IP) Information Proposed cardinality: 0. . 1 Suggested data type: String • Information relating to the terminology’s intellectual property. 9 -4 Name: Licensing Information Proposed cardinality: 0. . 1 Suggested data type: String • Information relating to licensing of the terminlogy © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 10

HTA-managed external terminology information data elements Proposed data elements continued. # Data element (DE) Need Values 14 Name: HTA endorsement status Proposed cardinality: 1. . 1 Suggested data type: Composite: Sub DEs: Value (datatype: code) 1. . 1 Assignment date (datatype: date) 1. . 1 • A means to indicate whether the information for the terminology is in draft, reliable for use, pending re-endorsement, or retired. • Value • draft • endorsed for use • pending re-endorsement • retired • Assignment date • YYYYMMDD date value © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 11

HTA-managed external terminology information data elements Proposed data elements continued. # Data element (DE) Need Values 15 Name HTA review status Suggested cardinality: 1. . 1 Suggested data type: String Sub DEs: Last review date (datatype: date) 1. . 1 Next review date (datatype: date) 1. . 1 • It is unclear how current the information for a terminology is and when it will next be reviewed by the HTA. • Last review date • YYYYMMDD date value • Next review date • YYYYMMDD date value © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 12

HTA-managed external terminology information data elements FHIR Code. System mapping # HTA DE FHIR DE Notes 1 Terminology owner/maintenance organisation Code. System. publisher 1 -1 Terminology Owner Code. System. extension • Proposed DE • FHIR data type: Reference(Organization) 1 -2 Terminology Maintainer Code. System. extension • Proposed DE • FHIR data type: Reference(Organization) 1 -3 Terminology Publisher Code. System. extension • Proposed DE • FHIR data type: Reference(Organization) 2 Formal name of the code system Code. System. title • Only if machine processing is not required. • If machine processing is required, then Code. System. extension 3 Short name or abbreviation of the code system name Code. System. name • Only if values are required to be machine processible. • If multiple values, or non-machine processible values are required then Code. System. extension. © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. 13

HTA-managed external terminology information data elements FHIR Code. System mapping # HTA DE FHIR DE 4 Technical identifier/s for the code system Primary URI Identifier: • Code. System. url; and • Naming. System. unique. Id. value URI & OID Identifiers: • Code. System. identifier; and • Naming. System. unique. Id. value Identifier type: • Code. System. identifier. type; and • Naming. System. unique. Id. type HTA endorsement • Naming. System. unique. Id. authoritative 5 Scope/domain statement for the code system (Official or from HTA) Code. System. description 6 Link to information about the code system - including how to obtain the content Code. System. extension © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. Notes • It is assumed that each terminology will have a dedicated pair of Code. System and Naming. System FHIR resources. • Values in Code. System. url implicitly have a URI identifier type. • FHIR data type: string 14

HTA-managed external terminology information data elements FHIR Code. System mapping # HTA DE FHIR DE 7 Arrangement or agreements with HL 7 for use of content Code. System. extension • FHIR data type: string 8 Version management - timing and identification of versions. Code. System. extension • The Code. System. version value should not be used. 9 IP Information and Licensing Information Code. System. copyright 9 -1 Copyright statement Code. System. copyright • Proposed DE • FHIR data type: string 9 -2 Copyright information Code. System. extension • Proposed DE • FHIR data type: string 9 -3 IP information Code. System. extension • Proposed DE • FHIR data type: string 9 -4 Licensing information Code. System. extension • Proposed DE • FHIR data type: string © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. Notes 15

HTA-managed external terminology information data elements FHIR Code. System mapping # HTA DE FHIR DE 10 HL 7 users of this information - which HL 7 products use this link (if known) Code. System. extension • Proposed for retirement • FHIR data type: string 11 Process to request content change Code. System. extension • Proposed for retirement • FHIR data type: string 12 Other useful Information Code. System. extension • Proposed for retirement • FHIR data type: string 13 Information current as at (date) Code. System. extension • Code. System. date should not be used. • FHIR data type: Date 14 HTA endorsement status Code. System. extension • Proposed DE • FHIR data type: Complex Extension • Value: code with a required binding to an HTA defined value set (defined as an enumeration of codes from an HTA defined code system) • Assignment date: Date © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. Notes 16

HTA-managed external terminology information data elements FHIR Code. System Mapping # HTA DE 15 HTA review status FHIR DE Code. System. extension © 2020 Health Level Seven ® International. Licensed under Creative Commons Attribution 4. 0 International HL 7, Health Level Seven, FHIR and the FHIR flame logo are registered trademarks of Health Level Seven International. Reg. U. S. TM Office. Notes • Proposed DE • FHIR data type: Complex Extension • Last review date: Date • Next review date: Date 17