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/group-assignment | Version: 1.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: GroupAssignment | ||
Profile of EvidenceVariable for Evidence Based Medicine IG. The GroupAssignment Profile is used to classify an EvidenceVariable as an exposure managed as a categorical variable. The variable definitions are found in the category element instead of the definition element.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from VariableDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EvidenceVariable | VariableDefinition | |||
  extension:definition | 1..1 | EvidenceVariableDefinition | Defines the variable with a concept and/or Reference | |
   value[x] | ||||
  concept | ||||
| 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: defined-in-handling-and-category | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Defined in handling and category elements | |
| category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| name | 1..1 | string | Description of the grouping | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EvidenceVariable | C | 0..* | VariableDefinition | A definition of an exposure, outcome, or other variable |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| definition | 1..1 | CodeableReference(Group) | Defines the variable with a concept and/or Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition | |
 extension | 0..0 | |||
 url | 1..1 | uri | "http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition" | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| handling | 1..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |
 category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| valueReference | 0..1 | Reference(Group) | Defines the categorical value with a Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | 1..1 | string | Description of the grouping | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| EvidenceVariable.status | required | PublicationStatus |
| EvidenceVariable.handling | required | EvidenceVariableHandling |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | EvidenceVariable | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| EvidenceVariable | C | 0..* | VariableDefinition | A definition of an exposure, outcome, or other variable | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| definition | 1..1 | CodeableReference(Group) | Defines the variable with a concept and/or Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition" | |||||
 value[x] | 0..1 | CodeableReference(Group) | Value of extension | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
| 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: defined-in-handling-and-category | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Defined in handling and category elements | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | ΣC | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable | ||||
| version | Σ | 0..1 | string | Business version of the evidence variable | ||||
 versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString | string | |||||||
| versionAlgorithmCoding | Coding | |||||||
| name | ΣC | 0..1 | string | Name for this evidence variable (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this evidence variable (human friendly) | ||||
| shortTitle | Σ | 0..1 | string | Title for use in informal contexts | ||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | 0..1 | boolean | For testing purposes, not real usage | |||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the evidence variable | ||||
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| purpose | 0..1 | markdown | Why this EvidenceVariable is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
| approvalDate | 0..1 | date | When the resource was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the resource was last reviewed by the publisher | |||||
| effectivePeriod | 0..1 | Period | When the resource is expected to be used | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| actual | 0..1 | boolean | Actual or conceptual | |||||
| handling | 1..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |||||
| category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| valueReference | 0..1 | Reference(Group) | Defines the categorical value with a Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | 1..1 | string | Description of the grouping | |||||
| value[x] | 0..1 | Definition of the grouping | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| EvidenceVariable.language | required | AllLanguages |
| EvidenceVariable.versionAlgorithm[x] | extensible | VersionAlgorithm |
| EvidenceVariable.status | required | PublicationStatus |
| EvidenceVariable.characteristic.definitionByTypeAndValue.type | example | UsageContextType |
| EvidenceVariable.characteristic.definitionByTypeAndValue.method | example | DefinitionMethod |
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset | example | CharacteristicOffset |
| EvidenceVariable.characteristic.definitionByCombination.code | required | CharacteristicCombination |
| EvidenceVariable.characteristic.timeFromEvent.event[x] | example | EvidenceVariableEvent |
| EvidenceVariable.handling | required | EvidenceVariableHandling |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | EvidenceVariable | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | EvidenceVariable.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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 VariableDefinition
Differential View
This structure is derived from VariableDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EvidenceVariable | VariableDefinition | |||
| extension:definition | 1..1 | EvidenceVariableDefinition | Defines the variable with a concept and/or Reference | |
| value[x] | ||||
| concept | ||||
| 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: defined-in-handling-and-category | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Defined in handling and category elements | |
| category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| name | 1..1 | string | Description of the grouping | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EvidenceVariable | C | 0..* | VariableDefinition | A definition of an exposure, outcome, or other variable |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| definition | 1..1 | CodeableReference(Group) | Defines the variable with a concept and/or Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| handling | 1..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |
| category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| valueReference | 0..1 | Reference(Group) | Defines the categorical value with a Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | 1..1 | string | Description of the grouping | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| EvidenceVariable.status | required | PublicationStatus |
| EvidenceVariable.handling | required | EvidenceVariableHandling |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | EvidenceVariable | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| EvidenceVariable | C | 0..* | VariableDefinition | A definition of an exposure, outcome, or other variable | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| definition | 1..1 | CodeableReference(Group) | Defines the variable with a concept and/or Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition" | |||||
| value[x] | 0..1 | CodeableReference(Group) | Value of extension | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
| 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: defined-in-handling-and-category | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Defined in handling and category elements | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | ΣC | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable | ||||
| version | Σ | 0..1 | string | Business version of the evidence variable | ||||
| versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString | string | |||||||
| versionAlgorithmCoding | Coding | |||||||
| name | ΣC | 0..1 | string | Name for this evidence variable (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this evidence variable (human friendly) | ||||
| shortTitle | Σ | 0..1 | string | Title for use in informal contexts | ||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | 0..1 | boolean | For testing purposes, not real usage | |||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the evidence variable | ||||
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| purpose | 0..1 | markdown | Why this EvidenceVariable is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
| approvalDate | 0..1 | date | When the resource was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the resource was last reviewed by the publisher | |||||
| effectivePeriod | 0..1 | Period | When the resource is expected to be used | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
| endorser | 0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| actual | 0..1 | boolean | Actual or conceptual | |||||
| handling | 1..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |||||
| category | 2..* | BackboneElement | A grouping for ordinal or polychotomous variables | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| valueReference | 0..1 | Reference(Group) | Defines the categorical value with a Reference URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | 1..1 | string | Description of the grouping | |||||
| value[x] | 0..1 | Definition of the grouping | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| EvidenceVariable.language | required | AllLanguages |
| EvidenceVariable.versionAlgorithm[x] | extensible | VersionAlgorithm |
| EvidenceVariable.status | required | PublicationStatus |
| EvidenceVariable.characteristic.definitionByTypeAndValue.type | example | UsageContextType |
| EvidenceVariable.characteristic.definitionByTypeAndValue.method | example | DefinitionMethod |
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset | example | CharacteristicOffset |
| EvidenceVariable.characteristic.definitionByCombination.code | required | CharacteristicCombination |
| EvidenceVariable.characteristic.timeFromEvent.event[x] | example | EvidenceVariableEvent |
| EvidenceVariable.handling | required | EvidenceVariableHandling |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | EvidenceVariable | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | EvidenceVariable.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| 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 VariableDefinition
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