Data Model Libraries
    Preparing search index...

    Class DocumentReferenceContentComponent

    DocumentReferenceContentComponent Class

    FHIR Specification

    • Short: Document referenced
    • Definition: The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.
    • Comment: content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.
    • Requirements: Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.

    FHIR DocumentReference

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    attachment profile?

    Methods

    parse getAttachment setAttachment hasAttachment getProfile setProfile addProfile hasProfile fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initProfile

    Constructors

    Properties

    attachment: null | Attachment

    DocumentReference.content.attachment Element

    FHIR Specification

    • Short: Where to access the document
    • Definition: The document or URL of the document along with critical metadata to prove content has integrity.
    • FHIR Type: Attachment
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    profile?: DocumentReferenceContentProfileComponent[]

    DocumentReference.content.profile Element

    FHIR Specification

    • Short: Content profile rules for the document
    • Definition: An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
    • Comment: Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI. For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DocumentReferenceContentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DocumentReferenceContentComponent

      DocumentReferenceContentComponent data model or undefined for DocumentReferenceContentComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods