CH ORF (R4)
3.0.0-ci-build - ci-build Switzerland flag

CH ORF (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-orf/ and changes regularly. See the Directory of published versions

Resource Profile: CH ORF Episode of Care

Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-episodeofcare Version: 3.0.0-ci-build
Active as of 2024-03-27 Computable Name: ChOrfEpisodeOfCare

Copyright/Legal: CC0-1.0

Profile to document the antecedent episode of care e.g hospitalisation in case of care transfer between instituitons e.g. hospitals, rehab. clinics, retirement homes etc.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... start S0..1dateTimeStarting time with inclusive boundary
..... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... managingOrganization S0..1Reference(Organization)Organization that assumes care

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... start SΣC0..1dateTimeStarting time with inclusive boundary
..... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... patient Σ1..1Reference(Patient)The patient who is the focus of this episode of care
... managingOrganization SΣ0..1Reference(Organization)Organization that assumes care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... status ?!SΣ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory S0..*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 S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC0..1dateTimeStarting time with inclusive boundary
..... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


... diagnosis Σ0..*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(Condition)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(Patient)The patient who is the focus of this episode of care
... managingOrganization SΣ0..1Reference(Organization)Organization that assumes care
... period Σ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

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Must-Support: 7 elements

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... start S0..1dateTimeStarting time with inclusive boundary
..... end S0..1dateTimeEnd time with inclusive boundary, if not ongoing
... managingOrganization S0..1Reference(Organization)Organization that assumes care

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... start SΣC0..1dateTimeStarting time with inclusive boundary
..... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... patient Σ1..1Reference(Patient)The patient who is the focus of this episode of care
... managingOrganization SΣ0..1Reference(Organization)Organization that assumes care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareCH ORF EpisodeOfCare
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
... status ?!SΣ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory S0..*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 S1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period S1..1PeriodDuration the EpisodeOfCare was in the specified status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC0..1dateTimeStarting time with inclusive boundary
..... end SΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


... diagnosis Σ0..*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(Condition)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(Patient)The patient who is the focus of this episode of care
... managingOrganization SΣ0..1Reference(Organization)Organization that assumes care
... period Σ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

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Must-Support: 7 elements

 

Other representations of profile: CSV, Excel, Schematron