Data Model Libraries
    Preparing search index...

    EndpointPayloadComponent Class

    FHIR Specification

    • Short: Set of payloads that are provided by this endpoint
    • Definition: The set of payloads that are provided/available at this endpoint.
    • Comment: Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_?: CodeableConcept[]

    Endpoint.payload.type Element

    FHIR Specification

    • Short: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    • Definition: The payload type describes the acceptable content that can be communicated on the endpoint.
    • Comment: The mimeType describes the serialization format of the data, where the payload.type indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    mimeType?: CodeType[]

    Endpoint.payload.mimeType Element

    FHIR Specification

    • Short: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
    • Definition: The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
    • Comment: Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EndpointPayloadComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EndpointPayloadComponent

      EndpointPayloadComponent data model or undefined for EndpointPayloadComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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