This page is part of the FUT Infrastructure (v3.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Active as of 2024-11-05 |
Definitions for the ehealth-episodeofcare resource profile.
Guidance on how to interpret the contents of this table can be found here
0. EpisodeOfCare | |
2. EpisodeOfCare.extension | |
Control | 1..? |
Slicing | This element introduces a set of slices on EpisodeOfCare.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. EpisodeOfCare.extension:caremanagerOrganization | |
Slice Name | caremanagerOrganization |
Control | 1..1 |
Type | Extension(Caremanager organization) (Extension Type: Reference(ehealth-organization)referenced) |
6. EpisodeOfCare.extension:teamHistory | |
Slice Name | teamHistory |
Control | 0..* |
Type | Extension(Team history) (Complex Extension) |
8. EpisodeOfCare.extension:episodeofcareStatusschedule | |
Slice Name | episodeofcareStatusschedule |
Control | 0..* |
Type | Extension(Status schedule) (Complex Extension) |
10. EpisodeOfCare.extension:teamschedule | |
Slice Name | teamschedule |
Control | 0..* |
Type | Extension(Team schedule) (Complex Extension) |
12. EpisodeOfCare.extension:participant | |
Slice Name | participant |
Control | 0..* |
Type | Extension(Participant) (Complex Extension) |
14. EpisodeOfCare.diagnosis | |
Control | 1..? |
16. EpisodeOfCare.diagnosis.condition | |
Type | Reference(ehealth-condition)referenced |
18. EpisodeOfCare.patient | |
Type | Reference(ehealth-patient)referenced |
20. EpisodeOfCare.managingOrganization | |
Control | 1..? |
Type | Reference(ehealth-organization)referenced |
22. EpisodeOfCare.period | |
Control | 1..? |
24. EpisodeOfCare.careManager | |
Control | 0..0 |
26. EpisodeOfCare.team | |
Type | Reference(ehealth-careteam)referenced |
28. EpisodeOfCare.account | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. EpisodeOfCare | |
Definition | An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. |
Short | 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 |
Control | 0..* |
Is Modifier | false |
Summary | false |
Alternate Names | Case Program Problem |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. EpisodeOfCare.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. EpisodeOfCare.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on EpisodeOfCare.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. EpisodeOfCare.extension:caremanagerOrganization | |
Slice Name | caremanagerOrganization |
Definition | Reference to caremanagers organization |
Short | Reference to caremanagers organization |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Caremanager organization) (Extension Type: Reference(ehealth-organization)referenced) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. EpisodeOfCare.extension:teamHistory | |
Slice Name | teamHistory |
Definition | History of assigned careTeam |
Short | History of assigned careTeam |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Team history) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
10. EpisodeOfCare.extension:episodeofcareStatusschedule | |
Slice Name | episodeofcareStatusschedule |
Definition | Scheduled status change |
Short | Status Schedule |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Status schedule) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
12. EpisodeOfCare.extension:teamschedule | |
Slice Name | teamschedule |
Definition | Scheduled team change |
Short | Team Schedule |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Team schedule) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
14. EpisodeOfCare.extension:participant | |
Slice Name | participant |
Definition | The participating CareTeam or Practitioner. |
Short | Who or what is participating |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Participant) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. EpisodeOfCare.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
18. EpisodeOfCare.status | |
Definition | planned | waitlist | active | onhold | finished | cancelled. |
Short | planned | waitlist | active | onhold | finished | cancelled | entered-in-error |
Comments | This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 )The status of the episode of care. |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. EpisodeOfCare.diagnosis | |
Definition | The list of diagnosis relevant to this episode of care. |
Short | The list of diagnosis relevant to this episode of care |
Control | 10..* |
Type | BackboneElement |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. EpisodeOfCare.diagnosis.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
24. EpisodeOfCare.diagnosis.condition | |
Definition | A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for. |
Short | Conditions/problems/diagnoses this episode of care is for |
Control | 1..1 |
Type | Reference(ehealth-condition, Condition)referenced |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. EpisodeOfCare.patient | |
Definition | The patient who is the focus of this episode of care. |
Short | The patient who is the focus of this episode of care |
Control | 1..1 |
Type | Reference(ehealth-patient, Patient)referenced |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. EpisodeOfCare.managingOrganization | |
Definition | The organization that has assumed the specific responsibilities for the specified duration. |
Short | Organization that assumes care |
Control | 10..1 |
Type | Reference(ehealth-organization, Organization)referenced |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. EpisodeOfCare.period | |
Definition | The interval during which the managing organization assumes the defined responsibility. |
Short | Interval during responsibility is assumed |
Control | 10..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. EpisodeOfCare.careManager | |
Definition | The practitioner that is the care manager/care coordinator for this patient. |
Short | Care manager/care coordinator for the patient |
Control | 0..01 |
Type | Reference(Practitioner, PractitionerRole) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. EpisodeOfCare.team | |
Definition | The list of practitioners that may be facilitating this episode of care for specific purposes. |
Short | Other practitioners facilitating this episode of care |
Control | 0..* |
Type | Reference(ehealth-careteam, CareTeam)referenced |
Is Modifier | false |
Summary | false |
Alternate Names | CareTeam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. EpisodeOfCare.account | |
Definition | The set of accounts that may be used for billing for this EpisodeOfCare. |
Short | The set of accounts that may be used for billing for this EpisodeOfCare |
Comments | The billing system may choose to allocate billable items associated with the EpisodeOfCare to different referenced Accounts based on internal business rules. |
Control | 0..0* |
Type | Reference(Account) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. EpisodeOfCare | |||||
Definition | An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time. | ||||
Short | 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 | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | Case Program Problem | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )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 ( 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. EpisodeOfCare.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. EpisodeOfCare.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. EpisodeOfCare.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. EpisodeOfCare.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. EpisodeOfCare.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. EpisodeOfCare.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. EpisodeOfCare.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 1..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on EpisodeOfCare.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
16. EpisodeOfCare.extension:caremanagerOrganization | |||||
Slice Name | caremanagerOrganization | ||||
Definition | Reference to caremanagers organization | ||||
Short | Reference to caremanagers organization | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Caremanager organization) (Extension Type: Reference(ehealth-organization)referenced) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. EpisodeOfCare.extension:teamHistory | |||||
Slice Name | teamHistory | ||||
Definition | History of assigned careTeam | ||||
Short | History of assigned careTeam | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Team history) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
20. EpisodeOfCare.extension:episodeofcareStatusschedule | |||||
Slice Name | episodeofcareStatusschedule | ||||
Definition | Scheduled status change | ||||
Short | Status Schedule | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Status schedule) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
22. EpisodeOfCare.extension:teamschedule | |||||
Slice Name | teamschedule | ||||
Definition | Scheduled team change | ||||
Short | Team Schedule | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Team schedule) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
24. EpisodeOfCare.extension:participant | |||||
Slice Name | participant | ||||
Definition | The participating CareTeam or Practitioner. | ||||
Short | Who or what is participating | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Participant) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
26. EpisodeOfCare.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
28. EpisodeOfCare.identifier | |||||
Definition | The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. | ||||
Short | Business Identifier(s) relevant for this EpisodeOfCare | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. EpisodeOfCare.status | |||||
Definition | planned | waitlist | active | onhold | finished | cancelled. | ||||
Short | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EpisodeOfCareStatus (required to http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 )The status of the episode of care. | ||||
Type | code | ||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. EpisodeOfCare.statusHistory | |||||
Definition | The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource). | ||||
Short | Past list of status codes (the current status may be included to cover the start date of the status) | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. EpisodeOfCare.statusHistory.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
36. EpisodeOfCare.statusHistory.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
38. EpisodeOfCare.statusHistory.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
40. EpisodeOfCare.statusHistory.status | |||||
Definition | planned | waitlist | active | onhold | finished | cancelled. | ||||
Short | planned | waitlist | active | onhold | finished | cancelled | entered-in-error | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EpisodeOfCareStatus (required to http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 )The status of the episode of care. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. EpisodeOfCare.statusHistory.period | |||||
Definition | The period during this EpisodeOfCare that the specific status applied. | ||||
Short | Duration the EpisodeOfCare was in the specified status | ||||
Control | 1..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. EpisodeOfCare.type | |||||
Definition | A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care. | ||||
Short | Type/class - e.g. specialist referral, disease management | ||||
Comments | The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications. | ||||
Control | 0..* | ||||
Binding | For example codes, see EpisodeOfCareType (example to http://hl7.org/fhir/ValueSet/episodeofcare-type )The type of the episode of care. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. EpisodeOfCare.diagnosis | |||||
Definition | The list of diagnosis relevant to this episode of care. | ||||
Short | The list of diagnosis relevant to this episode of care | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. EpisodeOfCare.diagnosis.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
50. EpisodeOfCare.diagnosis.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
52. EpisodeOfCare.diagnosis.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
54. EpisodeOfCare.diagnosis.condition | |||||
Definition | A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for. | ||||
Short | Conditions/problems/diagnoses this episode of care is for | ||||
Control | 1..1 | ||||
Type | Reference(ehealth-condition)referenced | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. EpisodeOfCare.diagnosis.role | |||||
Definition | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …). | ||||
Short | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from DiagnosisRole (preferred to http://hl7.org/fhir/ValueSet/diagnosis-role )The type of diagnosis this condition represents. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. EpisodeOfCare.diagnosis.rank | |||||
Definition | Ranking of the diagnosis (for each role type). | ||||
Short | Ranking of the diagnosis (for each role type) | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. EpisodeOfCare.patient | |||||
Definition | The patient who is the focus of this episode of care. | ||||
Short | The patient who is the focus of this episode of care | ||||
Control | 1..1 | ||||
Type | Reference(ehealth-patient)referenced | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. EpisodeOfCare.managingOrganization | |||||
Definition | The organization that has assumed the specific responsibilities for the specified duration. | ||||
Short | Organization that assumes care | ||||
Control | 1..1 | ||||
Type | Reference(ehealth-organization)referenced | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. EpisodeOfCare.period | |||||
Definition | The interval during which the managing organization assumes the defined responsibility. | ||||
Short | Interval during responsibility is assumed | ||||
Control | 1..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. EpisodeOfCare.referralRequest | |||||
Definition | Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals. | ||||
Short | Originating Referral Request(s) | ||||
Control | 0..* | ||||
Type | Reference(ServiceRequest) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. EpisodeOfCare.careManager | |||||
Definition | The practitioner that is the care manager/care coordinator for this patient. | ||||
Short | Care manager/care coordinator for the patient | ||||
Control | 0..0 | ||||
Type | Reference(Practitioner, PractitionerRole) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. EpisodeOfCare.team | |||||
Definition | The list of practitioners that may be facilitating this episode of care for specific purposes. | ||||
Short | Other practitioners facilitating this episode of care | ||||
Control | 0..* | ||||
Type | Reference(ehealth-careteam)referenced | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | CareTeam | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. EpisodeOfCare.account | |||||
Definition | The set of accounts that may be used for billing for this EpisodeOfCare. | ||||
Short | The set of accounts that may be used for billing for this EpisodeOfCare | ||||
Comments | The billing system may choose to allocate billable items associated with the EpisodeOfCare to different referenced Accounts based on internal business rules. | ||||
Control | 0..0 | ||||
Type | Reference(Account) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |