STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Cts2/CodeSystemCatalogEntry.xml

Raw XML (canonical form)

Logical Model CodeSystemCatalogEntry

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CodeSystemCatalogEntry"/>
  <url value="{http://www.omg.org/spec/CTS2/1.1/CodeSystem}CodeSystemCatalogEntry"/>
  <name value="CodeSystemCatalogEntry"/>
  <display value="CTS2.CodeSystemCatalogEntry"/>
  <status value="draft"/>
  <publisher value="Generated by Xsd-to-FHIR"/>
  <contact>
    <name value="Visit the Github repository for more information"/>
    <telecom>
      <system value="other"/>
      <value value="https://github.com/cts2/CTS2-to-FHIR"/>
    </telecom>
  </contact>
  <date value="2016-02-08T19:11:02-07:00"/>
  <description value="Metadata and access information about a code system."/>
  <fhirVersion value="1.4.0"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="{http://www.omg.org/spec/CTS2/1.1/Core}AbstractResourceDescription"/>
  <snapshot>
    <element>
      <path value="CodeSystemCatalogEntry"/>
      <short value="CodeSystemCatalogEntry"/>
      <definition value="Metadata and access information about a code system."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="{http://www.omg.org/spec/CTS2/1.1/Core}AbstractResourceDescription"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="AbstractResourceDescription"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.codeSystemName"/>
      <name value="codeSystemName"/>
      <short value="the local identifier that uniquely identifies the code system within the context of the
       implementing service"/>
      <definition value="the local identifier that uniquely identifies the code system within the context of the
       implementing service. Note that the about URI is the globally unique identifier."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeSystemName"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.codeSystemCategory"/>
      <name value="codeSystemCategory"/>
      <short value="the category or type of resource that the code system represents"/>
      <definition value="the category or type of resource that the code system represents."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeSystemCategoryReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.ontologyDomain"/>
      <name value="ontologyDomain"/>
      <short value="the subject domain of the ontology"/>
      <definition value="the subject domain of the ontology"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="OntologyDomainReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.ontologyType"/>
      <name value="ontologyType"/>
      <short value="the nature of the content of the ontology"/>
      <definition value="the nature of the content of the ontology"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="OntologyTypeReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.designedForOntologyTask"/>
      <name value="designedForOntologyTask"/>
      <short value="the purpose for which the ontology was originally designed"/>
      <definition value="the purpose for which the ontology was originally designed"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="OntologyTaskReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.hasOntologyLanguage"/>
      <name value="hasOntologyLanguage"/>
      <short value="the formal ontology language"/>
      <definition value="the formal ontology language"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="OntologyLanguageReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.includes"/>
      <name value="includes"/>
      <short value="a reference to an external code system that is included as a component of the referenced
       code system"/>
      <definition value="a reference to an external code system that is included as a component of the referenced
       code system. The Wine Ontology,         as an example, includes the Food Ontology as one
       of its components.  Similarly, the US Edition of SNOMED-CT includes the international
       edition.             "/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeSystemReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.versions"/>
      <name value="versions"/>
      <short value="a DirectoryURI that references the known versions of this code system"/>
      <definition value="a DirectoryURI that references the known versions of this code system. "/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeSystemVersionCatalogEntryDirectoryURI"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.currentVersion"/>
      <name value="currentVersion"/>
      <short value="a reference to the code system version marked as CURRENT in the service instance"/>
      <definition value="a reference to the code system version marked as CURRENT in the service instance."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeSystemVersionReference"/>
      </type>
    </element>
    <element>
      <path value="CodeSystemCatalogEntry.usedOntologyEngineeringTool"/>
      <name value="usedOntologyEngineeringTool"/>
      <short value="information about a tool used to create the ontology"/>
      <definition value="information about a tool used to create the ontology"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="OntologyEngineeringToolReference"/>
      </type>
    </element>
  </snapshot>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.