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

Raw XML (canonical form)

Logical Model Directory

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Directory"/>
  <url value="{http://www.omg.org/spec/CTS2/1.1/Core}Directory"/>
  <name value="Directory"/>
  <display value="CTS2.Directory"/>
  <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="Provides a directory or list of resources that match a specific filter and are ordered
   in a specified order. A directory is read-only and is not necessarily immutable.Note that
   the name of the link to      DirectoryEntry is called &quot;entries&quot; rather than
   &quot;entry&quot;. This allows subclasses to use &quot;entry&quot; without type collisions
   in the Z."/>
  <fhirVersion value="1.4.0"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="{http://www.omg.org/spec/CTS2/1.1/Core}Message"/>
  <snapshot>
    <element>
      <path value="Directory"/>
      <short value="Directory"/>
      <definition value="Provides a directory or list of resources that match a specific filter and are ordered
       in a specified order. A directory is read-only and is not necessarily immutable.Note that
       the name of the link to      DirectoryEntry is called &quot;entries&quot; rather than
       &quot;entry&quot;. This allows subclasses to use &quot;entry&quot; without type collisions
       in the Z."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="{http://www.omg.org/spec/CTS2/1.1/Core}Message"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Message"/>
      </type>
    </element>
    <element>
      <path value="Directory.complete"/>
      <name value="complete"/>
      <short value="an indicator that states whether the complete directory listing is included in entries
       or whether additional retrievals are needed to get the full listing"/>
      <definition value="an indicator that states whether the complete directory listing is included in entries
       or whether additional retrievals are needed to get the full listing."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CompleteDirectory"/>
      </type>
    </element>
    <element>
      <path value="Directory.numEntries"/>
      <name value="numEntries"/>
      <short value="the number of entries in this directory segment"/>
      <definition value="the number of entries in this directory segment. Note that this is not the total number
       of entries in the complete directory listing - just the number of entries in this    
          segment."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="NaturalNumber"/>
      </type>
    </element>
    <element>
      <path value="Directory.prev"/>
      <name value="prev"/>
      <short value="a URI that, when de-referenced, produces the preceding set of entries in the directory"/>
      <definition value="a URI that, when de-referenced, produces the preceding set of entries in the directory."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="DirectoryURI"/>
      </type>
    </element>
    <element>
      <path value="Directory.next"/>
      <name value="next"/>
      <short value="a URI that, when de-referenced, produces the next set of entries in the directory"/>
      <definition value="a URI that, when de-referenced, produces the next set of entries in the directory."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="DirectoryURI"/>
      </type>
    </element>
    <element>
      <path value="Directory.directoryFilter"/>
      <name value="directoryFilter"/>
      <short value="the filter(s) that were applied to generate this directory"/>
      <definition value="the filter(s) that were applied to generate this directory"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Filter"/>
      </type>
    </element>
    <element>
      <path value="Directory.sortCriteria"/>
      <name value="sortCriteria"/>
      <short value="the sort criteria used in the directory"/>
      <definition value="the sort criteria used in the directory. When this is left as optional, there is the possibility
       that some directories may not be ordered. Some PSMs may chose to make sortCriteria   
            mandatory, meaning that all directory listings must reflect some sort order."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="SortCriteria"/>
      </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.