Data Model Libraries
    Preparing search index...

    Class ConsentProvisionComponent

    ConsentProvisionComponent Class

    FHIR Specification

    • Short: Constraints to the base Consent.policyRule/Consent.policy
    • Definition: An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

    FHIR Consent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    period? actor? action? securityLabel? purpose? documentType? resourceType? code? dataPeriod? data? expression? provision?

    Methods

    parse getPeriod setPeriod hasPeriod getActor setActor addActor hasActor getAction setAction addAction hasAction getSecurityLabel setSecurityLabel addSecurityLabel hasSecurityLabel getPurpose setPurpose addPurpose hasPurpose getDocumentType setDocumentType addDocumentType hasDocumentType getResourceType setResourceType addResourceType hasResourceType getCode setCode addCode hasCode getDataPeriod setDataPeriod hasDataPeriod getData setData addData hasData getExpression setExpression hasExpression getProvision setProvision addProvision hasProvision fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initActor initAction initSecurityLabel initPurpose initDocumentType initResourceType initCode initData initProvision

    Constructors

    Properties

    period?: Period

    Consent.provision.period Element

    FHIR Specification

    • Short: Timeframe for this provision
    • Definition: Timeframe for this provision.
    • Comment: This is the bound effective time of the consent and should be in the base provision in the Consent resource.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    actor?: ConsentProvisionActorComponent[]

    Consent.provision.actor Element

    FHIR Specification

    • Short: Who|what controlled by this provision (or group, by role)
    • Definition: Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    action?: CodeableConcept[]

    Consent.provision.action Element

    FHIR Specification

    • Short: Actions controlled by this provision
    • Definition: Actions controlled by this provision.
    • 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
    securityLabel?: Coding[]

    Consent.provision.securityLabel Element

    FHIR Specification

    • Short: Security Labels that define affected resources
    • Definition: A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
    • Comment: If the consent specifies 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
    purpose?: Coding[]

    Consent.provision.purpose Element

    FHIR Specification

    • Short: Context of activities covered by this provision
    • Definition: The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision.
    • Comment: 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
    documentType?: Coding[]

    Consent.provision.documentType Element

    FHIR Specification

    • Short: e.g. Resource Type, Profile, CDA, etc
    • Definition: The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.
    • Comment: Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    resourceType?: Coding[]

    Consent.provision.resourceType Element

    FHIR Specification

    • Short: e.g. Resource Type, Profile, etc
    • Definition: The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.
    • Comment: Multiple types are or'ed together. The intention of the resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept[]

    Consent.provision.code Element

    FHIR Specification

    • Short: e.g. LOINC or SNOMED CT code, etc. in the content
    • Definition: If this code is found in an instance, then the provision applies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    dataPeriod?: Period

    Consent.provision.dataPeriod Element

    FHIR Specification

    • Short: Timeframe for data controlled by this provision
    • Definition: Clinical or Operational Relevant period of time that bounds the data controlled by this provision.
    • Comment: This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    data?: ConsentProvisionDataComponent[]

    Consent.provision.data Element

    FHIR Specification

    • Short: Data controlled by this provision
    • Definition: The resources controlled by this provision if specific resources are referenced.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    expression?: Expression

    Consent.provision.expression Element

    FHIR Specification

    • Short: A computable expression of the consent
    • Definition: A computable (FHIRPath or other) definition of what is controlled by this consent.
    • Comment: Constraining the expression type for a specific implementation via profile is recommended
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    provision?: ConsentProvisionComponent[]

    Consent.provision.provision Element

    FHIR Specification

    • Short: Nested Exception Provisions
    • Definition: Provisions which provide exceptions to the base provision or subprovisions.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConsentProvisionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConsentProvisionComponent

      ConsentProvisionComponent data model or undefined for ConsentProvisionComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetPeriodsetPeriodhasPeriodgetActorsetActoraddActorhasActorgetActionsetActionaddActionhasActiongetSecurityLabelsetSecurityLabeladdSecurityLabelhasSecurityLabelgetPurposesetPurposeaddPurposehasPurposegetDocumentTypesetDocumentTypeaddDocumentTypehasDocumentTypegetResourceTypesetResourceTypeaddResourceTypehasResourceTypegetCodesetCodeaddCodehasCodegetDataPeriodsetDataPeriodhasDataPeriodgetDatasetDataaddDatahasDatagetExpressionsetExpressionhasExpressiongetProvisionsetProvisionaddProvisionhasProvisionfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitActorinitActioninitSecurityLabelinitPurposeinitDocumentTypeinitResourceTypeinitCodeinitDatainitProvision