CapabilityStatementRest constructor

const CapabilityStatementRest({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirCode? mode, @JsonKey(name: '_mode') Element? modeElement, FhirMarkdown? documentation, @JsonKey(name: '_documentation') Element? documentationElement, CapabilityStatementSecurity? security, List<CapabilityStatementResource>? resource, List<CapabilityStatementInteraction1>? interaction, List<CapabilityStatementSearchParam>? searchParam, List<CapabilityStatementOperation>? operation, List<FhirCanonical>? compartment, })

CapabilityStatementRest A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

mode Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

modeElement ("_mode") Extensions for mode

documentation Information about the system's restful capabilities that apply across all applications, such as security.

documentationElement ("_documentation") Extensions for documentation

security Information about security implementation from an interface perspective - what a client needs to know.

resource A specification of the restful capabilities of the solution for a specific resource type.

interaction A specification of restful operations supported by the system.

searchParam Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint.

operation Definition of an operation or a named query together with its parameters and their meaning and type.

compartment An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .

Implementation

const factory CapabilityStatementRest({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the element.
  ///  To make the use of extensions safe and managable, there is a strict
  ///  set of governance applied to the definition and use of extensions.
  ///  Though any implementer can define an extension, there is a set of
  ///  requirements that SHALL be met as part of the definition of the
  ///  extension.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] May be used to represent additional information
  ///  that is not part of the basic definition of the element and that
  ///  modifies the understanding of the element in which it is contained
  ///  and/or the understanding of the containing element's descendants.
  ///  Usually modifier elements provide negation or qualification. To make
  ///  the use of extensions safe and managable, there is a strict set of
  ///  governance applied to the definition and use of extensions. Though any
  ///  implementer can define an extension, there is a set of requirements
  ///  that SHALL be met as part of the definition of the extension.
  ///  Applications processing a resource are required to check for modifier
  ///  extensions.Modifier extensions SHALL NOT change the meaning of any
  ///  elements on Resource or DomainResource (including cannot change the
  ///  meaning of modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [mode] Identifies whether this portion of the statement is describing
  ///  the ability to initiate or receive restful operations.
  FhirCode? mode,

  /// [modeElement] ("_mode") Extensions for mode
  @JsonKey(name: '_mode') Element? modeElement,

  /// [documentation] Information about the system's restful capabilities
  ///  that apply across all applications, such as security.
  FhirMarkdown? documentation,

  /// [documentationElement] ("_documentation") Extensions for documentation
  @JsonKey(name: '_documentation') Element? documentationElement,

  /// [security] Information about security implementation from an interface
  ///  perspective - what a client needs to know.
  CapabilityStatementSecurity? security,

  /// [resource] A specification of the restful capabilities of the solution
  ///  for a specific resource type.
  List<CapabilityStatementResource>? resource,

  /// [interaction] A specification of restful operations supported by the
  ///  system.
  List<CapabilityStatementInteraction1>? interaction,

  /// [searchParam] Search parameters that are supported for searching all
  ///  resources for implementations to support and/or make use of - either
  ///  references to ones defined in the specification, or additional ones
  ///  defined for/by the implementation. This is only for searches executed
  ///  against the system-level endpoint.
  List<CapabilityStatementSearchParam>? searchParam,

  /// [operation] Definition of an operation or a named query together with
  ///  its parameters and their meaning and type.
  List<CapabilityStatementOperation>? operation,

  /// [compartment] An absolute URI which is a reference to the definition of
  ///  a compartment that the system supports. The reference is to a
  ///  CompartmentDefinition resource by its canonical URL .
  List<FhirCanonical>? compartment,
}) = _CapabilityStatementRest;