Data Model Libraries
    Preparing search index...

    Class CapabilityStatementRestResourceOperationComponent

    CapabilityStatementRestResourceOperationComponent Class

    FHIR Specification

    • Short: Definition of a resource operation
    • Definition: Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
    • Comment: Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name: null | StringType

    FHIR Specification

    • Short: Name by which the operation/query is invoked
    • Definition: The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
    • Comment: The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    definition: null | CanonicalType

    CapabilityStatement.rest.resource.operation.definition Element

    FHIR Specification

    • Short: The defined operation/query
    • Definition: Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as http://hl7.org/fhir/OperationDefinition/ValueSet-expand), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom OperationDefinition with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
    • Comment: This can be used to build an HTML form to invoke the operation, for instance.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    documentation?: MarkdownType

    CapabilityStatement.rest.resource.operation.documentation Element

    FHIR Specification

    • Short: Specific details about operation behavior
    • Definition: Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CapabilityStatementRestResourceOperationComponent JSON to instantiate the CapabilityStatementRestResourceOperationComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CapabilityStatementRestResourceOperationComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CapabilityStatementRestResourceOperationComponent

      Returns undefined | CapabilityStatementRestResourceOperationComponent

      CapabilityStatementRestResourceOperationComponent data model or undefined for CapabilityStatementRestResourceOperationComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise