Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Clinical Decision Support icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Not Classified Compartments: No defined compartments

Detailed Descriptions for the elements in the ArtifactAssessment resource.

ArtifactAssessment
Element IdArtifactAssessment
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.

Short DisplayAdds metadata-supported comments, classifiers or ratings related to a Resource
Cardinality0..*
TypeDomainResource
Summaryfalse
ArtifactAssessment.identifier
Element IdArtifactAssessment.identifier
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.

Short DisplayAdditional identifier for the artifact assessment
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the artifact assessment.

Summarytrue
Comments

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.

ArtifactAssessment.title
Element IdArtifactAssessment.title
Definition

A short title for the assessment for use in displaying and selecting.

Short DisplayA short title for the assessment for use in displaying and selecting
Cardinality0..1
Typestring
Summarytrue
ArtifactAssessment.citeAs[x]
Element IdArtifactAssessment.citeAs[x]
Definition

Display of or reference to the bibliographic citation of the comment, classifier, or rating.

Short DisplayHow to cite the comment or rating
Cardinality0..1
TypeReference(Citation)|markdown
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
ArtifactAssessment.date
Element IdArtifactAssessment.date
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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

ArtifactAssessment.copyright
Element IdArtifactAssessment.copyright
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.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the artifact assessment and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
ArtifactAssessment.approvalDate
Element IdArtifactAssessment.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the artifact assessment was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

ArtifactAssessment.lastReviewDate
Element IdArtifactAssessment.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the artifact assessment was last reviewed by the publisher
Cardinality0..1
Typedate
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.

Summarytrue
Comments

If specified, this date follows the original approval date.

ArtifactAssessment.artifact[x]
Element IdArtifactAssessment.artifact[x]
Definition

A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.

Short DisplayThe artifact assessed, commented upon or rated
Cardinality1..1
TypeReference(Any)|canonical|uri
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
ArtifactAssessment.content
Element IdArtifactAssessment.content
Definition

A component comment, classifier, or rating of the artifact.

Short DisplayComment, classifier, or rating content
Cardinality0..*
Summaryfalse
ArtifactAssessment.content.informationType
Element IdArtifactAssessment.content.informationType
Definition

The type of information this component of the content represents.

Short Displaycomment | classifier | rating | container | response | change-request
Cardinality0..1
Terminology BindingArtifact Assessment Information Type (Required)
Typecode
Summaryfalse
ArtifactAssessment.content.summary
Element IdArtifactAssessment.content.summary
Definition

A brief summary of the content of this component.

Short DisplayBrief summary of the content
Cardinality0..1
Typemarkdown
Summaryfalse
ArtifactAssessment.content.type
Element IdArtifactAssessment.content.type
Definition

Indicates what type of content this component represents.

Short DisplayWhat type of content
Cardinality0..1
Terminology BindingEvidence Certainty Type (Example)
TypeCodeableConcept
Summaryfalse
ArtifactAssessment.content.classifier
Element IdArtifactAssessment.content.classifier
Definition

Represents a rating, classifier, or assessment of the artifact.

Short DisplayRating, classifier, or assessment
Cardinality0..*
Terminology BindingEvidence Certainty Rating (Example)
TypeCodeableConcept
Summaryfalse
ArtifactAssessment.content.quantity
Element IdArtifactAssessment.content.quantity
Definition

A quantitative rating of the artifact.

Short DisplayQuantitative rating
Cardinality0..1
TypeQuantity
Summaryfalse
ArtifactAssessment.content.author
Element IdArtifactAssessment.content.author
Definition

Indicates who or what authored the content.

Short DisplayWho authored the content
Cardinality0..1
TypeReference(Patient | Practitioner | PractitionerRole | Organization | Device)
Summaryfalse
ArtifactAssessment.content.path
Element IdArtifactAssessment.content.path
Definition

A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.

Short DisplayWhat the comment is directed to
Cardinality0..*
Typeuri
Summaryfalse
Comments

The target element is used to point the comment to aspect of the artifact, such as a text range within a CQL library (e.g. #content?0:0-120:80).

ArtifactAssessment.content.relatedArtifact
Element IdArtifactAssessment.content.relatedArtifact
Definition

Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.

Short DisplayAdditional information
Cardinality0..*
TypeRelatedArtifact
Summaryfalse
ArtifactAssessment.content.freeToShare
Element IdArtifactAssessment.content.freeToShare
Definition

Acceptable to publicly share the comment, classifier or rating.

Short DisplayAcceptable to publicly share the resource content
Cardinality0..1
Typeboolean
Summaryfalse
ArtifactAssessment.content.component
Element IdArtifactAssessment.content.component
Definition

If the informationType is container, the components of the content.

Short DisplayContained content
Cardinality0..*
TypeSee ArtifactAssessment.content
Summaryfalse
ArtifactAssessment.workflowStatus
Element IdArtifactAssessment.workflowStatus
Definition

Indicates the workflow status of the comment or change request.

Short Displaysubmitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Cardinality0..1
Terminology BindingArtifact Assessment Workflow Status (Required)
Typecode
Summarytrue
ArtifactAssessment.disposition
Element IdArtifactAssessment.disposition
Definition

Indicates the disposition of the responsible party to the comment or change request.

Short Displayunresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Cardinality0..1
Terminology BindingArtifact Assessment Disposition (Required)
Typecode
Summarytrue