Data Model Libraries
    Preparing search index...

    MessageDefinitionFocusComponent Class

    FHIR Specification

    • Short: Resource(s) that are the subject of the event
    • Definition: Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    resourceTypesEnum: ResourceTypesEnum

    FHIR CodeSystem: ResourceTypes

    code: null | EnumCodeType

    MessageDefinition.focus.code Element

    FHIR Specification

    • Short: Type of resource
    • Definition: The kind of resource that must be the focus for this message.
    • Comment: Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResourceTypesEnum

    profile?: CanonicalType

    MessageDefinition.focus.profile Element

    FHIR Specification

    • Short: Profile that must be adhered to by focus
    • Definition: A profile that reflects constraints for the focal resource (and potentially for related resources).
    • Comment: This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.
    • Requirements: This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    min: null | UnsignedIntType

    MessageDefinition.focus.min Element

    FHIR Specification

    • Short: Minimum number of focuses of this type
    • Definition: Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
    • FHIR Type: unsignedInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    MessageDefinition.focus.max Element

    FHIR Specification

    • Short: Maximum number of focuses of this type
    • Definition: Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageDefinitionFocusComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MessageDefinitionFocusComponent

      MessageDefinitionFocusComponent data model or undefined for MessageDefinitionFocusComponent

      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