Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot International flag

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: Rating

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/rating Version: 2.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: Rating
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.76

Profile of ArtifactAssessment for Evidence Based Medicine IG. The Rating Profile is used for classifier tags that may include quantitative ratings and may be created independently from Resource creators.

See Understanding the ArtifactAssessment Resource for additional information.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ArtifactAssessment

NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... identifier 0..* Identifier Additional identifier for the Rating
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the Rating
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate 0..1 date When the Rating was last reviewed
... artifact[x] 1..1 Reference(Resource), canonical(), uri The artifact that is rated
... content 1..* BackboneElement A rating
.... quantity
..... value 1..1 decimal Numerical value (with implicit precision)
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... identifier Σ 0..* Identifier Additional identifier for the Rating
... citeAs[x] 0..1 How to cite the Rating
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate Σ 0..1 date When the Rating was last reviewed
... artifact[x] Σ 1..1 The artifact that is rated
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A rating
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorArtifactAssessmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorArtifactAssessmentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceArtifactAssessmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the Rating
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the Rating
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate Σ 0..1 date When the Rating was last reviewed
... artifact[x] Σ 1..1 The artifact that is rated
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A rating
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... informationType 0..1 code comment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: EvidenceCertaintyType (example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: EvidenceCertaintyRating (example)
.... quantity 0..1 Quantity Quantitative rating
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value 1..1 decimal Numerical value (with implicit precision)
..... comparator ?! 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit 0..1 string Unit representation
..... system C 0..1 uri System that defines coded unit form
..... code C 0..1 code Coded form of the unit
.... author 0..1 Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content
.... path 0..* uri What the comment is directed to
.... relatedArtifact 0..* RelatedArtifact Additional information
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content
.... component 0..* See content (ArtifactAssessment) Contained content
... workflowStatus Σ 0..1 code submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Binding: ArtifactAssessmentWorkflowStatus (required)
... disposition Σ 0..1 code unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Binding: ArtifactAssessmentDisposition (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ArtifactAssessment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType
http://hl7.org/fhir/ValueSet/artifactassessment-information-type|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.content.typeexampleEvidenceCertaintyType
http://hl7.org/fhir/ValueSet/certainty-type
from the FHIR Standard
ArtifactAssessment.content.classifierexampleEvidenceCertaintyRating
http://hl7.org/fhir/ValueSet/certainty-rating
from the FHIR Standard
ArtifactAssessment.content.quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.workflowStatusrequiredArtifactAssessmentWorkflowStatus
http://hl7.org/fhir/ValueSet/artifactassessment-workflow-status|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.dispositionrequiredArtifactAssessmentDisposition
http://hl7.org/fhir/ValueSet/artifactassessment-disposition|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorArtifactAssessmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorArtifactAssessmentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceArtifactAssessmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ArtifactAssessment

Differential View

This structure is derived from ArtifactAssessment

NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... identifier 0..* Identifier Additional identifier for the Rating
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the Rating
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate 0..1 date When the Rating was last reviewed
... artifact[x] 1..1 Reference(Resource), canonical(), uri The artifact that is rated
... content 1..* BackboneElement A rating
.... quantity
..... value 1..1 decimal Numerical value (with implicit precision)
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... identifier Σ 0..* Identifier Additional identifier for the Rating
... citeAs[x] 0..1 How to cite the Rating
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate Σ 0..1 date When the Rating was last reviewed
... artifact[x] Σ 1..1 The artifact that is rated
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A rating
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorArtifactAssessmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorArtifactAssessmentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceArtifactAssessmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the Rating
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the Rating
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Rating was approved by publisher
... lastReviewDate Σ 0..1 date When the Rating was last reviewed
... artifact[x] Σ 1..1 The artifact that is rated
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A rating
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... informationType 0..1 code comment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: EvidenceCertaintyType (example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: EvidenceCertaintyRating (example)
.... quantity 0..1 Quantity Quantitative rating
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value 1..1 decimal Numerical value (with implicit precision)
..... comparator ?! 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit 0..1 string Unit representation
..... system C 0..1 uri System that defines coded unit form
..... code C 0..1 code Coded form of the unit
.... author 0..1 Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content
.... path 0..* uri What the comment is directed to
.... relatedArtifact 0..* RelatedArtifact Additional information
.... freeToShare 0..1 boolean Acceptable to publicly share the rating content
.... component 0..* See content (ArtifactAssessment) Contained content
... workflowStatus Σ 0..1 code submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error
Binding: ArtifactAssessmentWorkflowStatus (required)
... disposition Σ 0..1 code unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification
Binding: ArtifactAssessmentDisposition (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ArtifactAssessment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType
http://hl7.org/fhir/ValueSet/artifactassessment-information-type|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.content.typeexampleEvidenceCertaintyType
http://hl7.org/fhir/ValueSet/certainty-type
from the FHIR Standard
ArtifactAssessment.content.classifierexampleEvidenceCertaintyRating
http://hl7.org/fhir/ValueSet/certainty-rating
from the FHIR Standard
ArtifactAssessment.content.quantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.workflowStatusrequiredArtifactAssessmentWorkflowStatus
http://hl7.org/fhir/ValueSet/artifactassessment-workflow-status|6.0.0-ballot2
from the FHIR Standard
ArtifactAssessment.dispositionrequiredArtifactAssessmentDisposition
http://hl7.org/fhir/ValueSet/artifactassessment-disposition|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorArtifactAssessmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorArtifactAssessmentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorArtifactAssessmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceArtifactAssessmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ArtifactAssessment

 

Other representations of profile: CSV, Excel, Schematron