Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines, 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/cqf-recommendations/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-case | Version: 2.0.0-ballot | |||
| Active as of 2024-04-14 | Computable Name: CPGCase | |||
CPG case represents a specific case of a patient enrolled in a particular pathway. The enrollment may have been automatic, prompted, or manual.
This is a domain case/instance profile
Examples:
EpisodeOfCare/chf-scenario1-eoc EpisodeOfCare/chf-scenario1-eoc
EpisodeOfCare/ep-scenario4-eoc EpisodeOfCare/ep-scenario4-eoc
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EpisodeOfCare |
EpisodeOfCare | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
 type |
0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care | |
 diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
   condition |
1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for | |
| patient |
1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care | |
| period |
S | 0..1 | Period | Interval during responsibility is assumed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
 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 | |
| enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
 type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care |
| diagnosis |
Σ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition |
Σ | 1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for |
| patient |
Σ | 1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care |
| period |
SΣ | 0..1 | Period | Interval during responsibility is assumed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| 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 | |||||
| enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care | ||||
| diagnosis |
Σ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| 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 | ||||
| condition |
Σ | 1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient |
Σ | 1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
| period |
SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| EpisodeOfCare.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
EpisodeOfCare | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
| type |
0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care | |
| diagnosis |
1..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| condition |
1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for | |
| patient |
1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care | |
| period |
S | 0..1 | Period | Interval during responsibility is assumed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| 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 | |
| enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care |
| diagnosis |
Σ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition |
Σ | 1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for |
| patient |
Σ | 1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care |
| period |
SΣ | 0..1 | Period | Interval during responsibility is assumed |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare |
0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| 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 | |||||
| enrolledIn |
S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory |
0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care | ||||
| diagnosis |
Σ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| 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 | ||||
| condition |
Σ | 1..1 | Reference(CPG Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient |
Σ | 1..1 | Reference(CPG Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that assumes care | ||||
| period |
SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
| referralRequest |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| EpisodeOfCare.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-typefrom the FHIR Standard | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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 2024-04-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change