Data Model Libraries
    Preparing search index...

    Class Signature

    Signature Class

    Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

    There are a number of places where content must be signed in healthcare.

    FHIR Specification

    • Short: A Signature - XML DigSig, JWS, Graphical image of signature, etc.
    • Definition: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
    • Comment: The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.
    • FHIR Version: 5.0.0

    FHIR Signature

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? when? who? onBehalfOf? targetFormat? sigFormat? data?

    Methods

    parse getType setType addType hasType getWhenElement setWhenElement hasWhenElement getWhen setWhen hasWhen getWho setWho hasWho getOnBehalfOf setOnBehalfOf hasOnBehalfOf getTargetFormatElement setTargetFormatElement hasTargetFormatElement getTargetFormat setTargetFormat hasTargetFormat getSigFormatElement setSigFormatElement hasSigFormatElement getSigFormat setSigFormat hasSigFormat getDataElement setDataElement hasDataElement getData setData hasData fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initType

    Constructors

    Properties

    Private Optionaltype_

    type_?: Coding[]

    Signature.type Element

    FHIR Specification

    • Short: Indication of the reason the entity signed the object(s)
    • Definition: An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
    • Comment: Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    when?: InstantType

    Signature.when Element

    FHIR Specification

    • Short: When the signature was created
    • Definition: When the digital signature was signed.
    • Comment: This should agree with the information in the signature.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    who?: Reference

    Signature.who Element

    FHIR Specification

    onBehalfOf?: Reference

    Signature.onBehalfOf Element

    FHIR Specification

    targetFormat?: CodeType

    Signature.targetFormat Element

    FHIR Specification

    • Short: The technical format of the signed resources
    • Definition: A mime type that indicates the technical format of the target resources signed by the signature.
    • Comment: "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    sigFormat?: CodeType

    Signature.sigFormat Element

    FHIR Specification

    • Short: The technical format of the signature
    • Definition: A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    data?: Base64BinaryType

    Signature.data Element

    FHIR Specification

    • Short: The actual signature content (XML DigSig. JWS, picture, etc.)
    • Definition: The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
    • Comment: Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Signature

      • OptionaloptSourceField: string

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

      Returns undefined | Signature

      Signature data model or undefined for Signature

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • 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

    • 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

    • 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 resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods