OntoDL Object Type: codesystem

Defined Properties

Property Name	RWDS	Type	Subtype	Card.	Definition
Name	RWD	string		1..1	Name of the object. Set when the object is initially defined (see define statement).
Type	RWD	string		1..1	"codesystem"
OID	RW	string		0/1..1	OID of the code system. Used by OntoDL as the primary identitfier. May only be omitted if an URN is defined.
URI	RW	string		0/1..1	URN of the code system. Must be given if no OID is provided. Takes the role of the primary identifier in this case.
Version	RW	string		0..1	A code system is globally and univocally identifiable by it's OID/URN and Version. If a code system is uploaded to CTS2-LE that has the same OID/URN and Version as an existing code system, the existing code system is overwritten by the uploaded system. If no value for this property is givem OntoDL sets the current date (YYYY-MM-DD) as the version.
Status	RWD	string		0..1	active | retired). If no status is given, OntoDL sets the code system status to "draft" by default.
Group	RW	string		0..1	CTS2-LE specific: Folder within the CTS2-LE terminology browser where this code system shall be placed. If the code system is to be uploaded to CTS2-LE this property must be defined.
Description	RW	collection	string	0..1	Description of the code system.
Copyright	RW	string		0..1	Copyright notice to be linked with the code system. NOTE: This property is ignored by CTS2-LE as there is no corresponding property within the CTS2 standard information model.
Publisher	RW	string		0..1	Information about the publisher of the code system. NOTE: This property is ignored by CTS2-LE as there is no corresponding property within the CTS2 standard information model.
Language	RW	string		0..1	CTS2-LE specific: If different language versions of the code system exist, this property given the version of the defined code system. Value shall be an RFC5646 "simple language subtag".
Encoding	RWS	string		0..1	Encoding to be used when the code system is uploaded to a terminology server. If no encoding is defined, OntoDL uses "UTF-8" by default.
Concepts	RWS	collection	concept	1..1	Concepts within the code system
_Temp	RW	string		0..1	for yoour own disposition

RWDS = Read Access - Write Access - Default Value if not explicitly set - Special Treatment

FHIR Mapping

DSTU-2: Terminology (codesystem)

<?xml version="1.0" encoding="Encoding"?>
<ValueSet xmlns="http://hl7.org/fhir" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xml="http://www.w3.org/XML/1998/namespace" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ext="http://semantik.fokus.fraunhofer.de/ehealth/fhir-extensions#" xsi:schemaLocation="http://hl7.org/fhir ../fhir-std/spec-v1.0.2/valueset.xsd">
<name value="Name"/>
<status value="Status"/>
<experimental value="False"/> <!-- value="True" if code system has Silent Name (name starting with an underscore) -->
<publisher value="Publisher"/>
<description value="Description"/>
<copyright value="Copyright"/>
<codeSystem>
<extension url="ext:language">       <valueCode value="Language"/>     </extension>
<extension url="ext:groupName">       <valueString value="Group"/>     </extension>
<extension url="ext:resourceId">       <valueString value="Name"/>     </extension>
<system value="urn:oid:OID"/> <!-- if no OID is provided: <system value="URN"/> -->
<version value="Version"/>
...
</codeSystem>
</ValueSet>

---

The table below lists the elements defined for the FHIR ValueSet resource which are not used/supported for OntoDL terminology definitions.

FHIR ValueSet DSTU-2	Reason for not supporting this element
ValueSet/urn	For terminologies CTS2-LE only considers the identifer given within the codeSystem element. This behavior is compliant with FHIR STU-3 and makes sure that terminologies defined using OntoDL can be exported as DSTU-2 and STU-3 without any need for adapting existing files.
ValueSet/identifer	see above. Only identifiers provided in the codeSystem element are considered for terminology definitions.
ValueSet/version	see above. The version element is part of the terminology's unique identifer and therefore only the version given within the codeSystem element is considered.
ValueSet/contact	will be supported in one of the next updates to the OntoDL interpreter.
ValueSet/date	will be supported in one of the next updates to the OntoDL interpreter.
ValueSet/lockedDate	This element is no longer part of the FHIR resource for terminology definitions and therefore not supported by OntoDL.
ValueSet/useContext	will be supported in one of the next updates to the OntoDL interpreter.
ValueSet/immutable	This element is no longer part of the FHIR resource for terminology definitions and therefore not supported by OntoDL.
ValueSet/requirements	will be supported in one of the next updates to the OntoDL interpreter.
ValueSet/extensible	This element is no longer part of the FHIR resource for terminology definitions and therefore not supported by OntoDL.
ValueSet/codeSystem/caseSensitive	From our understanding of codes as unique identifiers for concepts, two concepts are identical only if they are part of the same version of the same code system and have the same code. This shall be interpreted as strict as possible and therefor CTS2-LE and OntoDL perform case sensitive code comparison only.