Data Model Libraries
    Preparing search index...

    CapabilityStatementRestComponent Class

    FHIR Specification

    • Short: If the endpoint is a RESTful one
    • Definition: A definition of the restful capabilities of the solution, if any.
    • Comment: Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    restfulCapabilityModeEnum: RestfulCapabilityModeEnum

    FHIR CodeSystem: RestfulCapabilityMode

    mode: null | EnumCodeType

    CapabilityStatement.rest.mode Element

    FHIR Specification

    • Short: client | server
    • Definition: Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RestfulCapabilityModeEnum

    documentation?: MarkdownType

    CapabilityStatement.rest.documentation Element

    FHIR Specification

    • Short: General description of implementation
    • Definition: Information about the system's restful capabilities that apply across all applications, such as security.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CapabilityStatement.rest.security Element

    FHIR Specification

    • Short: Information about security of implementation
    • Definition: Information about security implementation from an interface perspective - what a client needs to know.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CapabilityStatement.rest.resource Element

    FHIR Specification

    • Short: Resource served on the REST interface
    • Definition: A specification of the restful capabilities of the solution for a specific resource type.
    • Comment: Max of one repetition per resource type.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CapabilityStatement.rest.interaction Element

    FHIR Specification

    • Short: What operations are supported?
    • Definition: A specification of restful operations supported by the system.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CapabilityStatement.rest.searchParam Element

    FHIR Specification

    • Short: Search parameters for searching all resources
    • Definition: 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.
    • Comment: Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CapabilityStatement.rest.operation Element

    FHIR Specification

    • Short: Definition of a system level operation
    • Definition: Definition of an operation or a named query together with its parameters and their meaning and type.
    • Comment: CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    compartment?: CanonicalType[]

    CapabilityStatement.rest.compartment Element

    FHIR Specification

    • Short: Compartments served/used by system
    • Definition: 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 .
    • Comment: At present, the only defined compartments are at CompartmentDefinition.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CapabilityStatementRestComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CapabilityStatementRestComponent

      CapabilityStatementRestComponent data model or undefined for CapabilityStatementRestComponent

      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