FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.application-feature
Resource TypeOperationDefinition
IdOperationDefinition-CapabilityStatement-subset.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/HL7/capstmt/OperationDefinition-CapabilityStatement-subset.html
URLhttp://hl7.org/fhir/uv/application-feature/OperationDefinition/CapabilityStatement-subset
Version1.0.0
Statusactive
Date2021-01-05T10:01:24+11:00
NameSubset
TitleFetch a subset of the CapabilityStatement resource
Realmuv
Authorityhl7
DescriptionThis 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
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition CapabilityStatement-subset

Last updated: 2021-01-05 10:01:24+1100

URL: [base]/CapabilityStatement/$subset

URL: [base]/CapabilityStatement/[id]/$subset

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INservertype, system0..1uri

The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)

INresource1..*code

A resource that the client would like to include in the return

OUTreturn1..1CapabilityStatement

The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code


Source1

{
  "resourceType": "OperationDefinition",
  "id": "CapabilityStatement-subset",
  "meta": {
    "lastUpdated": "2021-01-05T10:01:24.148+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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/uv/application-feature/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": "active",
  "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"
    }
  ]
}