Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot International flag

This page is part of the Using CQL with FHIR Implementation Guide (v3.0.0-ballot: STU 3 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: CQL Group Result

Official URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-groupresult Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: CQLGroupResult
Other Identifiers: OID:2.16.840.1.113883.4.642.40.37.42.24

The CQL Group Result profile defines conformance expectations for the result of evaluating a FHIR Group Definition. This profile is intended to be consistent with and able to be used as an actual group definition in other contexts such as the various evaluate operations defined in clinical reasoning.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom"
..... value[x] 1..1 canonical() Value of extension
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... member SC 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource
Slice: Unordered, Open by value:url

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group 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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension Content/Rules for all slices
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... value[x] 1..1 canonical() Value of extension
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... actual 1..1 boolean Descriptive or actual
Fixed Value: true
... code S 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom"
..... value[x] 1..1 canonical() Value of extension
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... value 0..1 string Primitive value for canonical
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique id
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... name Σ 0..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... member SC 0..* BackboneElement Who or what is in group
.... 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
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... id 0..1 string Unique id for inter-element referencing
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group 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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom"
..... value[x] 1..1 canonical() Value of extension
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... member SC 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource
Slice: Unordered, Open by value:url

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group 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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension Content/Rules for all slices
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... value[x] 1..1 canonical() Value of extension
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... actual 1..1 boolean Descriptive or actual
Fixed Value: true
... code S 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:generatedFrom S 0..1 (Complex) Auto-created based on
URL: http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/workflow-generatedFrom"
..... value[x] 1..1 canonical() Value of extension
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 1..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
...... value 0..1 string Primitive value for canonical
.... extension:inputParameters S 0..1 (Complex) What parameters
URL: http://hl7.org/fhir/StructureDefinition/cqf-inputParameters
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-inputParameters"
..... value[x] 1..1 Reference(CQL Parameters) Value of extension
.... extension:messages S 0..1 Reference(OperationOutcome) Evaluation messages
URL: http://hl7.org/fhir/StructureDefinition/cqf-messages
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique id
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 0..1 CodeableConcept Type of individual the cohort is made up of
Binding: SubjectType (extensible)
... name Σ 0..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... member SC 0..* BackboneElement Who or what is in group
.... 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
.... entity S 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... id 0..1 string Unique id for inter-element referencing
..... extension S 0..* Reference() A resource used to determine membership
URL: http://hl7.org/fhir/uv/cql/StructureDefinition/cql-evaluatedResource
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base extensible Subject type 📦4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.member.entity.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group 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 Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group 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()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

 

Other representations of profile: CSV, Excel, Schematron