Data Model Libraries
    Preparing search index...

    ConsentPolicyBasisComponent Class

    FHIR Specification

    • Short: Computable version of the backing policy
    • Definition: A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    reference?: Reference

    Consent.policyBasis.reference Element

    FHIR Specification

    • Short: Reference backing policy resource
    • Definition: A Reference that identifies the policy the organization will enforce for this Consent.
    • Comment: While any resource may be used, Consent, PlanDefinition and Contract would be most frequent
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    url?: UrlType

    Consent.policyBasis.url Element

    FHIR Specification

    • Short: URL to a computable backing policy
    • Definition: A URL that links to a computable version of the policy the organization will enforce for this Consent.
    • FHIR Type: url
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConsentPolicyBasisComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConsentPolicyBasisComponent

      ConsentPolicyBasisComponent data model or undefined for ConsentPolicyBasisComponent

      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