Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactPublicationFormPublishedInComponent

    CitationCitedArtifactPublicationFormPublishedInComponent Class

    FHIR Specification

    • Short: The collection the cited article or artifact is published in
    • Definition: The collection the cited article or artifact is published in.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Citation.citedArtifact.publicationForm.publishedIn.type Element

    FHIR Specification

    • Short: Kind of container (e.g. Periodical, database, or book)
    • Definition: Kind of container (e.g. Periodical, database, or book).
    • Comment: Journals and newspapers are coded as Periodical.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier[]

    Citation.citedArtifact.publicationForm.publishedIn.identifier Element

    FHIR Specification

    • Short: Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
    • Definition: Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    title?: StringType

    Citation.citedArtifact.publicationForm.publishedIn.title Element

    FHIR Specification

    • Short: Name of the database or title of the book or journal
    • Definition: Name of the database or title of the book or journal.
    • Comment: ClinicalTrials.gov is a name of a database.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publisher?: Reference

    Citation.citedArtifact.publicationForm.publishedIn.publisher Element

    FHIR Specification

    • Short: Name of or resource describing the publisher
    • Definition: Name of or resource describing the publisher.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publisherLocation?: StringType

    Citation.citedArtifact.publicationForm.publishedIn.publisherLocation Element

    FHIR Specification

    • Short: Geographic location of the publisher
    • Definition: Geographic location of the publisher.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactPublicationFormPublishedInComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactPublicationFormPublishedInComponent

      CitationCitedArtifactPublicationFormPublishedInComponent data model or undefined for CitationCitedArtifactPublicationFormPublishedInComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Publisher object value to the publisher property.

      Parameters

      • value: undefined | Reference

        the publisher object value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.publicationForm.publishedIn.publisher', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • 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