Data Model Libraries
    Preparing search index...

    PermissionRuleDataComponent Class

    FHIR Specification

    • Short: The selection criteria to identify data that is within scope of this provision
    • Definition: A description or definition of which activities are allowed to be done on the data.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Permission.rule.data.resource Element

    FHIR Specification

    • Short: Explicit FHIR Resource references
    • Definition: Explicit FHIR Resource references.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    security?: Coding[]

    Permission.rule.data.security Element

    FHIR Specification

    • Short: Security tag code on .meta.security
    • Definition: The data in scope are those with the given codes present in that data .meta.security element.
    • Comment: Note the ConfidentialityCode vocabulary indicates the highest value, thus a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    period?: Period[]

    Permission.rule.data.period Element

    FHIR Specification

    • Short: Timeframe encompasing data create/update
    • Definition: Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
    • Comment: This has a different sense to the .validity.
    • FHIR Type: Period
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    expression?: Expression

    Permission.rule.data.expression Element

    FHIR Specification

    • Short: Expression identifying the data
    • Definition: Used when other data selection elements are insufficient.
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PermissionRuleDataComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PermissionRuleDataComponent

      PermissionRuleDataComponent data model or undefined for PermissionRuleDataComponent

      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