Data Model Libraries
    Preparing search index...

    Class Consent

    Consent Class

    A record of a healthcare consumer's choices, 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 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, 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 general advance care directives.
    • FHIR Version: 4.0.1

    FHIR Consent

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? consentStateCodesEnum status scope category patient? dateTime? performer? organization? source? policy? policyRule? verification? provision?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getScope setScope hasScope getCategory setCategory addCategory hasCategory getPatient setPatient hasPatient getDateTimeElement setDateTimeElement hasDateTimeElement getDateTime setDateTime hasDateTime getPerformer setPerformer addPerformer hasPerformer getOrganization setOrganization addOrganization hasOrganization getSource setSource hasSource getSourceAttachment hasSourceAttachment getSourceReference hasSourceReference getPolicy setPolicy addPolicy hasPolicy getPolicyRule setPolicyRule hasPolicyRule getVerification setVerification addVerification hasVerification getProvision setProvision 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 initPerformer initOrganization initPolicy initVerification

    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 | proposed | active | rejected | inactive | entered-in-error
    • Definition: Indicates the current state of this consent.
    • 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.
    • Requirements: The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.
    • 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

    scope: null | CodeableConcept

    Consent.scope Element

    FHIR Specification

    • Short: Which of the four areas this resource covers (extensible)
    • Definition: A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: Allows changes to codes based on scope selection
    • isSummary: true
    category: null | 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: 1..*
    • isModifier: false
    • isSummary: true
    patient?: Reference

    Consent.patient Element

    FHIR Specification

    • Short: Who the consent applies to
    • Definition: The patient/healthcare consumer to whom this consent applies.
    • Comment: Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dateTime?: DateTimeType

    Consent.dateTime Element

    FHIR Specification

    • Short: When this Consent was created or indexed
    • Definition: When this Consent was issued / created / indexed.
    • Comment: This is not the time of the original consent, but the time that this statement was made or derived.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: Reference[]

    Consent.performer Element

    FHIR Specification

    organization?: Reference[]

    Consent.organization Element

    FHIR Specification

    • Short: Custodian of the consent
    • Definition: The organization that manages the consent, and the framework within which it is executed.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    source?: IDataType

    Consent.source[x] Element

    @ChoiceDataTypesMeta('Consent.source[x]', ['Attachment','Reference',]

    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, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
    • 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 Types: 'Attachment', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    policy?: ConsentPolicyComponent[]

    Consent.policy Element

    FHIR Specification

    • Short: Policies covered by this consent
    • Definition: The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    policyRule?: CodeableConcept

    Consent.policyRule Element

    FHIR Specification

    • Short: Regulation that this consents to
    • Definition: A reference to the specific base computable regulation or policy.
    • Comment: If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.
    • Requirements: Might be a unique identifier of a policy set in XACML, or other rules engine.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    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
    provision?: ConsentProvisionComponent

    Consent.provision Element

    FHIR Specification

    • Short: Constraints to the base Consent.policyRule
    • 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..1
    • 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 performer property.

      Parameters

      • value: undefined | Reference[]

        the performer array value

      Returns this

      this

      @ReferenceTargets('Consent.performer', ['Organization','Patient','Practitioner','RelatedPerson','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the performer value

      Returns this

      this

      @ReferenceTargets('Consent.performer', ['Organization','Patient','Practitioner','RelatedPerson','PractitionerRole',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetScopesetScopehasScopegetCategorysetCategoryaddCategoryhasCategorygetPatientsetPatienthasPatientgetDateTimeElementsetDateTimeElementhasDateTimeElementgetDateTimesetDateTimehasDateTimegetPerformersetPerformeraddPerformerhasPerformergetOrganizationsetOrganizationaddOrganizationhasOrganizationgetSourcesetSourcehasSourcegetSourceAttachmenthasSourceAttachmentgetSourceReferencehasSourceReferencegetPolicysetPolicyaddPolicyhasPolicygetPolicyRulesetPolicyRulehasPolicyRulegetVerificationsetVerificationaddVerificationhasVerificationgetProvisionsetProvisionhasProvisionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitPerformerinitOrganizationinitPolicyinitVerification