Data Model Libraries
    Preparing search index...

    Class ContractTermSecurityLabelComponent

    ContractTermSecurityLabelComponent Class

    FHIR Specification

    • Short: Protection for the Term
    • Definition: Security labels that protect the handling of information about the term and its elements, which may be specifically identified.
    • Comment: Within a Contract, a security label may apply to the one to many nested group of terms or to a term, whether inside a group or a singleton. The security label on the entire set of term provision elements may be different from the security labels on a contained offer, asset, valuedItem, or data such as sensitive information, and must be the high water mark of all security labels within the term. Rationale is that a labelled term, which may be disaggregated from the Contract, and must persist the label on the term and on contained elements within other contexts. If more than one policy dictates a level of confidentiality of the term, then each applicable policy may be represented by a security label specific to its requirements. A Security Label is comprised of 1..1 confidentiality code and 0..* other security label codes (aka "privacy tags". A Security Label is metadata assigned (aka "tagged") to Resources and Resource elements, which specify the confidentiality and sensitivity of the Resource or element and their related attributes, the purposes for which tagged items may be collected, access, used or disclosed, any limitation on the type of entities authorized to engage in permitted purposes, and handling instructions that obligate or prohibit certain actions on the tagged items.
    • Requirements: This security label protects the term and its contained provision elements.

    FHIR Contract

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    number? classification category? control?

    Methods

    parse getNumberElement setNumberElement addNumberElement hasNumberElement getNumber setNumber addNumber hasNumber getClassification setClassification hasClassification getCategory setCategory addCategory hasCategory getControl setControl addControl hasControl fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initNumber initCategory initControl

    Constructors

    Properties

    number?: UnsignedIntType[]

    Contract.term.securityLabel.number Element

    FHIR Specification

    • Short: Link to Security Labels
    • Definition: Number used to link this term or term element to the applicable Security Label.
    • FHIR Type: unsignedInt
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    classification: null | Coding

    Contract.term.securityLabel.classification Element

    FHIR Specification

    • Short: Confidentiality Protection
    • Definition: Security label privacy tag that specifies the level of confidentiality protection required for this term and/or term elements.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    category?: Coding[]

    Contract.term.securityLabel.category Element

    FHIR Specification

    • Short: Applicable Policy
    • Definition: Security label privacy tag that specifies the applicable privacy and security policies governing this term and/or term elements.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    control?: Coding[]

    Contract.term.securityLabel.control Element

    FHIR Specification

    • Short: Handling Instructions
    • Definition: Security label privacy tag that specifies the manner in which term and/or term elements are to be protected.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ContractTermSecurityLabelComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ContractTermSecurityLabelComponent

      ContractTermSecurityLabelComponent data model or undefined for ContractTermSecurityLabelComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods