FHIR CI-Build

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

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

Detailed Descriptions for the elements in the ArtifactAssessment resource.

Element Id ArtifactAssessment
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 Display Adds metadata-supported comments, classifiers or ratings related to a Resource
Cardinality 0..*
Type MetadataResource
Summary false
Constraints
Defined on this element
cnl-0Warning 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}$')
Element Id ArtifactAssessment.url
Definition

An 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 servers.

Short Display Canonical identifier for this ArtifactAssessment, represented as an absolute URI (globally unique)
Cardinality 0..1
Type uri
Requirements

Allows the ArtifactAssessment to be referenced by a single globally unique identifier.

Summary true
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Constraints
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
Element Id ArtifactAssessment.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 Display Additional identifier for the artifact assessment
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

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

Summary true
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.

Element Id ArtifactAssessment.version
Definition

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

Short Display Canonical version of the ArtifactAssessment
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Comments

There may be different ArtifactAssessments that have the same canonical url but different versions. The version can be appended to the url in a reference to allow a reference to a particular canonical version of the ArtifactAssessment with the format [url]|[version]. Note that the canonical version of a resource is not related to a server resource instance version (Resource.meta.versionId). For more information, see Version Matching for Canonical Resources. The version SHOULD NOT contain a '#' - see Business Version.

Element Id ArtifactAssessment.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare canonical versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. For more information, see Choosing the right Canonical Reference.

Element Id ArtifactAssessment.name
Definition

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

Short Display Name for this ArtifactAssessment (computer friendly)
Cardinality 0..1
Type string
Requirements

Supports code generation.

Summary true
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.

Constraints
Affect this element
cnl-0Warning 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}$')
Element Id ArtifactAssessment.title
Definition

A label for use in displaying and selecting the artifact assessment.

Short Display A label for use in displaying and selecting the artifact assessment
Cardinality 0..1
Type string
Summary true
Translatable true
Element Id ArtifactAssessment.status
Definition

The current state of this ArtifactAssessment.

Short Display draft | active | retired | unknown
Cardinality 0..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired ArtifactAssessment without due consideration)
Requirements

Enables tracking the life-cycle of the content and filtering of ArtifactAssessments that are appropriate for use versus not.

Summary true
Comments

A nominal state-transition diagram can be found in the Definition pattern documentation.

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

If a server wishes to reflect whether a given canonical resource is 'supported' or 'enabled' on that server, this is NOT done with status. Instead, expose support for the resource using a 'feature' in the server's CapabilityStatement.

Element Id ArtifactAssessment.experimental
Definition

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

Short Display For testing only - never for real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level ArtifactAssessment.

Summary true
Comments

Allows filtering of ArtifactAssessments that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Element Id ArtifactAssessment.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 Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
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.

Element Id ArtifactAssessment.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the ArtifactAssessment.

Short Display Name of the publisher/steward (organization or individual)
Cardinality 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the ArtifactAssessment. May also allow for contact.

Summary true
Comments

Usually an organization but may be an individual. The publisher (or steward) of the ArtifactAssessment is the organization or individual primarily responsible for the maintenance and upkeep of the ArtifactAssessment. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ArtifactAssessment. This item SHOULD be populated unless the information is available from context. The publisher is not necessarily an entity that is involved in developing the content of the resource.

Element Id ArtifactAssessment.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Element Id ArtifactAssessment.description
Definition

A free text natural language description of the ArtifactAssessment from a consumer's perspective.

Short Display Natural language description of the ArtifactAssessment
Cardinality 0..1
Type markdown
Summary false
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the ArtifactAssessment as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.

Element Id ArtifactAssessment.useContext
Definition

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

Short Display The context that the content is intended to support
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Element Id ArtifactAssessment.jurisdiction
Definition

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

Short Display Jurisdiction of the authority that maintains the ArtifactAssessment (if applicable)
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet icon (Extensible)
Type CodeableConcept
Summary true
Comments

It may be possible for the ArtifactAssessment to be used in jurisdictions other than those for which it was originally designed or intended.

Element Id ArtifactAssessment.purpose
Definition

Explanation of why this ArtifactAssessment is needed and why it has been designed as it has.

Short Display Why this ArtifactAssessment is defined
Cardinality 0..1
Type markdown
Summary false
Comments

This element does not describe the usage of the ArtifactAssessment. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this ArtifactAssessment.

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

Short Display Notice about intellectual property ownership, can include restrictions on use
Cardinality 0..1
Type markdown
Requirements

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

Alternate Names License; Restrictions
Summary false
Element Id ArtifactAssessment.copyrightLabel
Definition

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

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Translatable true
Comments

The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Element Id ArtifactAssessment.usage
Definition

A detailed description of how the ArtifactAssessment is used from a clinical/user perspective.

Short Display Describes the clinical usage of the ArtifactAssessment
Cardinality 0..1
Type markdown
Summary false
Element Id ArtifactAssessment.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 Display When the artifact assessment was approved by publisher
Cardinality 0..1
Type date
Summary false
Comments

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

Element Id ArtifactAssessment.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 Display When the artifact assessment was last reviewed by the publisher
Cardinality 0..1
Type 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.

Summary true
Comments

If specified, this date follows the original approval date.

Element Id ArtifactAssessment.effectivePeriod
Definition

The period during which the ArtifactAssessment content was or is planned to be in active use.

Short Display When the ArtifactAssessment is expected to be used
Cardinality 0..1
Type Period
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ArtifactAssessment are or are expected to be used instead.

Summary true
Comments

The effective period for a ArtifactAssessment determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Element Id ArtifactAssessment.author
Definition

An individual or organization primarily involved in the development of the content in the ArtifactAssessment.

Short Display Who authored the ArtifactAssessment
Cardinality 0..*
Type ContactDetail
Summary false
Comments

An author does not necessarily have the authority to manage the actual publication of releases of the resource.

Element Id ArtifactAssessment.editor
Definition

An individual or organization primarily responsible for internal coherence of the ArtifactAssessment.

Short Display Who edited the ArtifactAssessment
Cardinality 0..*
Type ContactDetail
Summary false
Element Id ArtifactAssessment.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ArtifactAssessment.

Short Display Who reviewed the ArtifactAssessment
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

Element Id ArtifactAssessment.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the ArtifactAssessment for use in some setting.

Short Display Who endorsed the ArtifactAssessment
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

Element Id ArtifactAssessment.relatesTo
Definition

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

Short Display Relationship to other Resources
Cardinality 0..*
Summary false
Element Id ArtifactAssessment.relatesTo.type
Definition

The type of relationship to the related artifact.

Short Display 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
Cardinality 1..1
Terminology Binding Artifact Relationship Type icon (Extensible)
Type CodeableConcept
Summary false
Element Id ArtifactAssessment.relatesTo.target[x]
Definition

The artifact that is related to this ArtifactAssessment Resource.

Short Display The artifact that is related to this ArtifactAssessment
Cardinality 1..1
Type uri|Attachment|canonical(Any)|Reference(Any)|markdown
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Element Id ArtifactAssessment.citeAs
Definition

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

Short Display How to cite the comment or rating
Cardinality 0..1
Type markdown
Summary false
Element Id ArtifactAssessment.artifact[x]
Definition

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

Short Display The artifact assessed, commented upon or rated
Cardinality 1..1
Type Reference(Any)|canonical|uri
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id ArtifactAssessment.content
Definition

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

Short Display Comment, classifier, or rating content
Cardinality 0..*
Summary false
Element Id ArtifactAssessment.content.summary
Definition

A brief summary of the content of this component.

Short Display Brief summary of the content
Cardinality 0..1
Type markdown
Summary false
Element Id ArtifactAssessment.content.type
Definition

Indicates what type of content this component represents.

Short Display What type of content
Cardinality 0..1
Terminology Binding Evidence Certainty Type icon (Example)
Type CodeableConcept
Summary false
Element Id ArtifactAssessment.content.classifier
Definition

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

Short Display Rating, classifier, or assessment
Cardinality 0..*
Terminology Binding StatisticCertaintyRating icon (Example)
Type CodeableConcept
Summary false
Element Id ArtifactAssessment.content.quantity
Definition

A quantitative rating of the artifact.

Short Display Quantitative rating
Cardinality 0..1
Type Quantity
Summary false
Element Id ArtifactAssessment.content.author
Definition

Indicates who or what authored the content.

Short Display Who authored the content
Cardinality 0..*
Type Reference(Patient | Practitioner | PractitionerRole | Organization | Device)
Summary false
Element Id ArtifactAssessment.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 Display What the comment is directed to
Cardinality 0..*
Type uri
Summary false
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).

Element Id ArtifactAssessment.content.relatesTo
Definition

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

Short Display Relationship to other Resources
Cardinality 0..*
Type See ArtifactAssessment.relatesTo
Summary false
Element Id ArtifactAssessment.content.freeToShare
Definition

Acceptable to publicly share the comment, classifier or rating.

Short Display Acceptable to publicly share the content
Cardinality 0..1
Type boolean
Summary false
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.

Element Id ArtifactAssessment.content.component
Definition

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

Short Display Comment, classifier, or rating content
Cardinality 0..*
Type See ArtifactAssessment.content
Summary false
Element Id ArtifactAssessment.workflowStatus
Definition

Indicates the workflow status of the comment or change request.

Short Display submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Cardinality 0..1
Terminology Binding Artifact Assessment Workflow Status (Required)
Type code
Summary true
Element Id ArtifactAssessment.disposition
Definition

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

Short Display unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Cardinality 0..1
Terminology Binding Artifact Assessment Disposition (Required)
Type code
Summary true