Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines
2.0.0-ballot - ballot
This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-casesummarydefinition | Version: 2.0.0-ballot | |||
| Active as of 2023-12-19 | Computable Name: CPGCaseSummaryDefinition | |||
CPG Case Summary Definition provides a computable definition for all the case features and feature groups relevant to a clinical practice guideline
This is a domain definition profile
Examples:
Definition of the case summary document for a congestive heart failure pathway
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGComputableGraphDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  GraphDefinition | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GraphDefinition | C | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| name | ΣC | 1..1 | string | Name for this graph definition (computer friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| start | SΣ | 1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
  link | S | 0..* | BackboneElement | Links this graph makes rules about |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| GraphDefinition.status | required | PublicationStatus |
| GraphDefinition.start | required | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | GraphDefinition | 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 | GraphDefinition | 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 | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | GraphDefinition | 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() | |
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition | C | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources | ||||
| 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: CommonLanguages (preferred): 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 | |||||
| summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | ||||
| version | Σ | 0..1 | string | Business version of the graph definition | ||||
| name | ΣC | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| 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 (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the graph definition | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this graph definition is defined | |||||
| start | SΣ | 1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| profile | 0..1 | canonical(StructureDefinition) | Profile on base resource | |||||
| link | S | 0..* | BackboneElement | Links this graph makes rules about | ||||
| 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 | ||||
| path | 0..1 | string | Path in the resource that contains the link | |||||
| sliceName | 0..1 | string | Which slice (if profiled) | |||||
| min | 0..1 | integer | Minimum occurrences for this link | |||||
| max | 0..1 | string | Maximum occurrences for this link | |||||
| description | 0..1 | string | Why this link is specified | |||||
| target | 0..* | BackboneElement | Potential target for the link | |||||
| 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 | ||||
| type | 1..1 | code | Type of resource this link refers to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| params | 0..1 | string | Criteria for reverse lookup | |||||
| profile | 0..1 | canonical(StructureDefinition) | Profile for the target resource | |||||
 compartment | 0..* | BackboneElement | Compartment Consistency Rules | |||||
 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 | ||||
| use | 1..1 | code | condition | requirement Binding: GraphCompartmentUse (required): Defines how a compartment rule is used. | |||||
| code | 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device Binding: CompartmentType (required): Identifies a compartment. | |||||
| rule | 1..1 | code | identical | matching | different | custom Binding: GraphCompartmentRule (required): How a compartment must be linked. | |||||
| expression | 0..1 | string | Custom rule, as a FHIRPath expression | |||||
| description | 0..1 | string | Documentation for FHIRPath expression | |||||
 link | 0..* | See link (GraphDefinition) | Additional links from target resource | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| GraphDefinition.language | preferred | CommonLanguages
| ||||
| GraphDefinition.status | required | PublicationStatus | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| GraphDefinition.start | required | ResourceType | ||||
| GraphDefinition.link.target.type | required | ResourceType | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRule |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | GraphDefinition | 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 | GraphDefinition | 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 | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | GraphDefinition | 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() | |
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from CPGComputableGraphDefinition
Differential View
This structure is derived from CPGComputableGraphDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GraphDefinition | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GraphDefinition | C | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| name | ΣC | 1..1 | string | Name for this graph definition (computer friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| start | SΣ | 1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| link | S | 0..* | BackboneElement | Links this graph makes rules about |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| GraphDefinition.status | required | PublicationStatus |
| GraphDefinition.start | required | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | GraphDefinition | 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 | GraphDefinition | 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 | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | GraphDefinition | 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() | |
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition | C | 0..* | CPGComputableGraphDefinition | Definition of a graph of resources | ||||
| 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: CommonLanguages (preferred): 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 | |||||
| summaryDefinitionFor | S | 0..1 | canonical() | Which guideline? URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-summaryDefinitionFor | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | ||||
| version | Σ | 0..1 | string | Business version of the graph definition | ||||
| name | ΣC | 1..1 | string | Name for this graph definition (computer friendly) | ||||
| 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 (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the graph definition | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this graph definition is defined | |||||
| start | SΣ | 1..1 | code | Type of resource at which the graph starts Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| profile | 0..1 | canonical(StructureDefinition) | Profile on base resource | |||||
| link | S | 0..* | BackboneElement | Links this graph makes rules about | ||||
| 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 | ||||
| path | 0..1 | string | Path in the resource that contains the link | |||||
| sliceName | 0..1 | string | Which slice (if profiled) | |||||
| min | 0..1 | integer | Minimum occurrences for this link | |||||
| max | 0..1 | string | Maximum occurrences for this link | |||||
| description | 0..1 | string | Why this link is specified | |||||
| target | 0..* | BackboneElement | Potential target for the link | |||||
| 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 | ||||
| type | 1..1 | code | Type of resource this link refers to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| params | 0..1 | string | Criteria for reverse lookup | |||||
| profile | 0..1 | canonical(StructureDefinition) | Profile for the target resource | |||||
| compartment | 0..* | BackboneElement | Compartment Consistency Rules | |||||
| 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 | ||||
| use | 1..1 | code | condition | requirement Binding: GraphCompartmentUse (required): Defines how a compartment rule is used. | |||||
| code | 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device Binding: CompartmentType (required): Identifies a compartment. | |||||
| rule | 1..1 | code | identical | matching | different | custom Binding: GraphCompartmentRule (required): How a compartment must be linked. | |||||
| expression | 0..1 | string | Custom rule, as a FHIRPath expression | |||||
| description | 0..1 | string | Documentation for FHIRPath expression | |||||
| link | 0..* | See link (GraphDefinition) | Additional links from target resource | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| GraphDefinition.language | preferred | CommonLanguages
| ||||
| GraphDefinition.status | required | PublicationStatus | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| GraphDefinition.start | required | ResourceType | ||||
| GraphDefinition.link.target.type | required | ResourceType | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRule |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | GraphDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | GraphDefinition | 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 | GraphDefinition | 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 | GraphDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | GraphDefinition | 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() | |
| gdf-0 | warning | GraphDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from CPGComputableGraphDefinition
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change