FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-case

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

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:

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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 S0..*canonical()Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... type 0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care

... diagnosis 1..*BackboneElementThe list of diagnosis relevant to this episode of care
.... condition 1..1Reference(CPGCondition)Conditions/problems/diagnoses this episode of care is for
... patient 1..1Reference(CPGPatient)The patient who is the focus of this episode of care
... period S0..1PeriodInterval during responsibility is assumed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-enrolledIn S0..*canonical()Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory 0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis Σ1..*BackboneElementThe list of diagnosis relevant to this episode of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(CPGCondition)Conditions/problems/diagnoses this episode of care is for
.... role Σ0..1CodeableConceptRole 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..1positiveIntRanking of the diagnosis (for each role type)
... patient Σ1..1Reference(CPGPatient)The patient who is the focus of this episode of care
... managingOrganization Σ0..1Reference(Organization)Organization that assumes care
... period SΣ0..1PeriodInterval during responsibility is assumed
... referralRequest 0..*Reference(ServiceRequest)Originating Referral Request(s)
... careManager 0..1Reference(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

doco 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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 S0..*canonical()Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... type 0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care

... diagnosis 1..*BackboneElementThe list of diagnosis relevant to this episode of care
.... condition 1..1Reference(CPGCondition)Conditions/problems/diagnoses this episode of care is for
... patient 1..1Reference(CPGPatient)The patient who is the focus of this episode of care
... period S0..1PeriodInterval during responsibility is assumed

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-enrolledIn S0..*canonical()Which pathway
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory 0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (preferred): Expresses the type of an episode of care


... diagnosis Σ1..*BackboneElementThe list of diagnosis relevant to this episode of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition Σ1..1Reference(CPGCondition)Conditions/problems/diagnoses this episode of care is for
.... role Σ0..1CodeableConceptRole 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..1positiveIntRanking of the diagnosis (for each role type)
... patient Σ1..1Reference(CPGPatient)The patient who is the focus of this episode of care
... managingOrganization Σ0..1Reference(Organization)Organization that assumes care
... period SΣ0..1PeriodInterval during responsibility is assumed
... referralRequest 0..*Reference(ServiceRequest)Originating Referral Request(s)
... careManager 0..1Reference(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

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.languagepreferredCommonLanguages
Max Binding: AllLanguages
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typepreferredEpisodeOfCareType
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2EpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3EpisodeOfCareIf 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-4EpisodeOfCareIf 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-5EpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6EpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1EpisodeOfCare.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.extension:enrolledInAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.extension:enrolledInMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.statusHistoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.statusHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.statusHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.statusHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.statusHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.statusHistory.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.statusHistory.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.diagnosisAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.diagnosis.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.diagnosis.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.diagnosis.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1EpisodeOfCare.diagnosis.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1EpisodeOfCare.diagnosis.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.diagnosis.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.diagnosis.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.referralRequestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.careManagerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.teamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1EpisodeOfCare.accountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())