Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - ballot
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. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/comparison | Version: 1.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: Comparison | ||
Profile of ArtifactAssessment for Evidence Based Medicine IG. The Comparison Profile is used for assessments of similarities and differences between knowledge artifacts.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Adaptation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ArtifactAssessment | 0..* | Adaptation | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
  comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |
 identifier | 0..* | Identifier | Additional identifier for the Comparison | |
| citeAs[x] | 0..1 | Reference(Citation), markdown | How to cite the Comparison | |
| date | 0..1 | dateTime | Date last changed | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the Comparison was approved by publisher | |
| lastReviewDate | 0..1 | date | When the Comparison was last reviewed | |
| artifact[x] | 1..1 | Reference(Resource), canonical(), uri | The artifact that is being compared | |
 content | ||||
  freeToShare | 0..1 | boolean | Acceptable to publicly share the content | |
| workflowStatus | 0..1 | code | The workflow status of the comparison and adaptation process | |
| disposition | 0..1 | code | The disposition of the proposed adaptation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ArtifactAssessment | 0..* | Adaptation | 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 | |
| url | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |
| description | 0..1 | markdown | Natural language description of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
| comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | Identifier | Additional identifier for the Comparison |
 citeAs[x] | 0..1 | How to cite the Comparison | ||
 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 Comparison was approved by publisher | |
| lastReviewDate | Σ | 0..1 | date | When the Comparison was last reviewed |
| artifact[x] | Σ | 1..1 | The artifact that is being compared | |
| artifactReference | Reference(Resource) | |||
| artifactCanonical | canonical(Any) | |||
| artifactUri | uri | |||
| workflowStatus | Σ | 0..1 | code | The workflow status of the comparison and adaptation process Binding: ArtifactAssessmentWorkflowStatus (required) |
| disposition | Σ | 0..1 | code | The disposition of the proposed adaptation Binding: ArtifactAssessmentDisposition (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ArtifactAssessment.workflowStatus | required | ArtifactAssessmentWorkflowStatus |
| ArtifactAssessment.disposition | required | ArtifactAssessmentDisposition |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ArtifactAssessment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ArtifactAssessment | 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 : 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-4 | error | ArtifactAssessment | If 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-5 | error | ArtifactAssessment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ArtifactAssessment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ArtifactAssessment | 0..* | Adaptation | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
| description | 0..1 | markdown | Natural language description of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
| comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the Comparison | ||||
| title | Σ | 0..1 | string | A short title for the assessment for use in displaying and selecting | ||||
| citeAs[x] | 0..1 | How to cite the Comparison | ||||||
| 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 Comparison was approved by publisher | |||||
| lastReviewDate | Σ | 0..1 | date | When the Comparison was last reviewed | ||||
| artifact[x] | Σ | 1..1 | The artifact that is being compared | |||||
| artifactReference | Reference(Resource) | |||||||
| artifactCanonical | canonical(Any) | |||||||
| artifactUri | uri | |||||||
| content | 0..* | BackboneElement | A comment, rating or classification | |||||
| 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 | |||||
| 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 content | |||||
| component | 0..* | See content (ArtifactAssessment) | Contained content | |||||
| workflowStatus | Σ | 0..1 | code | The workflow status of the comparison and adaptation process Binding: ArtifactAssessmentWorkflowStatus (required) | ||||
| disposition | Σ | 0..1 | code | The disposition of the proposed adaptation Binding: ArtifactAssessmentDisposition (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| ArtifactAssessment.language | required | AllLanguages |
| ArtifactAssessment.content.informationType | required | ArtifactAssessmentInformationType |
| ArtifactAssessment.content.type | example | EvidenceCertaintyType |
| ArtifactAssessment.content.classifier | example | EvidenceCertaintyRating |
| ArtifactAssessment.workflowStatus | required | ArtifactAssessmentWorkflowStatus |
| ArtifactAssessment.disposition | required | ArtifactAssessmentDisposition |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ArtifactAssessment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ArtifactAssessment | 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 : 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-4 | error | ArtifactAssessment | If 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-5 | error | ArtifactAssessment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ArtifactAssessment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Adaptation
Differential View
This structure is derived from Adaptation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ArtifactAssessment | 0..* | Adaptation | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
| comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |
| identifier | 0..* | Identifier | Additional identifier for the Comparison | |
| citeAs[x] | 0..1 | Reference(Citation), markdown | How to cite the Comparison | |
| date | 0..1 | dateTime | Date last changed | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the Comparison was approved by publisher | |
| lastReviewDate | 0..1 | date | When the Comparison was last reviewed | |
| artifact[x] | 1..1 | Reference(Resource), canonical(), uri | The artifact that is being compared | |
| content | ||||
| freeToShare | 0..1 | boolean | Acceptable to publicly share the content | |
| workflowStatus | 0..1 | code | The workflow status of the comparison and adaptation process | |
| disposition | 0..1 | code | The disposition of the proposed adaptation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ArtifactAssessment | 0..* | Adaptation | 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 | |
| url | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |
| description | 0..1 | markdown | Natural language description of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
| comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Additional identifier for the Comparison |
| citeAs[x] | 0..1 | How to cite the Comparison | ||
| 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 Comparison was approved by publisher | |
| lastReviewDate | Σ | 0..1 | date | When the Comparison was last reviewed |
| artifact[x] | Σ | 1..1 | The artifact that is being compared | |
| artifactReference | Reference(Resource) | |||
| artifactCanonical | canonical(Any) | |||
| artifactUri | uri | |||
| workflowStatus | Σ | 0..1 | code | The workflow status of the comparison and adaptation process Binding: ArtifactAssessmentWorkflowStatus (required) |
| disposition | Σ | 0..1 | code | The disposition of the proposed adaptation Binding: ArtifactAssessmentDisposition (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ArtifactAssessment.workflowStatus | required | ArtifactAssessmentWorkflowStatus |
| ArtifactAssessment.disposition | required | ArtifactAssessmentDisposition |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ArtifactAssessment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ArtifactAssessment | 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 : 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-4 | error | ArtifactAssessment | If 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-5 | error | ArtifactAssessment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ArtifactAssessment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ArtifactAssessment | 0..* | Adaptation | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
| description | 0..1 | markdown | Natural language description of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| author | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
| comparedArtifact | 0..* | canonical(), uri, Reference() | The artifact being compared to the referenced artifact URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-assessment-compared | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the Comparison | ||||
| title | Σ | 0..1 | string | A short title for the assessment for use in displaying and selecting | ||||
| citeAs[x] | 0..1 | How to cite the Comparison | ||||||
| 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 Comparison was approved by publisher | |||||
| lastReviewDate | Σ | 0..1 | date | When the Comparison was last reviewed | ||||
| artifact[x] | Σ | 1..1 | The artifact that is being compared | |||||
| artifactReference | Reference(Resource) | |||||||
| artifactCanonical | canonical(Any) | |||||||
| artifactUri | uri | |||||||
| content | 0..* | BackboneElement | A comment, rating or classification | |||||
| 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 | |||||
| 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 content | |||||
| component | 0..* | See content (ArtifactAssessment) | Contained content | |||||
| workflowStatus | Σ | 0..1 | code | The workflow status of the comparison and adaptation process Binding: ArtifactAssessmentWorkflowStatus (required) | ||||
| disposition | Σ | 0..1 | code | The disposition of the proposed adaptation Binding: ArtifactAssessmentDisposition (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| ArtifactAssessment.language | required | AllLanguages |
| ArtifactAssessment.content.informationType | required | ArtifactAssessmentInformationType |
| ArtifactAssessment.content.type | example | EvidenceCertaintyType |
| ArtifactAssessment.content.classifier | example | EvidenceCertaintyRating |
| ArtifactAssessment.workflowStatus | required | ArtifactAssessmentWorkflowStatus |
| ArtifactAssessment.disposition | required | ArtifactAssessmentDisposition |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ArtifactAssessment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ArtifactAssessment | 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 : 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-4 | error | ArtifactAssessment | If 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-5 | error | ArtifactAssessment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ArtifactAssessment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Adaptation
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#1.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change