Data Model Libraries
    Preparing search index...

    Class Narrative

    Narrative Class

    Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.

    While both status and div cannot be undefined, either may be initialized via the constructor to null. However, both status and div cannot be set (reassigned) to null. This supports the rare need to initialize Narrative as "empty".

    FHIR Specification

    • Short: Human-readable summary of the resource (essential clinical and business information)
    • Definition: A human-readable summary of the resource conveying the essential clinical and business information for the resource.
    • FHIR Version: 4.0.1

    FHIR Narrative

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    narrativeStatusEnum status div

    Methods

    parse getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDivElement setDivElement hasDivElement getDiv setDiv hasDiv fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    narrativeStatusEnum: any

    FHIR CodeSystem: NarrativeStatus

    NarrativeStatusEnum

    status: any

    Narrative.status Element

    FHIR Specification

    • Short: generated | extensions | additional | empty
    • Definition: The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    div: any

    Narrative.div Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Narrative

      • OptionaloptSourceField: string

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

      Returns undefined | Narrative

      Narrative data model or undefined for Narrative

      JsonError if the provided JSON is not a valid JSON object

    • Returns null | EnumCodeType

      the status property value as a EnumCodeType if defined; else null

      CodeSystem Enumeration: NarrativeStatusEnum

    • Assigns the provided EnumCodeType value to the status property.

      Parameters

      Returns this

      this

      InvalidTypeError for invalid data types

      CodeSystem Enumeration: NarrativeStatusEnum

    • Returns boolean

      true if the status property exists and has a value; false otherwise

    • Returns null | CodeType

      the status property value as a CodeType if defined; else null

      CodeSystem Enumeration: NarrativeStatusEnum

    • Assigns the provided PrimitiveType value to the status property.

      Parameters

      • element: undefined | null | CodeType

        the status value

      Returns this

      this

      InvalidTypeError for invalid data types

      CodeSystem Enumeration: NarrativeStatusEnum

    • Returns boolean

      true if the status property exists and has a value; false otherwise

    • Returns null | string

      the status property value as a fhirCode if defined; else null

      CodeSystem Enumeration: NarrativeStatusEnum

    • Assigns the provided primitive value to the status property.

      Parameters

      • value: undefined | null | string

        the status value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

      CodeSystem Enumeration: NarrativeStatusEnum

    • Returns boolean

      true if the status property exists and has a value; false otherwise

    • Returns null | XhtmlType

      the div property value as a XhtmlType object if defined; else null

    • Assigns the provided PrimitiveType value to the div property.

      Parameters

      • element: undefined | null | XhtmlType

        the div value

      Returns this

      this

      InvalidTypeError for invalid data types

    • Returns boolean

      true if the div property exists and has a value; false otherwise

    • Returns null | string

      the div property value as a fhirXhtml if defined; else null

    • Assigns the provided primitive value to the div property.

      Parameters

      • value: undefined | null | string

        the div value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the div property exists and has a value; false otherwise

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns boolean

      true if the instance is empty; false otherwise

    • 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

    • Creates a copy of the current instance.

      Returns Narrative

      the a new instance copied from the current instance

    • Returns boolean

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

    • Returns string

      the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)

    • Returns undefined | Value

      the JSON value or undefined if the instance is empty

    • 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 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

    • Protected

      Copies the current instance's elements into the provided object.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods