Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Example OperationDefinition/CapabilityStatement-subset (Turtle)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw Turtle (+ also see Turtle/RDF Format Specification)

Operation Definition

@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

[] a fhir:OperationDefinition;
  fhir:Resource.id [ fhir:value "CapabilityStatement-subset"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ]
  ];
  fhir:DomainResource.extension [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
     fhir:Extension.value [ fhir:value "5" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
     fhir:Extension.value [ fhir:value "trial-use" ]
  ];
  fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset"];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "Subset"];
  fhir:CanonicalResource.title [ fhir:value "Fetch a subset of the CapabilityStatement resource"];
  fhir:CanonicalResource.status [ fhir:value "draft"];
  fhir:CanonicalResource.experimental [ fhir:value "false"];
  fhir:CanonicalResource.date [ fhir:value "2022-09-07T10:58:29+10:00"];
  fhir:CanonicalResource.publisher [ fhir:value "HL7 (FHIR Project)"];
  fhir:CanonicalResource.contact [
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ], [
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
     ]
  ];
  fhir:CanonicalResource.description [ fhir:value "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"];
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset"];
  fhir:OperationDefinition.version [ fhir:value "5.0.0-ballot"];
  fhir:OperationDefinition.name [ fhir:value "Subset"];
  fhir:OperationDefinition.title [ fhir:value "Fetch a subset of the CapabilityStatement resource"];
  fhir:OperationDefinition.status [ fhir:value "draft"];
  fhir:OperationDefinition.kind [ fhir:value "operation"];
  fhir:OperationDefinition.experimental [ fhir:value "false"];
  fhir:OperationDefinition.date [ fhir:value "2022-09-07T10:58:29+10:00"];
  fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"];
  fhir:OperationDefinition.contact [
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ], [
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
     ]
  ];
  fhir:OperationDefinition.description [ fhir:value "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"];
  fhir:OperationDefinition.affectsState [ fhir:value "false"];
  fhir:OperationDefinition.code [ fhir:value "subset"];
  fhir:OperationDefinition.resource [ fhir:value "CapabilityStatement"];
  fhir:OperationDefinition.system [ fhir:value "false"];
  fhir:OperationDefinition.type [ fhir:value "true"];
  fhir:OperationDefinition.instance [ fhir:value "true"];
  fhir:OperationDefinition.parameter [
     fhir:OperationDefinitionParameterComponent.name [ fhir:value "server" ];
     fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
     fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
     fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)" ];
     fhir:OperationDefinitionParameterComponent.type [ fhir:value "uri" ]
  ], [
     fhir:OperationDefinitionParameterComponent.name [ fhir:value "resource" ];
     fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
     fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.max [ fhir:value "*" ];
     fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "A resource that the client would like to include in the return" ];
     fhir:OperationDefinitionParameterComponent.type [ fhir:value "code" ]
  ], [
     fhir:OperationDefinitionParameterComponent.name [ fhir:value "return" ];
     fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
     fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code" ];
     fhir:OperationDefinitionParameterComponent.type [ fhir:value "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.