Data Model Libraries
    Preparing search index...

    Class ArtifactAssessment

    ArtifactAssessment Class

    This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.

    FHIR Specification

    • Short: Adds metadata-supported comments, classifiers or ratings related to a Resource
    • Definition: This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.
    • FHIR Version: 5.0.0

    FHIR ArtifactAssessment

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? title? citeAs? date? copyright? approvalDate? lastReviewDate? artifact content? artifactassessmentWorkflowStatusEnum workflowStatus? artifactassessmentDispositionEnum disposition?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getCiteAs setCiteAs hasCiteAs getCiteAsReference hasCiteAsReference getCiteAsMarkdownType hasCiteAsMarkdownType getDateElement setDateElement hasDateElement getDate setDate hasDate getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getArtifact setArtifact hasArtifact getArtifactReference hasArtifactReference getArtifactCanonicalType hasArtifactCanonicalType getArtifactUriType hasArtifactUriType getContent setContent addContent hasContent getWorkflowStatusEnumType setWorkflowStatusEnumType hasWorkflowStatusEnumType getWorkflowStatusElement setWorkflowStatusElement hasWorkflowStatusElement getWorkflowStatus setWorkflowStatus hasWorkflowStatus getDispositionEnumType setDispositionEnumType hasDispositionEnumType getDispositionElement setDispositionElement hasDispositionElement getDisposition setDisposition hasDisposition fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContent

    Constructors

    Properties

    identifier?: Identifier[]

    ArtifactAssessment.identifier Element

    FHIR Specification

    • Short: Additional identifier for the artifact assessment
    • Definition: A formal identifier that is used to identify this artifact assessment when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the artifact assessment.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    title?: StringType

    ArtifactAssessment.title Element

    FHIR Specification

    • Short: A short title for the assessment for use in displaying and selecting
    • Definition: A short title for the assessment for use in displaying and selecting.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    citeAs?: IDataType

    ArtifactAssessment.citeAs[x] Element

    @ChoiceDataTypesMeta('ArtifactAssessment.citeAs[x]', ['Reference','markdown',]

    FHIR Specification

    • Short: How to cite the comment or rating
    • Definition: Display of or reference to the bibliographic citation of the comment, classifier, or rating.
    • FHIR Types: 'Reference', 'markdown',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    date?: DateTimeType

    ArtifactAssessment.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the artifact assessment. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    copyright?: MarkdownType

    ArtifactAssessment.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the artifact assessment and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    ArtifactAssessment.approvalDate Element

    FHIR Specification

    • Short: When the artifact assessment was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    ArtifactAssessment.lastReviewDate Element

    FHIR Specification

    • Short: When the artifact assessment was last reviewed by the publisher
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    artifact: null | IDataType

    ArtifactAssessment.artifact[x] Element

    @ChoiceDataTypesMeta('ArtifactAssessment.artifact[x]', ['Reference','canonical','uri',]

    FHIR Specification

    • Short: The artifact assessed, commented upon or rated
    • Definition: A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.
    • FHIR Types: 'Reference', 'canonical', 'uri',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Private Optionalcontent

    content?: ArtifactAssessmentContentComponent[]

    ArtifactAssessment.content Element

    FHIR Specification

    • Short: Comment, classifier, or rating content
    • Definition: A component comment, classifier, or rating of the artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    artifactassessmentWorkflowStatusEnum: ArtifactassessmentWorkflowStatusEnum

    FHIR CodeSystem: ArtifactassessmentWorkflowStatus

    ArtifactassessmentWorkflowStatusEnum

    workflowStatus?: EnumCodeType

    ArtifactAssessment.workflowStatus Element

    FHIR Specification

    • Short: submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
    • Definition: Indicates the workflow status of the comment or change request.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ArtifactassessmentWorkflowStatusEnum

    artifactassessmentDispositionEnum: ArtifactassessmentDispositionEnum

    FHIR CodeSystem: ArtifactassessmentDisposition

    ArtifactassessmentDispositionEnum

    disposition?: EnumCodeType

    ArtifactAssessment.disposition Element

    FHIR Specification

    • Short: unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
    • Definition: Indicates the disposition of the responsible party to the comment or change request.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ArtifactassessmentDispositionEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ArtifactAssessment

      • OptionaloptSourceField: string

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

      Returns undefined | ArtifactAssessment

      ArtifactAssessment data model or undefined for ArtifactAssessment

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetCiteAssetCiteAshasCiteAsgetCiteAsReferencehasCiteAsReferencegetCiteAsMarkdownTypehasCiteAsMarkdownTypegetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetArtifactsetArtifacthasArtifactgetArtifactReferencehasArtifactReferencegetArtifactCanonicalTypehasArtifactCanonicalTypegetArtifactUriTypehasArtifactUriTypegetContentsetContentaddContenthasContentgetWorkflowStatusEnumTypesetWorkflowStatusEnumTypehasWorkflowStatusEnumTypegetWorkflowStatusElementsetWorkflowStatusElementhasWorkflowStatusElementgetWorkflowStatussetWorkflowStatushasWorkflowStatusgetDispositionEnumTypesetDispositionEnumTypehasDispositionEnumTypegetDispositionElementsetDispositionElementhasDispositionElementgetDispositionsetDispositionhasDispositionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContent