Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactStatusDateComponent

    CitationCitedArtifactStatusDateComponent Class

    FHIR Specification

    • Short: An effective date or period for a status of the cited artifact
    • Definition: An effective date or period for a status of the cited artifact.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    activity: null | CodeableConcept

    Citation.citedArtifact.statusDate.activity Element

    FHIR Specification

    • Short: Classification of the status
    • Definition: Classification of the status.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    actual?: BooleanType

    Citation.citedArtifact.statusDate.actual Element

    FHIR Specification

    • Short: Either occurred or expected
    • Definition: Either occurred or expected.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    period: null | Period

    Citation.citedArtifact.statusDate.period Element

    FHIR Specification

    • Short: When the status started and/or ended
    • Definition: When the status started and/or ended.
    • Comment: For an instance, place the same value in both start and end elements.
    • FHIR Type: Period
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactStatusDateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactStatusDateComponent

      CitationCitedArtifactStatusDateComponent data model or undefined for CitationCitedArtifactStatusDateComponent

      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