Data Model Libraries
    Preparing search index...

    Class HealthcareServiceEligibilityComponent

    HealthcareServiceEligibilityComponent Class

    FHIR Specification

    • Short: Specific eligibility requirements required to use the service
    • Definition: Does this service have specific eligibility requirements that need to be met in order to use the service?

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    HealthcareService.eligibility.code Element

    FHIR Specification

    • Short: Coded value for the eligibility
    • Definition: Coded value for the eligibility.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    comment?: MarkdownType

    HealthcareService.eligibility.comment Element

    FHIR Specification

    • Short: Describes the eligibility conditions for the service
    • Definition: Describes the eligibility conditions for the service.
    • Comment: The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR HealthcareServiceEligibilityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | HealthcareServiceEligibilityComponent

      HealthcareServiceEligibilityComponent data model or undefined for HealthcareServiceEligibilityComponent

      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