FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

17.8 Resource ArtifactAssessment - Content

Responsible Owner: Clinical Decision Support icon Work Group NormativeSecurity Category: No Dominant Category Compartments: No defined compartments

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

Note to Balloters: Key changes made since FHIR R6 Ballot (1st Full Ballot) / 6.0.0-ballot4 icon

Updated the ArtifactAssessment resource to follow the MetadataResource (and CanonicalResource) patterns; add all the elements from each pattern, with the exception of relatedArtifact, since the resource already has a relatesTo element.

Release Notes:

17.8.1 Scope and Usage

The ArtifactAssessment Resource represents one or more assessments of another record or resource. The resource captures metadata about the assessment, as well as the data for the results of the assessment which might include comments, classifications, ratings, questions, and responses.

The ArtifactAssessment Resource provides a structure to communicate judgments or qualitative data about a record (a resource or other set of data with a known identity or URL by which it can be accessed), including comments, corrections, classifications, and ratings. The ArtifactAssessment Resource is used when the content attribution and management rights differ from the record being commented upon, or the commenter desires to separate the comments from the target record. The scope is intended to cover assessments (added information) regarding clinical records about individual human subjects, assessments (added information) regarding healthcare provision for individual persons (such as care plans), and assessments (added information) regarding records related to community knowledge such as scientific evidence and group-oriented guidance.

The ArtifactAssessment Resource is optionally canonical in that it can be used more as an observation of an artifact, where it would not be expected to have a canonical, versus the source of a published justification or assessment (where it would have a canonical).

17.8.2 Boundaries and Relationships

ArtifactAssessment may by referenced by ArtifactAssessment and by Task.

ArtifactAssessment may reference any resource of 'community knowledge' and will likely reference Evidence, EvidenceVariable, PlanDefinition, ActivityDefinition, Library, Measure, and Citation. ArtifactAssessment may reference any resource of a 'medical record' and will likely reference DocumentReference, Composition, CarePlan, and DiagnosticReport.

ArtifactAssessment is about the content of a Resource and not about the provenance of the Resource so should not be confused with Provenance.

ArtifactAssessment is not used for communications that are not about a Resource so should not be confused with Communication or Composition (or profiles of Composition) which may be used for the primary communication about the subject matter.

Observation Resource is used extensively for observations about people, groups, devices, locations, substances, and procedures – not about the record describing these entities. ArtifiactAssessment is used for observations where the subject is the artifact or record, not the entity described by the artifact. Simple "assessments" about an Observation such as status, dataAbsentReason, interpretation and note would use the Observation Resource where this is already structured. ArtifactAssessment Resource may be used for complex assessments of an Observation such as justifications for reasons to correct the record.

17.8.3 Background and Context

Across healthcare communities, there are an extensive number of comments and corrections regarding resources where the commenter is not able or permitted to modify the resource content, and there are many situations in which assessments with classifications and ratings of medical record content are made by parties who would not include the assessments in the medical record. Across the academic, scientific, quality measurement development, and clinical decision support communities there is an extensive need to report assessments and feedback about resources and records. These artifact assessments may take multiple forms (including text, classifications, ratings or measurements) and might or might not be created, queried and maintained independently from the artifact being rated or commented upon.

17.8.4 References to this Resource

No references for this Resource.

17.8.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ArtifactAssessment N DomainResource Adds metadata-supported comments, classifiers or ratings related to a Resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC 0..1 uri Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the artifact assessment

... version Σ 0..1 string Canonical version of the ArtifactAssessment
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this ArtifactAssessment (computer friendly)
... title ΣT 0..1 string A label for use in displaying and selecting the artifact assessment
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the ArtifactAssessment
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable)
Binding: Jurisdiction ValueSet icon (Extensible)

... purpose 0..1 markdown Why this ArtifactAssessment is defined
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
... usage 0..1 markdown Describes the clinical usage of the ArtifactAssessment
... approvalDate 0..1 date When the artifact assessment was approved by publisher
... lastReviewDate Σ 0..1 date When the artifact assessment was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ArtifactAssessment is expected to be used
... author 0..* ContactDetail Who authored the ArtifactAssessment

... editor 0..* ContactDetail Who edited the ArtifactAssessment

... reviewer 0..* ContactDetail Who reviewed the ArtifactAssessment

... endorser 0..* ContactDetail Who endorsed the ArtifactAssessment

... relatesTo 0..* BackboneElement Relationship to other Resources

.... type 1..1 CodeableConcept 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
Binding: Artifact Relationship Type icon (Extensible)
.... target[x] 1..1 The artifact that is related to this ArtifactAssessment
..... targetUri uri
..... targetAttachment Attachment
..... targetCanonical canonical(Any)
..... targetReference Reference(Any)
..... targetMarkdown markdown
... citeAs 0..1 markdown How to cite the comment or rating
... artifact[x] Σ 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(Any)
.... artifactCanonical canonical()
.... artifactUri uri
... content 0..* BackboneElement Comment, classifier, or rating content

.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: Evidence Certainty Type icon (Example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: StatisticCertaintyRating icon (Example)

.... quantity 0..1 Quantity Quantitative rating
.... author 0..* Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content

.... path 0..* uri What the comment is directed to

.... relatesTo 0..* see relatesTo Relationship to other Resources

.... freeToShare 0..1 boolean Acceptable to publicly share the content
.... component 0..* see content Comment, classifier, or rating content

... workflowStatus Σ 0..1 code submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Binding: Artifact Assessment Workflow Status (Required)
... disposition Σ 0..1 code unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Binding: Artifact Assessment Disposition (Required)

doco Documentation for this format icon

UML Diagram (Legend)

ArtifactAssessment (DomainResource) +MetadataResourceAn absolute URI that is used to identify this ArtifactAssessment when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this ArtifactAssessment is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the ArtifactAssessment is stored on different serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the ArtifactAssessment when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ArtifactAssessment author and is not expected to be globally unique. For example, it might be a SemVer version, timestamp (e.g. yyyymmdd), or incrementing number. There is no expectation that versions can be placed in a lexicographical sequence without additional knowledgeversion : string [0..1]Indicates the mechanism used to compare canonical versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the ArtifactAssessment. This name should be usable as an identifier for the resource by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A label for use in displaying and selecting the artifact assessmenttitle : string [0..1]The current state of this ArtifactAssessment (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this ArtifactAssessment is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usageexperimental : boolean [0..1]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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the ArtifactAssessmentpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the ArtifactAssessment from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ArtifactAssessmentsuseContext : UsageContext [0..*]A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of usejurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this ArtifactAssessment is needed and why it has been designed as it haspurpose : markdown [0..1]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 assessmentcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]A detailed description of how the ArtifactAssessment is used from a clinical/user perspectiveusage : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the ArtifactAssessment content was or is planned to be in active useeffectivePeriod : Period [0..1]An individual or organization primarily involved in the development of the content in the ArtifactAssessmentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the ArtifactAssessmenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ArtifactAssessmentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the ArtifactAssessment for use in some settingendorser : ContactDetail [0..*]Display of the bibliographic citation of the comment, classifier, or ratingciteAs : markdown [0..1]A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is aboutartifact[x] : DataType [1..1] « Reference(Any)|canonical|uri »Indicates the workflow status of the comment or change requestworkflowStatus : code [0..1] « null (Strength=Required)ArtifactAssessmentWorkflowSta...! »Indicates the disposition of the responsible party to the comment or change requestdisposition : code [0..1] « null (Strength=Required)ArtifactAssessmentDisposition! »RelatesToThe type of relationship to the related artifacttype : CodeableConcept [1..1] « null (Strength=Extensible)ArtifactRelationshipType+ »The artifact that is related to this ArtifactAssessment Resourcetarget[x] : DataType [1..1] « uri|Attachment|canonical(Any)| Reference(Any)|markdown »ContentA brief summary of the content of this componentsummary : markdown [0..1]Indicates what type of content this component representstype : CodeableConcept [0..1] « null (Strength=Example)EvidenceCertaintyType?? »Represents a rating, classifier, or assessment of the artifactclassifier : CodeableConcept [0..*] « null (Strength=Example)StatisticCertaintyRating?? »A quantitative rating of the artifactquantity : Quantity [0..1]Indicates who or what authored the contentauthor : Reference [0..*] « Patient|Practitioner|PractitionerRole| Organization|Device »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 resourcepath : uri [0..*]Acceptable to publicly share the comment, classifier or ratingfreeToShare : boolean [0..1]Relationship that this ArtifactAssessment has with other FHIR or non-FHIR resources that already existrelatesTo[0..*]Relationship that this content component has with other FHIR or non-FHIR resources that already existrelatesTo[0..*]A component comment, classifier, or rating of the artifactcomponent[0..*]A component comment, classifier, or rating of the artifactcontent[0..*]

XML Template

<ArtifactAssessment xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the artifact assessment --></identifier>
 <version value="[string]"/><!-- 0..1 Canonical version of the ArtifactAssessment -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this ArtifactAssessment (computer friendly) -->
 <title value="[string]"/><!-- 0..1 A label for use in displaying and selecting the artifact assessment -->
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the ArtifactAssessment -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this ArtifactAssessment is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the ArtifactAssessment -->
 <approvalDate value="[date]"/><!-- 0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the artifact assessment was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the ArtifactAssessment is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the ArtifactAssessment --></author>
 <editor><!-- 0..* ContactDetail Who edited the ArtifactAssessment --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the ArtifactAssessment --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the ArtifactAssessment --></endorser>
 <relatesTo>  <!-- 0..* Relationship to other Resources -->
  <type><!-- 1..1 CodeableConcept 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 icon --></type>
  <target[x]><!-- 1..1 uri|Attachment|canonical(Any)|Reference(Any)|markdown The artifact that is related to this ArtifactAssessment --></target[x]>
 </relatesTo>
 <citeAs value="[markdown]"/><!-- 0..1 How to cite the comment or rating -->
 <artifact[x]><!-- 1..1 Reference(Any)|canonical|uri The artifact assessed, commented upon or rated --></artifact[x]>
 <content>  <!-- 0..* Comment, classifier, or rating content -->
  <summary value="[markdown]"/><!-- 0..1 Brief summary of the content -->
  <type><!-- 0..1 CodeableConcept What type of content icon --></type>
  <classifier><!-- 0..* CodeableConcept Rating, classifier, or assessment icon --></classifier>
  <quantity><!-- 0..1 Quantity Quantitative rating --></quantity>
  <author><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) Who authored the content --></author>
  <path value="[uri]"/><!-- 0..* What the comment is directed to -->
  <relatesTo><!-- 0..* Content as for ArtifactAssessment.relatesTo Relationship to other Resources --></relatesTo>
  <freeToShare value="[boolean]"/><!-- 0..1 Acceptable to publicly share the content -->
  <component><!-- 0..* Content as for ArtifactAssessment.content Comment, classifier, or rating content --></component>
 </content>
 <workflowStatus value="[code]"/><!-- 0..1 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error -->
 <disposition value="[code]"/><!-- 0..1 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification -->
</ArtifactAssessment>

JSON Template

{doco
  "resourceType" : "ArtifactAssessment",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the artifact assessment
  "version" : "<string>", // Canonical version of the ArtifactAssessment
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this ArtifactAssessment (computer friendly)
  "title" : "<string>", // A label for use in displaying and selecting the artifact assessment
  "status" : "<code>", // draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the ArtifactAssessment
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable) icon
  "purpose" : "<markdown>", // Why this ArtifactAssessment is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "usage" : "<markdown>", // Describes the clinical usage of the ArtifactAssessment
  "approvalDate" : "<date>", // When the artifact assessment was approved by publisher
  "lastReviewDate" : "<date>", // When the artifact assessment was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the ArtifactAssessment is expected to be used
  "author" : [{ ContactDetail }], // Who authored the ArtifactAssessment
  "editor" : [{ ContactDetail }], // Who edited the ArtifactAssessment
  "reviewer" : [{ ContactDetail }], // Who reviewed the ArtifactAssessment
  "endorser" : [{ ContactDetail }], // Who endorsed the ArtifactAssessment
  "relatesTo" : [{ // Relationship to other Resources
    "type" : { CodeableConcept }, // R!  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 icon
    // target[x]: The artifact that is related to this ArtifactAssessment. One of these 5:
    "targetUri" : "<uri>",
    "targetAttachment" : { Attachment },
    "targetCanonical" : "<canonical(Any)>",
    "targetReference" : { Reference(Any) },
    "targetMarkdown" : "<markdown>"
  }],
  "citeAs" : "<markdown>", // How to cite the comment or rating
  // artifact[x]: The artifact assessed, commented upon or rated. One of these 3:
  "artifactReference" : { Reference(Any) },
  "artifactCanonical" : "<canonical>",
  "artifactUri" : "<uri>",
  "content" : [{ // Comment, classifier, or rating content
    "summary" : "<markdown>", // Brief summary of the content
    "type" : { CodeableConcept }, // What type of content icon
    "classifier" : [{ CodeableConcept }], // Rating, classifier, or assessment icon
    "quantity" : { Quantity }, // Quantitative rating
    "author" : [{ Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) }], // Who authored the content
    "path" : ["<uri>"], // What the comment is directed to
    "relatesTo" : [{ Content as for ArtifactAssessment.relatesTo }], // Relationship to other Resources
    "freeToShare" : <boolean>, // Acceptable to publicly share the content
    "component" : [{ Content as for ArtifactAssessment.content }] // Comment, classifier, or rating content
  }],
  "workflowStatus" : "<code>", // submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
  "disposition" : "<code>" // unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ArtifactAssessment;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the artifact assessment
  fhir:version [ string ] ; # 0..1 Canonical version of the ArtifactAssessment
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:String ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this ArtifactAssessment (computer friendly)
  fhir:title [ string ] ; # 0..1 A label for use in displaying and selecting the artifact assessment
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the ArtifactAssessment
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this ArtifactAssessment is defined
  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the ArtifactAssessment
  fhir:approvalDate [ date ] ; # 0..1 When the artifact assessment was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the artifact assessment was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the ArtifactAssessment is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the ArtifactAssessment
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the ArtifactAssessment
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the ArtifactAssessment
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the ArtifactAssessment
  fhir:relatesTo ( [ # 0..* Relationship to other Resources
    fhir:type [ CodeableConcept ] ; # 1..1 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
    # target[x] : 1..1 The artifact that is related to this ArtifactAssessment. One of these 5
      fhir:target [  a fhir:Uri ; uri ]
      fhir:target [  a fhir:Attachment ; Attachment ]
      fhir:target [  a fhir:Canonical ; canonical(Any) ]
      fhir:target [  a fhir:Reference ; Reference(Any) ]
      fhir:target [  a fhir:Markdown ; markdown ]
  ] ... ) ;
  fhir:citeAs [ markdown ] ; # 0..1 How to cite the comment or rating
  # artifact[x] : 1..1 The artifact assessed, commented upon or rated. One of these 3
    fhir:artifact [  a fhir:Reference ; Reference(Any) ]
    fhir:artifact [  a fhir:Canonical ; canonical ]
    fhir:artifact [  a fhir:Uri ; uri ]
  fhir:content ( [ # 0..* Comment, classifier, or rating content
    fhir:summary [ markdown ] ; # 0..1 Brief summary of the content
    fhir:type [ CodeableConcept ] ; # 0..1 What type of content
    fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Rating, classifier, or assessment
    fhir:quantity [ Quantity ] ; # 0..1 Quantitative rating
    fhir:author  ( [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who authored the content
    fhir:path  ( [ uri ] ... ) ; # 0..* What the comment is directed to
    fhir:relatesTo  ( [ See ArtifactAssessment.relatesTo ] ... ) ; # 0..* Relationship to other Resources
    fhir:freeToShare [ boolean ] ; # 0..1 Acceptable to publicly share the content
    fhir:component  ( [ See ArtifactAssessment.content ] ... ) ; # 0..* Comment, classifier, or rating content
  ] ... ) ;
  fhir:workflowStatus [ code ] ; # 0..1 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
  fhir:disposition [ code ] ; # 0..1 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
]

Changes from R5 to R6

ArtifactAssessment
ArtifactAssessment.url
  • Added Element
ArtifactAssessment.version
  • Added Element
ArtifactAssessment.versionAlgorithm[x]
  • Added Element
ArtifactAssessment.name
  • Added Element
ArtifactAssessment.status
  • Added Element
ArtifactAssessment.experimental
  • Added Element
ArtifactAssessment.publisher
  • Added Element
ArtifactAssessment.contact
  • Added Element
ArtifactAssessment.description
  • Added Element
ArtifactAssessment.useContext
  • Added Element
ArtifactAssessment.jurisdiction
  • Added Element
ArtifactAssessment.purpose
  • Added Element
ArtifactAssessment.copyrightLabel
  • Added Element
ArtifactAssessment.usage
  • Added Element
ArtifactAssessment.effectivePeriod
  • Added Element
ArtifactAssessment.author
  • Added Element
ArtifactAssessment.editor
  • Added Element
ArtifactAssessment.reviewer
  • Added Element
ArtifactAssessment.endorser
  • Added Element
ArtifactAssessment.relatesTo
  • Added Element
ArtifactAssessment.relatesTo.type
  • Added Mandatory Element
ArtifactAssessment.relatesTo.target[x]
  • Added Mandatory Element
ArtifactAssessment.citeAs
  • Renamed from citeAs[x] to citeAs
  • Remove Type Reference(Citation)
ArtifactAssessment.content.author
  • Max Cardinality changed from 1 to *
ArtifactAssessment.content.relatesTo
  • Added Element
ArtifactAssessment.content.informationType
  • Deleted
ArtifactAssessment.content.relatedArtifact
  • Deleted

Changes from R4B to R6

This resource did not exist in Release R4B

Changes from R4 to R6

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ArtifactAssessment N DomainResource Adds metadata-supported comments, classifiers or ratings related to a Resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC 0..1 uri Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the artifact assessment

... version Σ 0..1 string Canonical version of the ArtifactAssessment
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this ArtifactAssessment (computer friendly)
... title ΣT 0..1 string A label for use in displaying and selecting the artifact assessment
... status ?!Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description 0..1 markdown Natural language description of the ArtifactAssessment
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction Σ 0..* CodeableConcept Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable)
Binding: Jurisdiction ValueSet icon (Extensible)

... purpose 0..1 markdown Why this ArtifactAssessment is defined
... copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
... copyrightLabel T 0..1 string Copyright holder and year(s)
... usage 0..1 markdown Describes the clinical usage of the ArtifactAssessment
... approvalDate 0..1 date When the artifact assessment was approved by publisher
... lastReviewDate Σ 0..1 date When the artifact assessment was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ArtifactAssessment is expected to be used
... author 0..* ContactDetail Who authored the ArtifactAssessment

... editor 0..* ContactDetail Who edited the ArtifactAssessment

... reviewer 0..* ContactDetail Who reviewed the ArtifactAssessment

... endorser 0..* ContactDetail Who endorsed the ArtifactAssessment

... relatesTo 0..* BackboneElement Relationship to other Resources

.... type 1..1 CodeableConcept 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
Binding: Artifact Relationship Type icon (Extensible)
.... target[x] 1..1 The artifact that is related to this ArtifactAssessment
..... targetUri uri
..... targetAttachment Attachment
..... targetCanonical canonical(Any)
..... targetReference Reference(Any)
..... targetMarkdown markdown
... citeAs 0..1 markdown How to cite the comment or rating
... artifact[x] Σ 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(Any)
.... artifactCanonical canonical()
.... artifactUri uri
... content 0..* BackboneElement Comment, classifier, or rating content

.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: Evidence Certainty Type icon (Example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: StatisticCertaintyRating icon (Example)

.... quantity 0..1 Quantity Quantitative rating
.... author 0..* Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content

.... path 0..* uri What the comment is directed to

.... relatesTo 0..* see relatesTo Relationship to other Resources

.... freeToShare 0..1 boolean Acceptable to publicly share the content
.... component 0..* see content Comment, classifier, or rating content

... workflowStatus Σ 0..1 code submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Binding: Artifact Assessment Workflow Status (Required)
... disposition Σ 0..1 code unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Binding: Artifact Assessment Disposition (Required)

doco Documentation for this format icon

UML Diagram (Legend)

ArtifactAssessment (DomainResource) +MetadataResourceAn absolute URI that is used to identify this ArtifactAssessment when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this ArtifactAssessment is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the ArtifactAssessment is stored on different serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the ArtifactAssessment when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ArtifactAssessment author and is not expected to be globally unique. For example, it might be a SemVer version, timestamp (e.g. yyyymmdd), or incrementing number. There is no expectation that versions can be placed in a lexicographical sequence without additional knowledgeversion : string [0..1]Indicates the mechanism used to compare canonical versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the ArtifactAssessment. This name should be usable as an identifier for the resource by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A label for use in displaying and selecting the artifact assessmenttitle : string [0..1]The current state of this ArtifactAssessment (this element modifies the meaning of other elements)status : code [0..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this ArtifactAssessment is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usageexperimental : boolean [0..1]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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the ArtifactAssessmentpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the ArtifactAssessment from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ArtifactAssessmentsuseContext : UsageContext [0..*]A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of usejurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this ArtifactAssessment is needed and why it has been designed as it haspurpose : markdown [0..1]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 assessmentcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]A detailed description of how the ArtifactAssessment is used from a clinical/user perspectiveusage : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the ArtifactAssessment content was or is planned to be in active useeffectivePeriod : Period [0..1]An individual or organization primarily involved in the development of the content in the ArtifactAssessmentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the ArtifactAssessmenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ArtifactAssessmentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the ArtifactAssessment for use in some settingendorser : ContactDetail [0..*]Display of the bibliographic citation of the comment, classifier, or ratingciteAs : markdown [0..1]A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is aboutartifact[x] : DataType [1..1] « Reference(Any)|canonical|uri »Indicates the workflow status of the comment or change requestworkflowStatus : code [0..1] « null (Strength=Required)ArtifactAssessmentWorkflowSta...! »Indicates the disposition of the responsible party to the comment or change requestdisposition : code [0..1] « null (Strength=Required)ArtifactAssessmentDisposition! »RelatesToThe type of relationship to the related artifacttype : CodeableConcept [1..1] « null (Strength=Extensible)ArtifactRelationshipType+ »The artifact that is related to this ArtifactAssessment Resourcetarget[x] : DataType [1..1] « uri|Attachment|canonical(Any)| Reference(Any)|markdown »ContentA brief summary of the content of this componentsummary : markdown [0..1]Indicates what type of content this component representstype : CodeableConcept [0..1] « null (Strength=Example)EvidenceCertaintyType?? »Represents a rating, classifier, or assessment of the artifactclassifier : CodeableConcept [0..*] « null (Strength=Example)StatisticCertaintyRating?? »A quantitative rating of the artifactquantity : Quantity [0..1]Indicates who or what authored the contentauthor : Reference [0..*] « Patient|Practitioner|PractitionerRole| Organization|Device »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 resourcepath : uri [0..*]Acceptable to publicly share the comment, classifier or ratingfreeToShare : boolean [0..1]Relationship that this ArtifactAssessment has with other FHIR or non-FHIR resources that already existrelatesTo[0..*]Relationship that this content component has with other FHIR or non-FHIR resources that already existrelatesTo[0..*]A component comment, classifier, or rating of the artifactcomponent[0..*]A component comment, classifier, or rating of the artifactcontent[0..*]

XML Template

<ArtifactAssessment xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the artifact assessment --></identifier>
 <version value="[string]"/><!-- 0..1 Canonical version of the ArtifactAssessment -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this ArtifactAssessment (computer friendly) -->
 <title value="[string]"/><!-- 0..1 A label for use in displaying and selecting the artifact assessment -->
 <status value="[code]"/><!-- 0..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the ArtifactAssessment -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable) icon --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this ArtifactAssessment is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the ArtifactAssessment -->
 <approvalDate value="[date]"/><!-- 0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the artifact assessment was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the ArtifactAssessment is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the ArtifactAssessment --></author>
 <editor><!-- 0..* ContactDetail Who edited the ArtifactAssessment --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the ArtifactAssessment --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the ArtifactAssessment --></endorser>
 <relatesTo>  <!-- 0..* Relationship to other Resources -->
  <type><!-- 1..1 CodeableConcept 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 icon --></type>
  <target[x]><!-- 1..1 uri|Attachment|canonical(Any)|Reference(Any)|markdown The artifact that is related to this ArtifactAssessment --></target[x]>
 </relatesTo>
 <citeAs value="[markdown]"/><!-- 0..1 How to cite the comment or rating -->
 <artifact[x]><!-- 1..1 Reference(Any)|canonical|uri The artifact assessed, commented upon or rated --></artifact[x]>
 <content>  <!-- 0..* Comment, classifier, or rating content -->
  <summary value="[markdown]"/><!-- 0..1 Brief summary of the content -->
  <type><!-- 0..1 CodeableConcept What type of content icon --></type>
  <classifier><!-- 0..* CodeableConcept Rating, classifier, or assessment icon --></classifier>
  <quantity><!-- 0..1 Quantity Quantitative rating --></quantity>
  <author><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) Who authored the content --></author>
  <path value="[uri]"/><!-- 0..* What the comment is directed to -->
  <relatesTo><!-- 0..* Content as for ArtifactAssessment.relatesTo Relationship to other Resources --></relatesTo>
  <freeToShare value="[boolean]"/><!-- 0..1 Acceptable to publicly share the content -->
  <component><!-- 0..* Content as for ArtifactAssessment.content Comment, classifier, or rating content --></component>
 </content>
 <workflowStatus value="[code]"/><!-- 0..1 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error -->
 <disposition value="[code]"/><!-- 0..1 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification -->
</ArtifactAssessment>

JSON Template

{doco
  "resourceType" : "ArtifactAssessment",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the artifact assessment
  "version" : "<string>", // Canonical version of the ArtifactAssessment
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this ArtifactAssessment (computer friendly)
  "title" : "<string>", // A label for use in displaying and selecting the artifact assessment
  "status" : "<code>", // draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the ArtifactAssessment
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable) icon
  "purpose" : "<markdown>", // Why this ArtifactAssessment is defined
  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "usage" : "<markdown>", // Describes the clinical usage of the ArtifactAssessment
  "approvalDate" : "<date>", // When the artifact assessment was approved by publisher
  "lastReviewDate" : "<date>", // When the artifact assessment was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the ArtifactAssessment is expected to be used
  "author" : [{ ContactDetail }], // Who authored the ArtifactAssessment
  "editor" : [{ ContactDetail }], // Who edited the ArtifactAssessment
  "reviewer" : [{ ContactDetail }], // Who reviewed the ArtifactAssessment
  "endorser" : [{ ContactDetail }], // Who endorsed the ArtifactAssessment
  "relatesTo" : [{ // Relationship to other Resources
    "type" : { CodeableConcept }, // R!  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 icon
    // target[x]: The artifact that is related to this ArtifactAssessment. One of these 5:
    "targetUri" : "<uri>",
    "targetAttachment" : { Attachment },
    "targetCanonical" : "<canonical(Any)>",
    "targetReference" : { Reference(Any) },
    "targetMarkdown" : "<markdown>"
  }],
  "citeAs" : "<markdown>", // How to cite the comment or rating
  // artifact[x]: The artifact assessed, commented upon or rated. One of these 3:
  "artifactReference" : { Reference(Any) },
  "artifactCanonical" : "<canonical>",
  "artifactUri" : "<uri>",
  "content" : [{ // Comment, classifier, or rating content
    "summary" : "<markdown>", // Brief summary of the content
    "type" : { CodeableConcept }, // What type of content icon
    "classifier" : [{ CodeableConcept }], // Rating, classifier, or assessment icon
    "quantity" : { Quantity }, // Quantitative rating
    "author" : [{ Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) }], // Who authored the content
    "path" : ["<uri>"], // What the comment is directed to
    "relatesTo" : [{ Content as for ArtifactAssessment.relatesTo }], // Relationship to other Resources
    "freeToShare" : <boolean>, // Acceptable to publicly share the content
    "component" : [{ Content as for ArtifactAssessment.content }] // Comment, classifier, or rating content
  }],
  "workflowStatus" : "<code>", // submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
  "disposition" : "<code>" // unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ArtifactAssessment;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the artifact assessment
  fhir:version [ string ] ; # 0..1 Canonical version of the ArtifactAssessment
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:String ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this ArtifactAssessment (computer friendly)
  fhir:title [ string ] ; # 0..1 A label for use in displaying and selecting the artifact assessment
  fhir:status [ code ] ; # 0..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the ArtifactAssessment
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this ArtifactAssessment is defined
  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the ArtifactAssessment
  fhir:approvalDate [ date ] ; # 0..1 When the artifact assessment was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the artifact assessment was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the ArtifactAssessment is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the ArtifactAssessment
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the ArtifactAssessment
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the ArtifactAssessment
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the ArtifactAssessment
  fhir:relatesTo ( [ # 0..* Relationship to other Resources
    fhir:type [ CodeableConcept ] ; # 1..1 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
    # target[x] : 1..1 The artifact that is related to this ArtifactAssessment. One of these 5
      fhir:target [  a fhir:Uri ; uri ]
      fhir:target [  a fhir:Attachment ; Attachment ]
      fhir:target [  a fhir:Canonical ; canonical(Any) ]
      fhir:target [  a fhir:Reference ; Reference(Any) ]
      fhir:target [  a fhir:Markdown ; markdown ]
  ] ... ) ;
  fhir:citeAs [ markdown ] ; # 0..1 How to cite the comment or rating
  # artifact[x] : 1..1 The artifact assessed, commented upon or rated. One of these 3
    fhir:artifact [  a fhir:Reference ; Reference(Any) ]
    fhir:artifact [  a fhir:Canonical ; canonical ]
    fhir:artifact [  a fhir:Uri ; uri ]
  fhir:content ( [ # 0..* Comment, classifier, or rating content
    fhir:summary [ markdown ] ; # 0..1 Brief summary of the content
    fhir:type [ CodeableConcept ] ; # 0..1 What type of content
    fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Rating, classifier, or assessment
    fhir:quantity [ Quantity ] ; # 0..1 Quantitative rating
    fhir:author  ( [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole) ] ... ) ; # 0..* Who authored the content
    fhir:path  ( [ uri ] ... ) ; # 0..* What the comment is directed to
    fhir:relatesTo  ( [ See ArtifactAssessment.relatesTo ] ... ) ; # 0..* Relationship to other Resources
    fhir:freeToShare [ boolean ] ; # 0..1 Acceptable to publicly share the content
    fhir:component  ( [ See ArtifactAssessment.content ] ... ) ; # 0..* Comment, classifier, or rating content
  ] ... ) ;
  fhir:workflowStatus [ code ] ; # 0..1 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
  fhir:disposition [ code ] ; # 0..1 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
]

Changes from R5 to R6

ArtifactAssessment
ArtifactAssessment.url
  • Added Element
ArtifactAssessment.version
  • Added Element
ArtifactAssessment.versionAlgorithm[x]
  • Added Element
ArtifactAssessment.name
  • Added Element
ArtifactAssessment.status
  • Added Element
ArtifactAssessment.experimental
  • Added Element
ArtifactAssessment.publisher
  • Added Element
ArtifactAssessment.contact
  • Added Element
ArtifactAssessment.description
  • Added Element
ArtifactAssessment.useContext
  • Added Element
ArtifactAssessment.jurisdiction
  • Added Element
ArtifactAssessment.purpose
  • Added Element
ArtifactAssessment.copyrightLabel
  • Added Element
ArtifactAssessment.usage
  • Added Element
ArtifactAssessment.effectivePeriod
  • Added Element
ArtifactAssessment.author
  • Added Element
ArtifactAssessment.editor
  • Added Element
ArtifactAssessment.reviewer
  • Added Element
ArtifactAssessment.endorser
  • Added Element
ArtifactAssessment.relatesTo
  • Added Element
ArtifactAssessment.relatesTo.type
  • Added Mandatory Element
ArtifactAssessment.relatesTo.target[x]
  • Added Mandatory Element
ArtifactAssessment.citeAs
  • Renamed from citeAs[x] to citeAs
  • Remove Type Reference(Citation)
ArtifactAssessment.content.author
  • Max Cardinality changed from 1 to *
ArtifactAssessment.content.relatesTo
  • Added Element
ArtifactAssessment.content.informationType
  • Deleted
ArtifactAssessment.content.relatedArtifact
  • Deleted

Changes from R4B to R6

This resource did not exist in Release R4B

Changes from R4 to R6

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis, and See the Extensions for this resource.

17.8.5.1 Terminology Bindings

Path ValueSet Type Documentation
ArtifactAssessment.versionAlgorithm[x] VersionAlgorithm (a valid code from http://hl7.org/fhir/version-algorithm) Extensible

Indicates the mechanism used to compare versions to determine which is more current.
ArtifactAssessment.status PublicationStatus (a valid code from http://hl7.org/fhir/publication-status) Required

The lifecycle status of an artifact.
ArtifactAssessment.jurisdiction JurisdictionValueSet icon Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
ArtifactAssessment.relatesTo.type ArtifactRelationshipType icon (a valid code from http://terminology.hl7.org/CodeSystem/artifact-relationship-type) Extensible

Type of relationship to the related artifact.
ArtifactAssessment.content.type EvidenceCertaintyType icon (a valid code from http://terminology.hl7.org/CodeSystem/certainty-type) Example

The aspect of quality, confidence, or certainty.
ArtifactAssessment.content.classifier StatisticCertaintyRating icon (a valid code from http://terminology.hl7.org/CodeSystem/certainty-rating) Example

The relative quality of the statistic.
ArtifactAssessment.workflowStatus ArtifactAssessmentWorkflowStatus (a valid code from http://hl7.org/fhir/artifactassessment-workflow-status) Required

Possible values for the workflow status of the comment or assessment, typically used to coordinate workflow around the process of accepting and rejecting changes and comments on the artifact.
ArtifactAssessment.disposition ArtifactAssessmentDisposition (a valid code from http://hl7.org/fhir/artifactassessment-disposition) Required

Possible values for the disposition of a comment or change request, typically used for comments and change requests, to indicate the disposition of the responsible party towards the changes suggested by the comment or change request.

17.8.5.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning ArtifactAssessment.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')

17.8.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
date date The artifact assessment publication date ArtifactAssessment.date 25 Resources
identifier token The artifact assessment identifier ArtifactAssessment.identifier 29 Resources