Data Model Libraries
    Preparing search index...

    CitationCitedArtifactComponent Class

    FHIR Specification

    • Short: The article or artifact being described
    • Definition: The article or artifact being described.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    identifier?: Identifier[]

    Citation.citedArtifact.identifier Element

    FHIR Specification

    • Short: Unique identifier. May include DOI, PMID, PMCID, etc
    • Definition: A formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: This element will contain unique identifiers that support de-duplication of citations. Commonly used identifiers for study citations include digital object identifier (DOI), PubMed ID (PMID), and PubMed Central ID (PMCID). To maintain interoperability, the suggested identifier.system values to use for these 3 identifiers are: DOI = "https://doi.org" PMID = "https://pubmed.ncbi.nlm.nih.gov" PMCID = "https://www.ncbi.nlm.nih.gov/pmc/"
    • Requirements: Allows externally provided and/or usable identifiers to be associated with the cited artifact.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatedIdentifier?: Identifier[]

    Citation.citedArtifact.relatedIdentifier Element

    FHIR Specification

    • Short: Identifier not unique to the cited artifact. May include trial registry identifiers
    • Definition: A formal identifier that is used to identify things closely related to the cited artifact.
    • Comment: May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This related identifier would not be used as unique identifier for the cited artifact itself. Multiple published articles (each with their own unique identifier) may relate to the same study record in a research registry. Commonly used related identifiers for study registries include ClinicalTrials.gov identifier (NCTId) and PROSPERO identifier (used for registration of systematic reviews). To maintain interoperability, the suggested identifier.system values to use for these 2 identifiers are: ClinicalTrials.gov = "https://clinicaltrials.gov" PROSPERO = "https://www.crd.york.ac.uk/prospero/"
    • Requirements: Allows externally provided and/or usable identifiers to be associated with this the cited artifact.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    dateAccessed?: DateTimeType

    Citation.citedArtifact.dateAccessed Element

    FHIR Specification

    • Short: When the cited artifact was accessed
    • Definition: When the cited artifact was accessed.
    • Comment: Use this element when citing an artifact from a potentially unstable source, such as a webpage, to note the date (and time) the source was accessed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Citation.citedArtifact.version Element

    FHIR Specification

    • Short: The defined version of the cited artifact
    • Definition: The defined version of the cited artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    currentState?: CodeableConcept[]

    Citation.citedArtifact.currentState Element

    FHIR Specification

    • Short: The status of the cited artifact
    • Definition: The status of the cited artifact.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.statusDate Element

    FHIR Specification

    • Short: An effective date or period for a status of the cited artifact
    • Definition: An effective date or period, historical or future, actual or expected, for a status of the cited artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.title Element

    FHIR Specification

    • Short: The title details of the article or artifact
    • Definition: The title details of the article or artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.abstract Element

    FHIR Specification

    • Short: Summary of the article or artifact
    • Definition: The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.part Element

    FHIR Specification

    • Short: The component of the article or artifact
    • Definition: The component of the article or artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.relatesTo Element

    FHIR Specification

    • Short: The artifact related to the cited artifact
    • Definition: The artifact related to the cited artifact.
    • Comment: The citedArtifact.relatesTo element uses a BackboneElement instead of the RelatedArtifact Datatype to enable use of an extended value set for the required code for the type of relationship.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.publicationForm Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.webLocation Element

    FHIR Specification

    • Short: Used for any URL for the article or artifact cited
    • Definition: Used for any URL for the article or artifact cited.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.classification Element

    FHIR Specification

    • Short: The assignment to an organizing scheme
    • Definition: The assignment to an organizing scheme.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship Element

    FHIR Specification

    • Short: Attribution of authors and other contributors
    • Definition: This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.
    • Requirements: Need to support individualized and collective attribution of authorship and contributorship to people and groups.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Citation.citedArtifact.note Element

    FHIR Specification

    • Short: Any additional information or content for the article or artifact
    • Definition: Any additional information or content for the article or artifact.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactComponent

      CitationCitedArtifactComponent data model or undefined for CitationCitedArtifactComponent

      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