FHIR Application Feature Framework Implementation Guide, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/capstmt/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Fetch a subset of the CapabilityStatement resource - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "CapabilityStatement-subset",
  "meta" : {
    "lastUpdated" : "2021-01-05T10:01:24.148+11:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CapabilityStatement-subset</b></p><a name=\"CapabilityStatement-subset\"> </a><a name=\"hcCapabilityStatement-subset\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Last updated: 2021-01-05 10:01:24+1100</p></div><p>URL: [base]/CapabilityStatement/$subset</p><p>URL: [base]/CapabilityStatement/[id]/$subset</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>server</td><td>type, system</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#uri\">uri</a></td><td/><td><div><p>The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)</p>\n</div></td></tr><tr><td>IN</td><td>resource</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R5/datatypes.html#code\">code</a></td><td/><td><div><p>A resource that the client would like to include in the return</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/capabilitystatement.html\">CapabilityStatement</a></td><td/><td><div><p>The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 5
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    },
    {
      "extension" : [
        {
          "url" : "list",
          "valueString" : "1"
        },
        {
          "url" : "response",
          "valueBoolean" : false
        },
        {
          "url" : "content",
          "valueString" : "$subset-request.txt"
        }
      ],
      "url" : "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "extension" : [
        {
          "url" : "list",
          "valueString" : "1"
        },
        {
          "url" : "response",
          "valueBoolean" : true
        },
        {
          "url" : "content",
          "valueString" : "$subset-response.txt"
        }
      ],
      "url" : "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }
  ],
  "url" : "http://hl7.org/fhir/build/OperationDefinition/CapabilityStatement-subset",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.32.6"
    }
  ],
  "version" : "1.0.0",
  "name" : "Subset",
  "title" : "Fetch a subset of the CapabilityStatement resource",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "name" : "HL7 International / FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "subset",
  "resource" : [
    "CapabilityStatement"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "server",
      "use" : "in",
      "scope" : [
        "type",
        "system"
      ],
      "min" : 0,
      "max" : "1",
      "documentation" : "The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)",
      "type" : "uri"
    },
    {
      "name" : "resource",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "A resource that the client would like to include in the return",
      "type" : "code"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code",
      "type" : "CapabilityStatement"
    }
  ]
}