Data Model Libraries
    Preparing search index...

    PermissionRuleActivityComponent Class

    FHIR Specification

    • Short: A description or definition of which activities are allowed to be done on the data
    • Definition: A description or definition of which activities are allowed to be done on the data.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    actor?: Reference[]

    Permission.rule.activity.actor Element

    action?: CodeableConcept[]

    Permission.rule.activity.action Element

    FHIR Specification

    • Short: Actions controlled by this rule
    • Definition: Actions controlled by this Rule.
    • Comment: Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: CodeableConcept[]

    Permission.rule.activity.purpose Element

    FHIR Specification

    • Short: The purpose for which the permission is given
    • Definition: The purpose for which the permission is given.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PermissionRuleActivityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PermissionRuleActivityComponent

      PermissionRuleActivityComponent data model or undefined for PermissionRuleActivityComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the actor property.

      Parameters

      • value: undefined | Reference[]

        the actor array value

      Returns this

      this

      @ReferenceTargets('Permission.rule.activity.actor', ['Device','Group','CareTeam','Organization','Patient','Practitioner','RelatedPerson','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the actor array property.

      Parameters

      Returns this

      this

      @ReferenceTargets('Permission.rule.activity.actor', ['Device','Group','CareTeam','Organization','Patient','Practitioner','RelatedPerson','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • 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