CH ORF (R4)
4.0.0-ballot-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 4.0.0-ballot-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: 4.0.0-ballot-ci-build
Active as of 2024-12-18 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..* EpisodeOfCare CH ORF EpisodeOfCare
... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
... statusHistory S 0..* BackboneElement Past list of status codes (the current status may be included to cover the start date of the status)
.... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... managingOrganization S 0..1 Reference(Organization) Organization that assumes care

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare CH ORF EpisodeOfCare
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.


ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.


ele-1: All FHIR elements must have a @value or children
.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
ele-1: All FHIR elements must have a @value or children
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Organization) Organization that assumes care
ele-1: All FHIR elements must have a @value or children

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..* EpisodeOfCare CH ORF EpisodeOfCare
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

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

.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... type Σ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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..* EpisodeOfCare CH ORF EpisodeOfCare
... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
... statusHistory S 0..* BackboneElement Past list of status codes (the current status may be included to cover the start date of the status)
.... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... managingOrganization S 0..1 Reference(Organization) Organization that assumes care

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare CH ORF EpisodeOfCare
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.


ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... status S 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.


ele-1: All FHIR elements must have a @value or children
.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
ele-1: All FHIR elements must have a @value or children
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Organization) Organization that assumes care
ele-1: All FHIR elements must have a @value or children

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..* EpisodeOfCare CH ORF EpisodeOfCare
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
... status ?!SΣ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

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

.... period S 1..1 Period Duration the EpisodeOfCare was in the specified status
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... type Σ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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