Estonian Base Implementation Guide
1.1.1 - trial-use
Estonian Base Implementation Guide, published by HL7 Estonia. This guide is not an authorized publication; it is the continuous build for version 1.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7EE/ig-ee-base/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.ee/base/StructureDefinition/ee-episode-of-care | Version: 1.1.1 | |||
Draft as of 2024-08-28 | Computable Name: EEBaseEpisodeOfCare |
An association between a patient and an organization/healthcare provider(s) over a period of time. The managing organization assumes a level of responsibility for the patient during this time. EpisodeOfCare acts as a container resource that links a series of Encounters together for problems/issues (specific condition).
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 | |||
identifier | S | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
status | S | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error |
type | S | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management |
reason | ||||
value | 0..* | CodeableReference(Condition | Procedure | EEBase Observation | EEBase HealthcareService) | Medical reason to be addressed | |
patient | S | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care |
managingOrganization | S | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination |
period | S | 0..1 | Period | Interval during responsibility is assumed |
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |
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 | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 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. |
type | SΣ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. |
patient | SΣ | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care |
managingOrganization | SΣ | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination |
period | SΣ | 0..1 | Period | Interval during responsibility is assumed |
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: AllLanguages (required): IETF language tag for a human language
| |||||
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 | S | 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 | 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 | SΣ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the 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 | ||||
use | Σ | 0..1 | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
value | Σ | 0..* | CodeableReference(Condition | Procedure | EEBase Observation | EEBase HealthcareService) | Medical reason to be addressed Binding: EncounterReasonCodes (example) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of medical conditions that were addressed during the 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 | Σ | 0..* | CodeableReference(Condition) | The medical condition that was addressed during the episode of care Binding: ConditionProblemDiagnosisCodes (example) | ||||
use | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | ||||
patient | SΣ | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care | ||||
managingOrganization | SΣ | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination | ||||
period | SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |||||
careTeam | 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 | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | |
EpisodeOfCare.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard | |
EpisodeOfCare.reason.value | example | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
EpisodeOfCare.diagnosis.condition | example | ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
EpisodeOfCare.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use from 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from EpisodeOfCare
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | EpisodeOfCare | |||
identifier | S | 0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
status | S | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error |
type | S | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management |
reason | ||||
value | 0..* | CodeableReference(Condition | Procedure | EEBase Observation | EEBase HealthcareService) | Medical reason to be addressed | |
patient | S | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care |
managingOrganization | S | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination |
period | S | 0..1 | Period | Interval during responsibility is assumed |
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |
Documentation for this format |
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 |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 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. |
type | SΣ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. |
patient | SΣ | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care |
managingOrganization | SΣ | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination |
period | SΣ | 0..1 | Period | Interval during responsibility is assumed |
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: AllLanguages (required): IETF language tag for a human language
| |||||
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 | S | 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 | 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 | SΣ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the 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 | ||||
use | Σ | 0..1 | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
value | Σ | 0..* | CodeableReference(Condition | Procedure | EEBase Observation | EEBase HealthcareService) | Medical reason to be addressed Binding: EncounterReasonCodes (example) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of medical conditions that were addressed during the 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 | Σ | 0..* | CodeableReference(Condition) | The medical condition that was addressed during the episode of care Binding: ConditionProblemDiagnosisCodes (example) | ||||
use | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | ||||
patient | SΣ | 1..1 | Reference(EEBase Patient) | The patient who is the focus of this episode of care | ||||
managingOrganization | SΣ | 0..1 | Reference(EEBase Organization) | Organization that assumes responsibility for care coordination | ||||
period | SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
careManager | 0..1 | Reference(EEBase Practitioner | EEBase PractitionerRole) | Care manager/care coordinator for the patient | |||||
careTeam | 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 | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|5.0.0 from the FHIR Standard | |
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | |
EpisodeOfCare.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard | |
EpisodeOfCare.reason.value | example | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
EpisodeOfCare.diagnosis.condition | example | ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
EpisodeOfCare.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use from 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron