Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactPublicationFormComponent

    CitationCitedArtifactPublicationFormComponent Class

    FHIR Specification

    • Short: If multiple, used to represent alternative forms of the article that are not separate citations
    • Definition: If multiple, used to represent alternative forms of the article that are not separate citations.
    • Comment: A common use is a journal article with a publication date and pagination for a print version and a different publication date for the online version of the same article.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Citation.citedArtifact.publicationForm.publishedIn Element

    FHIR Specification

    • Short: The collection the cited article or artifact is published in
    • Definition: The collection the cited article or artifact is published in.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.publicationForm.periodicRelease Element

    FHIR Specification

    • Short: The specific issue in which the cited article resides
    • Definition: The specific issue in which the cited article resides.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    articleDate?: DateTimeType

    Citation.citedArtifact.publicationForm.articleDate Element

    FHIR Specification

    • Short: The date the article was added to the database, or the date the article was released
    • Definition: The date the article was added to the database, or the date the article was released (which may differ from the journal issue publication date).
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastRevisionDate?: DateTimeType

    Citation.citedArtifact.publicationForm.lastRevisionDate Element

    FHIR Specification

    • Short: The date the article was last revised or updated in the database
    • Definition: The date the article was last revised or updated in the database.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    language?: CodeableConcept[]

    Citation.citedArtifact.publicationForm.language Element

    FHIR Specification

    • Short: Language in which this form of the article is published
    • Definition: Language in which this form of the article is published.
    • Comment: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    accessionNumber?: StringType

    Citation.citedArtifact.publicationForm.accessionNumber Element

    FHIR Specification

    • Short: Entry number or identifier for inclusion in a database
    • Definition: Entry number or identifier for inclusion in a database.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    pageString?: StringType

    Citation.citedArtifact.publicationForm.pageString Element

    FHIR Specification

    • Short: Used for full display of pagination
    • Definition: Used for full display of pagination.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    firstPage?: StringType

    Citation.citedArtifact.publicationForm.firstPage Element

    FHIR Specification

    • Short: Used for isolated representation of first page
    • Definition: Used for isolated representation of first page.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastPage?: StringType

    Citation.citedArtifact.publicationForm.lastPage Element

    FHIR Specification

    • Short: Used for isolated representation of last page
    • Definition: Used for isolated representation of last page.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    pageCount?: StringType

    Citation.citedArtifact.publicationForm.pageCount Element

    FHIR Specification

    • Short: Number of pages or screens
    • Definition: Actual or approximate number of pages or screens.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    Citation.citedArtifact.publicationForm.copyright Element

    FHIR Specification

    • Short: Copyright notice for the full article or artifact
    • Definition: Copyright notice for the full article or artifact.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactPublicationFormComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactPublicationFormComponent

      CitationCitedArtifactPublicationFormComponent data model or undefined for CitationCitedArtifactPublicationFormComponent

      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 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 complex or primitive datatype; false otherwise