This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-case
CPG case represents a specific case of a patient enrolled in a particular pathway. The enrollment may have been automatic, prompted, or manual.
This profile builds on EpisodeOfCare.
This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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 | |
cpg-enrolledIn | S | 0..* | canonical() | Which pathway URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
identifier | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
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(CPGCondition) | Conditions/problems/diagnoses this episode of care is for | |
patient | 1..1 | Reference(CPGPatient) | 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 |
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 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-enrolledIn | S | 0..* | canonical() | Which pathway 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(CPGCondition) | 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(CPGPatient) | 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 |
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
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 | |
cpg-enrolledIn | S | 0..* | canonical() | Which pathway URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
identifier | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
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(CPGCondition) | Conditions/problems/diagnoses this episode of care is for | |
patient | 1..1 | Reference(CPGPatient) | 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 |
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 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cpg-enrolledIn | S | 0..* | canonical() | Which pathway 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(CPGCondition) | 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(CPGPatient) | 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 |
EpisodeOfCare.language | preferred | CommonLanguages Max Binding: AllLanguages |
EpisodeOfCare.status | required | EpisodeOfCareStatus |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatus |
EpisodeOfCare.type | preferred | EpisodeOfCareType |
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRole |
Id | Path | Details | Requirements |
dom-2 | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | EpisodeOfCare.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.extension:enrolledIn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.extension:enrolledIn | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.statusHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.statusHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.statusHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.statusHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.statusHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.statusHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.statusHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.diagnosis | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.diagnosis.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.diagnosis.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.diagnosis.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | EpisodeOfCare.diagnosis.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | EpisodeOfCare.diagnosis.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.diagnosis.role | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.diagnosis.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.referralRequest | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.careManager | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.team | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.account | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |