Data Model Libraries
    Preparing search index...

    Permission Class

    Permission resource holds access rules for a given data and context.

    FHIR Specification

    • Short: Access Rules
    • Definition: Permission resource holds access rules for a given data and context.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    permissionStatusEnum: PermissionStatusEnum

    FHIR CodeSystem: PermissionStatus

    status: null | EnumCodeType

    Permission.status Element

    FHIR Specification

    • Short: active | entered-in-error | draft | rejected
    • Definition: Status.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: PermissionStatusEnum

    asserter?: Reference

    Permission.asserter Element

    FHIR Specification

    date?: DateTimeType[]

    Permission.date Element

    FHIR Specification

    • Short: The date that permission was asserted
    • Definition: The date that permission was asserted.
    • FHIR Type: dateTime
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    validity?: Period

    Permission.validity Element

    FHIR Specification

    • Short: The period in which the permission is active
    • Definition: The period in which the permission is active.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Permission.justification Element

    FHIR Specification

    • Short: The asserted justification for using the data
    • Definition: The asserted justification for using the data.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    permissionRuleCombiningEnum: PermissionRuleCombiningEnum

    FHIR CodeSystem: PermissionRuleCombining

    combining: null | EnumCodeType

    Permission.combining Element

    FHIR Specification

    • Short: deny-overrides | permit-overrides | ordered-deny-overrides | ordered-permit-overrides | deny-unless-permit | permit-unless-deny
    • Definition: Defines a procedure for arriving at an access decision given the set of rules.
    • Comment: see XACML Combining Rules
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: Defines how the rules are to be combined.
    • isSummary: true

    CodeSystem Enumeration: PermissionRuleCombiningEnum

    Permission.rule Element

    FHIR Specification

    • Short: Constraints to the Permission
    • Definition: A set of rules.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Permission

      • OptionaloptSourceField: string

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

      Returns undefined | Permission

      Permission data model or undefined for Permission

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Asserter object value to the asserter property.

      Parameters

      • value: undefined | Reference

        the asserter object value

      Returns this

      this

      @ReferenceTargets('Permission.asserter', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','RelatedPerson','HealthcareService',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise