Data Model Libraries
    Preparing search index...

    Class CapabilityStatementRestResourceInteractionComponent

    CapabilityStatementRestResourceInteractionComponent Class

    FHIR Specification

    • Short: What operations are supported?
    • Definition: Identifies a restful operation supported by the solution.
    • Comment: In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    restfulInteractionEnum: RestfulInteractionEnum

    FHIR CodeSystem: RestfulInteraction

    code: null | EnumCodeType

    CapabilityStatement.rest.resource.interaction.code Element

    FHIR Specification

    • Short: read | vread | update | patch | delete | history-instance | history-type | create | search-type
    • Definition: Coded identifier of the operation, supported by the system resource.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RestfulInteractionEnum

    documentation?: MarkdownType

    CapabilityStatement.rest.resource.interaction.documentation Element

    FHIR Specification

    • Short: Anything special about operation behavior
    • Definition: Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
    • Requirements: REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CapabilityStatementRestResourceInteractionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CapabilityStatementRestResourceInteractionComponent

      CapabilityStatementRestResourceInteractionComponent data model or undefined for CapabilityStatementRestResourceInteractionComponent

      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