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.json

Raw JSON (canonical form)

Logical Model CodeSystemCatalogEntry

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

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.