Data Model Libraries
    Preparing search index...

    Class DocumentReferenceRelatesToComponent

    DocumentReferenceRelatesToComponent Class

    FHIR Specification

    • Short: Relationships to other documents
    • Definition: Relationships that this document has with other document references that already exist.
    • Comment: This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    documentRelationshipTypeEnum: DocumentRelationshipTypeEnum

    FHIR CodeSystem: DocumentRelationshipType

    code: null | EnumCodeType

    DocumentReference.relatesTo.code Element

    FHIR Specification

    • Short: replaces | transforms | signs | appends
    • Definition: The type of relationship that this document has with anther document.
    • Comment: If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: DocumentRelationshipTypeEnum

    target: null | Reference

    DocumentReference.relatesTo.target Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DocumentReferenceRelatesToComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DocumentReferenceRelatesToComponent

      DocumentReferenceRelatesToComponent data model or undefined for DocumentReferenceRelatesToComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise