Data Model Libraries
    Preparing search index...

    ConsentVerificationComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    verified: null | BooleanType

    Consent.verification.verified Element

    FHIR Specification

    • Short: Has been verified
    • Definition: Has the instruction been verified.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    verificationType?: CodeableConcept

    Consent.verification.verificationType Element

    FHIR Specification

    • Short: Business case of verification
    • Definition: Extensible list of verification type starting with verification and re-validation.
    • Comment: This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    verifiedBy?: Reference

    Consent.verification.verifiedBy Element

    FHIR Specification

    verifiedWith?: Reference

    Consent.verification.verifiedWith Element

    FHIR Specification

    verificationDate?: DateTimeType[]

    Consent.verification.verificationDate Element

    FHIR Specification

    • Short: When consent verified
    • Definition: Date(s) verification was collected.
    • Comment: Allows for history of verification/validation.
    • FHIR Type: dateTime
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConsentVerificationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConsentVerificationComponent

      ConsentVerificationComponent data model or undefined for ConsentVerificationComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided VerifiedBy object value to the verifiedBy property.

      Parameters

      • value: undefined | Reference

        the verifiedBy object value

      Returns this

      this

      @ReferenceTargets('Consent.verification.verifiedBy', ['Organization','Practitioner','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided VerifiedWith object value to the verifiedWith property.

      Parameters

      • value: undefined | Reference

        the verifiedWith object value

      Returns this

      this

      @ReferenceTargets('Consent.verification.verifiedWith', ['Patient','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • 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