FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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 . Page versions: R5 R4B R4 R3

Operation-capabilitystatement-subset.json

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw JSON (canonical form)

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "CapabilityStatement-subset",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset",
  "name": "Fetch a subset of the CapabilityStatement resource",
  "status": "draft",
  "kind": "operation",
  "date": "2019-10-24T11:53:00+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "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",
  "code": "subset",
  "resource": [
    "CapabilityStatement"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "server",
      "use": "in",
      "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"
    }
  ]
}

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.