This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the ebmrecommendation Profile.
ArtifactAssessment | |||||||||||||||||||||||||
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 | 1..1 | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.id | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.id | ||||||||||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||||||||||||||
Short Display | Logical id of this artifact | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||||||||||||||
ArtifactAssessment.meta | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.meta | ||||||||||||||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||||||||||||||
Short Display | Metadata about the resource | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Meta | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.implicitRules | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.implicitRules | ||||||||||||||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation) | ||||||||||||||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.language | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.language | ||||||||||||||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||||||||||||||
Short Display | Language of the resource content | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | IETF language tag The codes SHOULD be taken from Common Languages | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.text | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.text | ||||||||||||||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||||||||||||||
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.contained | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.contained | ||||||||||||||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||||||||||||||
Short Display | Contained, inline Resources | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||||||||||||||
ArtifactAssessment.extension | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.modifierExtension | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.identifier | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the artifact assessment. | ||||||||||||||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.citeAs[x] | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.citeAs[x] | ||||||||||||||||||||||||
Definition | Display of or reference to the bibliographic citation of the recommendation. | ||||||||||||||||||||||||
Short Display | How to cite the recommendation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Choice of: Reference(Citation), markdown | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||||||||||||||
ArtifactAssessment.date | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.copyright | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.copyright | ||||||||||||||||||||||||
Definition | A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment. | ||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.approvalDate | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.lastReviewDate | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Comments | If specified, this date follows the original approval date. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.artifact[x] | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.artifact[x] | ||||||||||||||||||||||||
Definition | A reference to a resource, canonical resource, or non-FHIR resource which is the recommendation this comment or assessment is about. | ||||||||||||||||||||||||
Short Display | The artifact assessed, commented upon or rated | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | Choice of: Reference(PlanDefinition), canonical, uri | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||||||||||||||
ArtifactAssessment.content | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content | ||||||||||||||||||||||||
Definition | A component comment, classifier, or rating of the artifact. | ||||||||||||||||||||||||
Short Display | Comment, classifier, or rating content | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.id | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
ArtifactAssessment.content.extension | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.modifierExtension | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.informationType | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.informationType | ||||||||||||||||||||||||
Definition | The type of information this component of the content represents. | ||||||||||||||||||||||||
Short Display | comment | classifier | rating | container | response | change-request | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | null The codes SHALL be taken from Artifact Assessment Information Type | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.summary | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.type | |||||||||||||||||||||||||
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 | null For example codes, see EvidenceCertaintyType | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.classifier | |||||||||||||||||||||||||
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 | null For example codes, see EvidenceCertaintyRating | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.author | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.author | ||||||||||||||||||||||||
Definition | Indicates who or what authored the content. | ||||||||||||||||||||||||
Short Display | Who authored the content | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Patient) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.path | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
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). | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.relatedArtifact | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.relatedArtifact | ||||||||||||||||||||||||
Definition | Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content. | ||||||||||||||||||||||||
Short Display | Additional information | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.freeToShare | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.freeToShare | ||||||||||||||||||||||||
Definition | Acceptable to publicly share the comment, classifier or rating. | ||||||||||||||||||||||||
Short Display | Acceptable to publicly share the resource content | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.content.component | |||||||||||||||||||||||||
Element Id | ArtifactAssessment.content.component | ||||||||||||||||||||||||
Definition | If the informationType is container, the components of the content. | ||||||||||||||||||||||||
Short Display | Contained content | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ArtifactAssessment#ArtifactAssessment.content | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.workflowStatus | |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Cardinality | 0..0 | ||||||||||||||||||||||||
Terminology Binding | null The codes SHALL be taken from Artifact Assessment Workflow Status | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ArtifactAssessment.disposition | |||||||||||||||||||||||||
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..0 | ||||||||||||||||||||||||
Terminology Binding | null The codes SHALL be taken from Artifact Assessment Disposition | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
|