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

This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: Comment

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

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.

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..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... identifier 0..*IdentifierAdditional identifier for the Comment
... citeAs[x] 0..1Reference(Citation), markdownHow to cite the Comment
... date 0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate 0..1dateWhen the Comment was last reviewed
... artifact[x] 1..1Reference(Resource), canonical(), uriThe artifact that is commented upon
... content 1..*BackboneElementA comment
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
.... freeToShare 0..1booleanAcceptable to publicly share the Comment content
... workflowStatus 0..0
... disposition 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ArtifactAssessment 0..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... author 0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAdditional identifier for the Comment
... citeAs[x] 0..1How to cite the Comment
.... citeAsReferenceReference(Citation)
.... citeAsMarkdownmarkdown
... date Σ0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate Σ0..1dateWhen the Comment was last reviewed
... artifact[x] Σ1..1The artifact that is commented upon
.... artifactReferenceReference(Resource)
.... artifactCanonicalcanonical(Any)
.... artifactUriuri
... content 1..*BackboneElementA comment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... freeToShare 0..1booleanAcceptable to publicly share the Comment content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType

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..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... author 0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAdditional identifier for the Comment
... title Σ0..1stringA short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1How to cite the Comment
.... citeAsReferenceReference(Citation)
.... citeAsMarkdownmarkdown
... date Σ0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate Σ0..1dateWhen the Comment was last reviewed
... artifact[x] Σ1..1The artifact that is commented upon
.... artifactReferenceReference(Resource)
.... artifactCanonicalcanonical(Any)
.... artifactUriuri
... content 1..*BackboneElementA comment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... summary 0..1markdownBrief summary of the content
.... type 0..1CodeableConceptWhat type of content
Binding: EvidenceCertaintyType (example)
.... classifier 0..*CodeableConceptRating, classifier, or assessment
Binding: EvidenceCertaintyRating (example)
.... quantity 0..1QuantityQuantitative rating
.... author 0..1Reference(Patient | Practitioner | PractitionerRole | Organization | Device)Who authored the content
.... path 0..*uriWhat the comment is directed to
.... relatedArtifact 0..*RelatedArtifactAdditional information
.... freeToShare 0..1booleanAcceptable to publicly share the Comment content
.... component 0..*See content (ArtifactAssessment)Contained content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ArtifactAssessment.languagerequiredAllLanguages
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType
ArtifactAssessment.content.typeexampleEvidenceCertaintyType
ArtifactAssessment.content.classifierexampleEvidenceCertaintyRating

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..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... identifier 0..*IdentifierAdditional identifier for the Comment
... citeAs[x] 0..1Reference(Citation), markdownHow to cite the Comment
... date 0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate 0..1dateWhen the Comment was last reviewed
... artifact[x] 1..1Reference(Resource), canonical(), uriThe artifact that is commented upon
... content 1..*BackboneElementA comment
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
.... freeToShare 0..1booleanAcceptable 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..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... author 0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAdditional identifier for the Comment
... citeAs[x] 0..1How to cite the Comment
.... citeAsReferenceReference(Citation)
.... citeAsMarkdownmarkdown
... date Σ0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate Σ0..1dateWhen the Comment was last reviewed
... artifact[x] Σ1..1The artifact that is commented upon
.... artifactReferenceReference(Resource)
.... artifactCanonicalcanonical(Any)
.... artifactUriuri
... content 1..*BackboneElementA comment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... freeToShare 0..1booleanAcceptable to publicly share the Comment content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType

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..*ArtifactAssessmentAdds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 0..1uriCanonical identifier for this {{title}}, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
... description 0..1markdownNatural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... author 0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAdditional identifier for the Comment
... title Σ0..1stringA short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1How to cite the Comment
.... citeAsReferenceReference(Citation)
.... citeAsMarkdownmarkdown
... date Σ0..1dateTimeDate last changed
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the Comment was approved by publisher
... lastReviewDate Σ0..1dateWhen the Comment was last reviewed
... artifact[x] Σ1..1The artifact that is commented upon
.... artifactReferenceReference(Resource)
.... artifactCanonicalcanonical(Any)
.... artifactUriuri
... content 1..*BackboneElementA comment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... informationType 0..1codecomment | classifier | rating | container | response | change-request
Binding: ArtifactAssessmentInformationType (required)
.... summary 0..1markdownBrief summary of the content
.... type 0..1CodeableConceptWhat type of content
Binding: EvidenceCertaintyType (example)
.... classifier 0..*CodeableConceptRating, classifier, or assessment
Binding: EvidenceCertaintyRating (example)
.... quantity 0..1QuantityQuantitative rating
.... author 0..1Reference(Patient | Practitioner | PractitionerRole | Organization | Device)Who authored the content
.... path 0..*uriWhat the comment is directed to
.... relatedArtifact 0..*RelatedArtifactAdditional information
.... freeToShare 0..1booleanAcceptable to publicly share the Comment content
.... component 0..*See content (ArtifactAssessment)Contained content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ArtifactAssessment.languagerequiredAllLanguages
ArtifactAssessment.content.informationTyperequiredArtifactAssessmentInformationType
ArtifactAssessment.content.typeexampleEvidenceCertaintyType
ArtifactAssessment.content.classifierexampleEvidenceCertaintyRating

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