Data Model Libraries
    Preparing search index...

    Class Consent

    Consent Class

    A record of a healthcare consumer's choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

    FHIR Specification

    • Short: A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
    • Definition: A record of a healthcare consumer's choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
    • Comment: Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.
    • FHIR Version: 5.0.0

    FHIR Consent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? consentStateCodesEnum status category? subject? date? period? grantor? grantee? manager? controller? sourceAttachment? sourceReference? regulatoryBasis? policyBasis? policyText? verification? consentProvisionTypeEnum decision? provision?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getSubject setSubject hasSubject getDateElement setDateElement hasDateElement getDate setDate hasDate getPeriod setPeriod hasPeriod getGrantor setGrantor addGrantor hasGrantor getGrantee setGrantee addGrantee hasGrantee getManager setManager addManager hasManager getController setController addController hasController getSourceAttachment setSourceAttachment addSourceAttachment hasSourceAttachment getSourceReference setSourceReference addSourceReference hasSourceReference getRegulatoryBasis setRegulatoryBasis addRegulatoryBasis hasRegulatoryBasis getPolicyBasis setPolicyBasis hasPolicyBasis getPolicyText setPolicyText addPolicyText hasPolicyText getVerification setVerification addVerification hasVerification getDecisionEnumType setDecisionEnumType hasDecisionEnumType getDecisionElement setDecisionElement hasDecisionElement getDecision setDecision hasDecision getProvision setProvision addProvision hasProvision fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initGrantor initGrantee initManager initController initSourceAttachment initSourceReference initRegulatoryBasis initPolicyText initVerification initProvision

    Constructors

    Properties

    identifier?: Identifier[]

    Consent.identifier Element

    FHIR Specification

    • Short: Identifier for this record (external references)
    • Definition: Unique identifier for this copy of the Consent Statement.
    • Comment: This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    consentStateCodesEnum: ConsentStateCodesEnum

    FHIR CodeSystem: ConsentStateCodes

    ConsentStateCodesEnum

    status: null | EnumCodeType

    Consent.status Element

    FHIR Specification

    • Short: draft | active | inactive | not-done | entered-in-error | unknown
    • Definition: Indicates the current state of this Consent resource.
    • Comment: This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ConsentStateCodesEnum

    category?: CodeableConcept[]

    Consent.category Element

    FHIR Specification

    • Short: Classification of the consent statement - for indexing/retrieval
    • Definition: A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference

    Consent.subject Element

    FHIR Specification

    date?: DateType

    Consent.date Element

    FHIR Specification

    • Short: Fully executed date of the consent
    • Definition: Date the consent instance was agreed to.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    Consent.period Element

    FHIR Specification

    • Short: Effective period for this Consent
    • Definition: Effective period for this Consent Resource and all provisions unless specified in that provision.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    grantor?: Reference[]

    Consent.grantor Element

    FHIR Specification

    grantee?: Reference[]

    Consent.grantee Element

    FHIR Specification

    manager?: Reference[]

    Consent.manager Element

    FHIR Specification

    controller?: Reference[]

    Consent.controller Element

    FHIR Specification

    sourceAttachment?: Attachment[]

    Consent.sourceAttachment Element

    FHIR Specification

    • Short: Source from which this consent is taken
    • Definition: The source on which this consent statement is based. The source might be a scanned original paper form.
    • Comment: The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    sourceReference?: Reference[]

    Consent.sourceReference Element

    FHIR Specification

    regulatoryBasis?: CodeableConcept[]

    Consent.regulatoryBasis Element

    FHIR Specification

    • Short: Regulations establishing base Consent
    • Definition: A set of codes that indicate the regulatory basis (if any) that this consent supports.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    policyBasis?: ConsentPolicyBasisComponent

    Consent.policyBasis Element

    FHIR Specification

    • Short: Computable version of the backing policy
    • Definition: A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    policyText?: Reference[]

    Consent.policyText Element

    FHIR Specification

    verification?: ConsentVerificationComponent[]

    Consent.verification Element

    FHIR Specification

    • Short: Consent Verified by patient or family
    • Definition: Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    consentProvisionTypeEnum: ConsentProvisionTypeEnum

    FHIR CodeSystem: ConsentProvisionType

    ConsentProvisionTypeEnum

    decision?: EnumCodeType

    Consent.decision Element

    FHIR Specification

    • Short: deny | permit
    • Definition: Action to take - permit or deny - as default.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: Sets context for the values in .provision
    • isSummary: true

    CodeSystem Enumeration: ConsentProvisionTypeEnum

    provision?: ConsentProvisionComponent[]

    Consent.provision Element

    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 Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Consent

      • OptionaloptSourceField: string

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

      Returns undefined | Consent

      Consent data model or undefined for Consent

      JsonError if the provided JSON is not a valid JSON object

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

      Parameters

      • value: undefined | Reference[]

        the grantor array value

      Returns this

      this

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

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the grantor value

      Returns this

      this

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

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the grantee array value

      Returns this

      this

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

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the grantee value

      Returns this

      this

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

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the manager array value

      Returns this

      this

      @ReferenceTargets('Consent.manager', ['HealthcareService','Organization','Patient','Practitioner',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the controller array value

      Returns this

      this

      @ReferenceTargets('Consent.controller', ['HealthcareService','Organization','Patient','Practitioner',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the controller value

      Returns this

      this

      @ReferenceTargets('Consent.controller', ['HealthcareService','Organization','Patient','Practitioner',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the sourceReference array value

      Returns this

      this

      @ReferenceTargets('Consent.sourceReference', ['Consent','DocumentReference','Contract','QuestionnaireResponse',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the sourceReference value

      Returns this

      this

      @ReferenceTargets('Consent.sourceReference', ['Consent','DocumentReference','Contract','QuestionnaireResponse',])

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetSubjectsetSubjecthasSubjectgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPeriodsetPeriodhasPeriodgetGrantorsetGrantoraddGrantorhasGrantorgetGranteesetGranteeaddGranteehasGranteegetManagersetManageraddManagerhasManagergetControllersetControlleraddControllerhasControllergetSourceAttachmentsetSourceAttachmentaddSourceAttachmenthasSourceAttachmentgetSourceReferencesetSourceReferenceaddSourceReferencehasSourceReferencegetRegulatoryBasissetRegulatoryBasisaddRegulatoryBasishasRegulatoryBasisgetPolicyBasissetPolicyBasishasPolicyBasisgetPolicyTextsetPolicyTextaddPolicyTexthasPolicyTextgetVerificationsetVerificationaddVerificationhasVerificationgetDecisionEnumTypesetDecisionEnumTypehasDecisionEnumTypegetDecisionElementsetDecisionElementhasDecisionElementgetDecisionsetDecisionhasDecisiongetProvisionsetProvisionaddProvisionhasProvisionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitGrantorinitGranteeinitManagerinitControllerinitSourceAttachmentinitSourceReferenceinitRegulatoryBasisinitPolicyTextinitVerificationinitProvision