Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
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
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/outcome-list | Version: 2.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: OutcomeList | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.65 | ||||
Profile of List for Evidence Based Medicine IG. The OutcomeList Profile is used to provide a list of outcomes. The OutcomeList Profile is referenced in the EvidenceReportSubject Profile as a way to define the set of outcomes that an EvidenceReport is about.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List |
0..* | List | A list is a curated collection of resources | |
  code |
||||
 coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
  system |
1..1 | uri | Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OutcomeList | |
 display |
1..1 | string | Representation defined by the system Fixed Value: OutcomeList | |
| text |
0..1 | string | Plain text representation of the concept Required Pattern: Outcome List | |
| encounter |
0..0 | |||
 entry |
||||
  item |
1..1 | Reference(OutcomeDefinition | VariableDefinition) | Actual entry | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | List | A list is a curated collection of resources 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 lst-1: A list can only have an emptyReason if it is empty |
 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 | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|6.0.0-ballot2from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | 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()) | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty | ||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OutcomeList | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: OutcomeList | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept Required Pattern: Outcome List | |||||
| subject |
Σ | 0..* | Reference(Resource) | If all resources have the same subject(s) | ||||
| date |
Σ | 0..1 | dateTime | When the list was prepared | ||||
| source |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device | Organization | RelatedPerson | CareTeam) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
0..* | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. | ||||
| 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 | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?! | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(OutcomeDefinition | VariableDefinition) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| List.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|6.0.0-ballot2from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|6.0.0-ballot2from the FHIR Standard | |
| List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | |
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | |
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | |
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | 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()) | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
This structure is derived from List
Summary
Mandatory: 0 element(1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
0..* | List | A list is a curated collection of resources | |
| code |
||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OutcomeList | |
| display |
1..1 | string | Representation defined by the system Fixed Value: OutcomeList | |
| text |
0..1 | string | Plain text representation of the concept Required Pattern: Outcome List | |
| encounter |
0..0 | |||
| entry |
||||
| item |
1..1 | Reference(OutcomeDefinition | VariableDefinition) | Actual entry | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | List | A list is a curated collection of resources 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 lst-1: A list can only have an emptyReason if it is empty |
| 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 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|6.0.0-ballot2from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | 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()) | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | List | A list is a curated collection of resources lst-1: A list can only have an emptyReason if it is empty | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://fevir.net/resources/CodeSystem/179423 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: OutcomeList | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: OutcomeList | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept Required Pattern: Outcome List | |||||
| subject |
Σ | 0..* | Reference(Resource) | If all resources have the same subject(s) | ||||
| date |
Σ | 0..1 | dateTime | When the list was prepared | ||||
| source |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device | Organization | RelatedPerson | CareTeam) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
0..* | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. | ||||
| 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 | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?! | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(OutcomeDefinition | VariableDefinition) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| List.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|6.0.0-ballot2from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|6.0.0-ballot2from the FHIR Standard | |
| List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | |
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | |
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | |
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | List | 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()) | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |
This structure is derived from List
Summary
Mandatory: 0 element(1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#2.0.0-ballot based on FHIR 6.0.0-ballot2. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change