Data Model Libraries
    Preparing search index...

    ConsentPolicyComponent Class

    FHIR Specification

    • Short: Policies covered by this consent
    • Definition: The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    authority?: UriType

    Consent.policy.authority Element

    FHIR Specification

    • Short: Enforcement source for policy
    • Definition: Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    uri?: UriType

    Consent.policy.uri Element

    FHIR Specification

    • Short: Specific policy covered by this consent
    • Definition: The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
    • Comment: This element is for discoverability / documentation and does not modify or qualify the policy rules.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConsentPolicyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConsentPolicyComponent

      ConsentPolicyComponent data model or undefined for ConsentPolicyComponent

      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