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: Comment

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

Profile of ArtifactAssessment for Evidence Based Medicine IG. The Comment Profile is used for comments about a Resource that 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 Comment
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the Comment
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Comment was approved by publisher
... lastReviewDate 0..1 date When the Comment was last reviewed
... artifact[x] 1..1 Reference(Resource), canonical(), uri The artifact that is commented upon
... content 1..* BackboneElement A comment
.... informationType 0..0
.... freeToShare 0..1 boolean Acceptable to publicly share the Comment content
... workflowStatus 0..0
... disposition 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..* ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Additional identifier for the Comment
ele-1: All FHIR elements must have a @value or children
... citeAs[x] 0..1 How to cite the Comment
ele-1: All FHIR elements must have a @value or children
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... copyright 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the Comment was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate Σ 0..1 date When the Comment was last reviewed
ele-1: All FHIR elements must have a @value or children
... artifact[x] Σ 1..1 The artifact that is commented upon
ele-1: All FHIR elements must have a @value or children
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A comment
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
.... freeToShare 0..1 boolean Acceptable to publicly share the Comment content
ele-1: All FHIR elements must have a @value or children

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 Comment
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the Comment
.... 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 Comment was approved by publisher
... lastReviewDate Σ 0..1 date When the Comment was last reviewed
... artifact[x] Σ 1..1 The artifact that is commented upon
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A comment
.... 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
.... 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
.... 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 Comment content
.... component 0..* See content (ArtifactAssessment) Contained content

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

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 Comment
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the Comment
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the Comment was approved by publisher
... lastReviewDate 0..1 date When the Comment was last reviewed
... artifact[x] 1..1 Reference(Resource), canonical(), uri The artifact that is commented upon
... content 1..* BackboneElement A comment
.... informationType 0..0
.... freeToShare 0..1 boolean Acceptable to publicly share the Comment content
... workflowStatus 0..0
... disposition 0..0

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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
.... url 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... author 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Additional identifier for the Comment
ele-1: All FHIR elements must have a @value or children
... citeAs[x] 0..1 How to cite the Comment
ele-1: All FHIR elements must have a @value or children
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... copyright 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the Comment was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate Σ 0..1 date When the Comment was last reviewed
ele-1: All FHIR elements must have a @value or children
... artifact[x] Σ 1..1 The artifact that is commented upon
ele-1: All FHIR elements must have a @value or children
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A comment
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
.... freeToShare 0..1 boolean Acceptable to publicly share the Comment content
ele-1: All FHIR elements must have a @value or children

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 Comment
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the Comment
.... 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 Comment was approved by publisher
... lastReviewDate Σ 0..1 date When the Comment was last reviewed
... artifact[x] Σ 1..1 The artifact that is commented upon
.... artifactReference Reference(Resource)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 1..* BackboneElement A comment
.... 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
.... 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
.... 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 Comment content
.... component 0..* See content (ArtifactAssessment) Contained content

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

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