View raw Markdown
type: resource-definitionsresource: ArtifactAssessment

ArtifactAssessment Definitions

<a id="ArtifactAssessment"></a>

ArtifactAssessment

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.

Cardinality: 0..*

Mappings: rim=Act[classCode=ACT; moodCode=DEFN]; w5=clinical.general

<a id="ArtifactAssessment.identifier"></a>

ArtifactAssessment.identifier

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.

Comments: This may be used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this artifact assessment 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.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; rim=.identifier; objimpl=no-gen-base

<a id="ArtifactAssessment.title"></a>

ArtifactAssessment.title

A label for use in displaying and selecting the artifact assessment

Cardinality: 0..1

Type: string

Summary: true

<a id="ArtifactAssessment.citeAs"></a>

ArtifactAssessment.citeAs

How to cite the comment or rating

Definition: Display of the bibliographic citation of the comment, classifier, or rating.

Cardinality: 0..1

Type: markdown

<a id="ArtifactAssessment.artifact[x]"></a>

ArtifactAssessment.artifact[x]

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.

Cardinality: 1..1

Type: Reference(Any), canonical, uri

Summary: true

Mappings: w5=FiveWs.what[x]

<a id="ArtifactAssessment.relatesTo"></a>

ArtifactAssessment.relatesTo

Relationship to other Resources

Definition: Relationship that this ArtifactAssessment has with other FHIR or non-FHIR resources that already exist.

Cardinality: 0..*

Type: BackboneElement

<a id="ArtifactAssessment.relatesTo.type"></a>

ArtifactAssessment.relatesTo.type

documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes

Definition: The type of relationship to the related artifact.

Cardinality: 1..1

Type: CodeableConcept

Binding: extensible:artifact-relationship-type

<a id="ArtifactAssessment.relatesTo.target[x]"></a>

ArtifactAssessment.relatesTo.target[x]

The artifact that is related to this ArtifactAssessment

Definition: The artifact that is related to this ArtifactAssessment Resource.

Cardinality: 1..1

Type: uri, Attachment, canonical, Reference(Resource), markdown

<a id="ArtifactAssessment.date"></a>

ArtifactAssessment.date

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.

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.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded; rim=.participation[typeCode=AUT].time

<a id="ArtifactAssessment.copyright"></a>

ArtifactAssessment.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are notices of intellectual property ownership and can include 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.

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: rim=N/A (to add?); objimpl=no-gen-base

<a id="ArtifactAssessment.approvalDate"></a>

ArtifactAssessment.approvalDate

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.

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

Cardinality: 0..1

Type: date

Mappings: rim=.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime; objimpl=no-gen-base

<a id="ArtifactAssessment.lastReviewDate"></a>

ArtifactAssessment.lastReviewDate

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.

Comments: 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.

Cardinality: 0..1

Type: date

Summary: true

Mappings: rim=.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime; objimpl=no-gen-base

<a id="ArtifactAssessment.content"></a>

ArtifactAssessment.content

Comment, classifier, or rating content

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

Cardinality: 0..*

Type: BackboneElement

<a id="ArtifactAssessment.content.summary"></a>

ArtifactAssessment.content.summary

Brief summary of the content

Definition: A brief summary of the content of this component.

Cardinality: 0..1

Type: markdown

<a id="ArtifactAssessment.content.type"></a>

ArtifactAssessment.content.type

What type of content

Definition: Indicates what type of content this component represents.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:certainty-type

<a id="ArtifactAssessment.content.classifier"></a>

ArtifactAssessment.content.classifier

Rating, classifier, or assessment

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:certainty-rating

<a id="ArtifactAssessment.content.quantity"></a>

ArtifactAssessment.content.quantity

Quantitative rating

Definition: A quantitative rating of the artifact.

Cardinality: 0..1

Type: Quantity

<a id="ArtifactAssessment.content.author"></a>

ArtifactAssessment.content.author

Who authored the content

Definition: Indicates who or what authored the content.

Cardinality: 0..*

Type: Reference(Patient, Practitioner, PractitionerRole, Organization, Device)

<a id="ArtifactAssessment.content.path"></a>

ArtifactAssessment.content.path

What the comment is directed to

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.

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).

Cardinality: 0..*

Type: uri

<a id="ArtifactAssessment.content.relatesTo"></a>

ArtifactAssessment.content.relatesTo

Relationship to other Resources

Definition: Relationship that this content component has with other FHIR or non-FHIR resources that already exist.

Cardinality: 0..*

<a id="ArtifactAssessment.content.freeToShare"></a>

ArtifactAssessment.content.freeToShare

Acceptable to publicly share the content

Definition: Acceptable to publicly share the comment, classifier or rating.

Comments: Absence of a value should be interpreted as inheriting any freeToShare value present in a containing structure, else inheriting data from the ArtifactAssessment.copyright element, else value unknown.

Cardinality: 0..1

Type: boolean

<a id="ArtifactAssessment.content.component"></a>

ArtifactAssessment.content.component

Comment, classifier, or rating content

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

Cardinality: 0..*

<a id="ArtifactAssessment.workflowStatus"></a>

ArtifactAssessment.workflowStatus

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.

Cardinality: 0..1

Type: code

Binding: required:artifactassessment-workflow-status

Summary: true

<a id="ArtifactAssessment.disposition"></a>

ArtifactAssessment.disposition

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.

Cardinality: 0..1

Type: code

Binding: required:artifactassessment-disposition

Summary: true