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

    parse getPublishedIn setPublishedIn hasPublishedIn getCitedMedium setCitedMedium hasCitedMedium getVolumeElement setVolumeElement hasVolumeElement getVolume setVolume hasVolume getIssueElement setIssueElement hasIssueElement getIssue setIssue hasIssue getArticleDateElement setArticleDateElement hasArticleDateElement getArticleDate setArticleDate hasArticleDate getPublicationDateTextElement setPublicationDateTextElement hasPublicationDateTextElement getPublicationDateText setPublicationDateText hasPublicationDateText getPublicationDateSeasonElement setPublicationDateSeasonElement hasPublicationDateSeasonElement getPublicationDateSeason setPublicationDateSeason hasPublicationDateSeason getLastRevisionDateElement setLastRevisionDateElement hasLastRevisionDateElement getLastRevisionDate setLastRevisionDate hasLastRevisionDate getLanguage setLanguage addLanguage hasLanguage getAccessionNumberElement setAccessionNumberElement hasAccessionNumberElement getAccessionNumber setAccessionNumber hasAccessionNumber getPageStringElement setPageStringElement hasPageStringElement getPageString setPageString hasPageString getFirstPageElement setFirstPageElement hasFirstPageElement getFirstPage setFirstPage hasFirstPage getLastPageElement setLastPageElement hasLastPageElement getLastPage setLastPage hasLastPage getPageCountElement setPageCountElement hasPageCountElement getPageCount setPageCount hasPageCount getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLanguage

    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
    citedMedium?: CodeableConcept

    Citation.citedArtifact.publicationForm.citedMedium Element

    FHIR Specification

    • Short: Internet or Print
    • Definition: Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    volume?: StringType

    Citation.citedArtifact.publicationForm.volume Element

    FHIR Specification

    • Short: Volume number of journal or other collection in which the article is published
    • Definition: Volume number of journal or other collection in which the article is published.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    issue?: StringType

    Citation.citedArtifact.publicationForm.issue Element

    FHIR Specification

    • Short: Issue, part or supplement of journal or other collection in which the article is published
    • Definition: Issue, part or supplement of journal or other collection in which the article is published.
    • FHIR Type: string
    • 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.
    • Comment: The articleDate is the preferred element for expressing the publication date as structured data.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationDateText?: StringType

    Citation.citedArtifact.publicationForm.publicationDateText Element

    FHIR Specification

    • Short: Text representation of the date on which the issue of the cited artifact was published
    • Definition: Text representation of the date on which the issue of the cited artifact was published.
    • Comment: The publicationDateText element is prefererntially used when a date is not represented in a form that can be handled as structured data in other elements.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationDateSeason?: StringType

    Citation.citedArtifact.publicationForm.publicationDateSeason Element

    FHIR Specification

    • Short: Season in which the cited artifact was published
    • Definition: Spring, Summer, Fall/Autumn, Winter.
    • FHIR Type: string
    • 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.
    • Comment: The lastRevisionDate is used for the cited article and not the date the Citation Resource is last revised.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    language?: CodeableConcept[]

    Citation.citedArtifact.publicationForm.language Element

    FHIR Specification

    • Short: Language(s) in which this form of the article is published
    • Definition: The language or languages in which this form of the article is published.
    • 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.
    • Comment: Accession numbers may be used instead of or in addition to page numbers. Accession numbers are functionally identifiers when coupled with the identity of the database for which they are accession numbers. Accession numbers which are used for indexing citations in a dataset of citations should NOT be entered in Citation.citedArtifact.publicationForm.accessionNumber -- this use would be a type of Citation.identifier for the citation record itself.
    • 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. Distinct from reporting the page numbers.
    • 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.
    • Comment: It is possible that different publication forms have different copyright notices.
    • 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