SMART Base Clinical
1.0.0 - ci-build
SMART Base Clinical, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base-clinical/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/base-clinical/StructureDefinition/sg-episodeofcare | Version: 1.0.0 | |||
Draft as of 2024-12-02 | Computable Name: SGEpisodeOfCare |
The WHO SMART Guidelines EpisodeOfCare profile defines conformance requirements and exchange expectations for EpisodeOfCare resources in WHO Smart Guidelines content. EpisodeOfCare resources are used to track enrollment of a patient in a specific guideline for a specific period of time, referred to as a Case in the Clinical Practice Guidelines implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGCase
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | S | 0..* | CPGCase | 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 |
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
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 |
diagnosis | S | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
condition | S | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for |
role | S | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | S | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care |
managingOrganization | S | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care |
period | S | 0..1 | Period | Interval during responsibility is assumed |
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient |
team | S | 0..* | Reference(WHO SMART Guidelines CareTeam) | Other practitioners facilitating this episode of care |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | S | 0..* | CPGCase | 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 |
Slices for extension | Content/Rules for all slices | |||
enrolledIn | S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
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 (preferred): Expresses the type of an episode of care |
diagnosis | SΣ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for |
role | SΣ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) |
rank | SΣ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care |
managingOrganization | SΣ | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care |
period | SΣ | 0..1 | Period | Interval during responsibility is assumed |
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient |
team | S | 0..* | Reference(WHO SMART Guidelines CareTeam) | Other practitioners facilitating this episode of care |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | |
EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | |
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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 | 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 | S | 0..* | CPGCase | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
enrolledIn | S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
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 (preferred): Expresses the type of an episode of care | ||||
diagnosis | SΣ | 1..* | 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 | SΣ | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
role | SΣ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) | ||||
rank | SΣ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care | ||||
managingOrganization | SΣ | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care | ||||
period | SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient | ||||
team | S | 0..* | Reference(WHO SMART Guidelines 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 | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
EpisodeOfCare.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | ||||
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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 | 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 CPGCase
Summary
Mandatory: 4 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CPGCase
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | S | 0..* | CPGCase | 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 |
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
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 |
diagnosis | S | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
condition | S | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for |
role | S | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | S | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care |
managingOrganization | S | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care |
period | S | 0..1 | Period | Interval during responsibility is assumed |
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient |
team | S | 0..* | Reference(WHO SMART Guidelines CareTeam) | Other practitioners facilitating this episode of care |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | S | 0..* | CPGCase | 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 |
Slices for extension | Content/Rules for all slices | |||
enrolledIn | S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
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 (preferred): Expresses the type of an episode of care |
diagnosis | SΣ | 1..* | BackboneElement | The list of diagnosis relevant to this episode of care |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for |
role | SΣ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) |
rank | SΣ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care |
managingOrganization | SΣ | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care |
period | SΣ | 0..1 | Period | Interval during responsibility is assumed |
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient |
team | S | 0..* | Reference(WHO SMART Guidelines CareTeam) | Other practitioners facilitating this episode of care |
Documentation for this format |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | |
EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | |
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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 | 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 | S | 0..* | CPGCase | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
enrolledIn | S | 0..* | canonical() | CPG Enrolled In Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-enrolledIn | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
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 (preferred): Expresses the type of an episode of care | ||||
diagnosis | SΣ | 1..* | 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 | SΣ | 1..1 | Reference(WHO SMART Guidelines Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
role | SΣ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (extensible) | ||||
rank | SΣ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | The patient who is the focus of this episode of care | ||||
managingOrganization | SΣ | 0..1 | Reference(WHO SMART Guidelines Organization) | Organization that assumes care | ||||
period | SΣ | 0..1 | Period | Interval during responsibility is assumed | ||||
referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
careManager | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Care manager/care coordinator for the patient | ||||
team | S | 0..* | Reference(WHO SMART Guidelines 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 | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
EpisodeOfCare.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type | preferred | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | ||||
EpisodeOfCare.diagnosis.role | extensible | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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 | 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 CPGCase
Summary
Mandatory: 4 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron