Cts2/ResourceDescription.json

Logical Model ResourceDescription

{
  "resourceType": "StructureDefinition",
  "id": "ResourceDescription",
  "url": "{http://www.omg.org/spec/CTS2/1.1/Core}ResourceDescription",
  "name": "ResourceDescription",
  "display": "CTS2.ResourceDescription",
  "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": "ResourceDescription represents the shared characteristics common to both abstract and resource version descriptions. ResourceDescription is an abstract type and, as such, cannot be directly\n\t\t\t\tcreated. Resource descriptions are Changeable, meaning that they have identity and can be created, updated and deleted.",
  "fhirVersion": "1.4.0",
  "kind": "logical",
  "abstract": false,
  "baseDefinition": "{http://www.omg.org/spec/CTS2/1.1/Core}Changeable",
  "snapshot": {
    "element": [
      {
        "path": "ResourceDescription",
        "short": "ResourceDescription",
        "definition": "ResourceDescription represents the shared characteristics common to both abstract and resource version descriptions. ResourceDescription is an abstract type and, as such, cannot be directly\n\t\t\t\tcreated. Resource descriptions are Changeable, meaning that they have identity and can be created, updated and deleted.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "{http://www.omg.org/spec/CTS2/1.1/Core}Changeable",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Changeable"
          }
        ]
      },
      {
        "path": "ResourceDescription.about",
        "name": "about",
        "short": "the (or a) definitive URI that represents the resource being described",
        "definition": "the (or a) definitive URI that represents the resource being described. Note that this is NOT the URI of the resource description in the CTS2 format, but of the resource itself. As an example, the\n\t\t\t\t\t\t\t\tabout URI for the Wine ontology would be \"http://www.w3.org/TR/2003/PR-owl-guide-20031209/wine#\". The NCI Thesaurus has, amongst others, the\n\t\t\t\t\t\t\t\tabout URI of http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#. HL7 uses ISO Object Identifiers (OIDs) to label resources so, from the HL7 perspective, the about URI of the NCI Thesaurus would\n\t\t\t\t\t\t\tbe \"urn:oid:2.16.840.1.113883.3.26.1.1\"",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "ExternalURI"
          }
        ]
      },
      {
        "path": "ResourceDescription.formalName",
        "name": "formalName",
        "short": "the formal or officially assigned name of this resource, if any",
        "definition": "the formal or officially assigned name of this resource, if any",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "String"
          }
        ]
      },
      {
        "path": "ResourceDescription.keyword",
        "name": "keyword",
        "short": "additional identifiers that are used to index and locatethe resource",
        "definition": "additional identifiers that are used to index and locatethe resource",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "String"
          }
        ]
      },
      {
        "path": "ResourceDescription.resourceType",
        "name": "resourceType",
        "short": "the class(es) that this resource instantiates",
        "definition": "the class(es) that this resource instantiates",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "URIAndEntityName"
          }
        ]
      },
      {
        "path": "ResourceDescription.resourceSynopsis",
        "name": "resourceSynopsis",
        "short": "a textual summary of the resource - what it is, what it is for, etc",
        "definition": "a textual summary of the resource - what it is, what it is for, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "EntryDescription"
          }
        ]
      },
      {
        "path": "ResourceDescription.additionalDocumentation",
        "name": "additionalDocumentation",
        "short": "a reference to a document thatprovide additional information about the resource",
        "definition": "a reference to a document thatprovide additional information about the resource",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "PersistentURI"
          }
        ]
      },
      {
        "path": "ResourceDescription.sourceAndRole",
        "name": "sourceAndRole",
        "short": "a reference to an individual, organization of bibliographic reference that participated in the creation, validation, review, dissemination of this resource and therole(s) they\n\t\t\t\t\t\t\t\tplayed",
        "definition": "a reference to an individual, organization of bibliographic reference that participated in the creation, validation, review, dissemination of this resource and therole(s) they\n\t\t\t\t\t\t\t\tplayed",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "SourceAndRoleReference"
          }
        ]
      },
      {
        "path": "ResourceDescription.rights",
        "name": "rights",
        "short": "copyright and IP information",
        "definition": "copyright and IP information. Note that rights applies to the source resource, not the CTS2 rendering.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "OpaqueData"
          }
        ]
      },
      {
        "path": "ResourceDescription.note",
        "name": "note",
        "short": "an additional note or comment about the resource",
        "definition": "an additional note or comment about the resource",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Comment"
          }
        ]
      },
      {
        "path": "ResourceDescription.property",
        "name": "property",
        "short": "additional information about the resource that doesnot fit into any of the attributes described above",
        "definition": "additional information about the resource that doesnot fit into any of the attributes described above",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Property"
          }
        ]
      },
      {
        "path": "ResourceDescription.alternateID",
        "name": "alternateID",
        "short": "an alternative identifier that uniquely names this resource in other environments as contexts",
        "definition": "an alternative identifier that uniquely names this resource in other environments as contexts. As an example, if a resource had both an ISO Object Identifier and a DNS name, the DNS name might\n\t\t\t\t\t\t\t\tbe assigned as the entryID of the resource by one service while the ISO OID would be recorded as an alternateURI using the \"urn:oid\" prefix. Note that alternateIds can be added or removed\n\t\t\t\t\t\t\t\tduring resource updates.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ExternalURI"
          }
        ]
      },
      {
        "path": "ResourceDescription.sourceStatements",
        "name": "sourceStatements",
        "short": "a DirectoryURI that references the set of statements that were used to construct the containing resource",
        "definition": "a DirectoryURI that references the set of statements that were used to construct the containing resource. This attribute must (may?) be present if and only if the service supports the\n\t\t\t\t\t\t\t\t\tStatement profile ",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "StatementDirectoryURI"
          }
        ]
      }
    ]
  }
}