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/ResourceDescription.xml

Raw XML (canonical form)

Logical Model ResourceDescription

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ResourceDescription"/>
  <url value="{http://www.omg.org/spec/CTS2/1.1/Core}ResourceDescription"/>
  <name value="ResourceDescription"/>
  <display value="CTS2.ResourceDescription"/>
  <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="ResourceDescription represents the shared characteristics common to both abstract and
   resource version descriptions. ResourceDescription is an abstract type and, as such, cannot
   be directly     created. Resource descriptions are Changeable, meaning that they have
   identity and can be created, updated and deleted."/>
  <fhirVersion value="1.4.0"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="{http://www.omg.org/spec/CTS2/1.1/Core}Changeable"/>
  <snapshot>
    <element>
      <path value="ResourceDescription"/>
      <short value="ResourceDescription"/>
      <definition value="ResourceDescription represents the shared characteristics common to both abstract and
       resource version descriptions. ResourceDescription is an abstract type and, as such, cannot
       be directly     created. Resource descriptions are Changeable, meaning that they have
       identity and can be created, updated and deleted."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="{http://www.omg.org/spec/CTS2/1.1/Core}Changeable"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Changeable"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.about"/>
      <name value="about"/>
      <short value="the (or a) definitive URI that represents the resource being described"/>
      <definition value="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         about URI for the Wine ontology would be &quot;http://www.w3.org/TR/2003/
      PR-owl-guide-20031209/wine#&quot;. The NCI Thesaurus has, amongst others, the         about
       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        be &quot;urn:oid:2.16.840.1.113883.3.26.1.1&quot;"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="ExternalURI"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.formalName"/>
      <name value="formalName"/>
      <short value="the formal or officially assigned name of this resource, if any"/>
      <definition value="the formal or officially assigned name of this resource, if any"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="String"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.keyword"/>
      <name value="keyword"/>
      <short value="additional identifiers that are used to index and locatethe resource"/>
      <definition value="additional identifiers that are used to index and locatethe resource"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="String"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.resourceType"/>
      <name value="resourceType"/>
      <short value="the class(es) that this resource instantiates"/>
      <definition value="the class(es) that this resource instantiates"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="URIAndEntityName"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.resourceSynopsis"/>
      <name value="resourceSynopsis"/>
      <short value="a textual summary of the resource - what it is, what it is for, etc"/>
      <definition value="a textual summary of the resource - what it is, what it is for, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="EntryDescription"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.additionalDocumentation"/>
      <name value="additionalDocumentation"/>
      <short value="a reference to a document thatprovide additional information about the resource"/>
      <definition value="a reference to a document thatprovide additional information about the resource"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="PersistentURI"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.sourceAndRole"/>
      <name value="sourceAndRole"/>
      <short value="a reference to an individual, organization of bibliographic reference that participated
       in the creation, validation, review, dissemination of this resource and therole(s) they
               played"/>
      <definition value="a reference to an individual, organization of bibliographic reference that participated
       in the creation, validation, review, dissemination of this resource and therole(s) they
               played"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="SourceAndRoleReference"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.rights"/>
      <name value="rights"/>
      <short value="copyright and IP information"/>
      <definition value="copyright and IP information. Note that rights applies to the source resource, not the
       CTS2 rendering."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="OpaqueData"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.note"/>
      <name value="note"/>
      <short value="an additional note or comment about the resource"/>
      <definition value="an additional note or comment about the resource"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Comment"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.property"/>
      <name value="property"/>
      <short value="additional information about the resource that doesnot fit into any of the attributes
       described above"/>
      <definition value="additional information about the resource that doesnot fit into any of the attributes
       described above"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Property"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.alternateID"/>
      <name value="alternateID"/>
      <short value="an alternative identifier that uniquely names this resource in other environments as contexts"/>
      <definition value="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         be assigned as the entryID of the resource by one service while the
       ISO OID would be recorded as an alternateURI using the &quot;urn:oid&quot; prefix. Note
       that alternateIds can be added or removed         during resource updates."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ExternalURI"/>
      </type>
    </element>
    <element>
      <path value="ResourceDescription.sourceStatements"/>
      <name value="sourceStatements"/>
      <short value="a DirectoryURI that references the set of statements that were used to construct the containing
       resource"/>
      <definition value="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
                Statement profile "/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="StatementDirectoryURI"/>
      </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.