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

Raw JSON (canonical form)

Logical Model Directory

{
  "resourceType": "StructureDefinition",
  "id": "Directory",
  "url": "{http://www.omg.org/spec/CTS2/1.1/Core}Directory",
  "name": "Directory",
  "display": "CTS2.Directory",
  "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": "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\n\t\t\t\t\tDirectoryEntry is called \"entries\" rather than \"entry\". This allows subclasses to use \"entry\" without type collisions in the Z.",
  "fhirVersion": "1.4.0",
  "kind": "logical",
  "abstract": false,
  "baseDefinition": "{http://www.omg.org/spec/CTS2/1.1/Core}Message",
  "snapshot": {
    "element": [
      {
        "path": "Directory",
        "short": "Directory",
        "definition": "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\n\t\t\t\t\tDirectoryEntry is called \"entries\" rather than \"entry\". This allows subclasses to use \"entry\" without type collisions in the Z.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "{http://www.omg.org/spec/CTS2/1.1/Core}Message",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Message"
          }
        ]
      },
      {
        "path": "Directory.complete",
        "name": "complete",
        "short": "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": "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": 1,
        "max": "1",
        "type": [
          {
            "code": "CompleteDirectory"
          }
        ]
      },
      {
        "path": "Directory.numEntries",
        "name": "numEntries",
        "short": "the number of entries in this directory segment",
        "definition": "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\n\t\t\t\t\t\t\tsegment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "NaturalNumber"
          }
        ]
      },
      {
        "path": "Directory.prev",
        "name": "prev",
        "short": "a URI that, when de-referenced, produces the preceding set of entries in the directory",
        "definition": "a URI that, when de-referenced, produces the preceding set of entries in the directory.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "DirectoryURI"
          }
        ]
      },
      {
        "path": "Directory.next",
        "name": "next",
        "short": "a URI that, when de-referenced, produces the next set of entries in the directory",
        "definition": "a URI that, when de-referenced, produces the next set of entries in the directory.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "DirectoryURI"
          }
        ]
      },
      {
        "path": "Directory.directoryFilter",
        "name": "directoryFilter",
        "short": "the filter(s) that were applied to generate this directory",
        "definition": "the filter(s) that were applied to generate this directory",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Filter"
          }
        ]
      },
      {
        "path": "Directory.sortCriteria",
        "name": "sortCriteria",
        "short": "the sort criteria used in the directory",
        "definition": "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\n\t\t\t\t\t\t\t\tmandatory, meaning that all directory listings must reflect some sort order.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "SortCriteria"
          }
        ]
      }
    ]
  }
}

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.