SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-episodeofcare | Version: 0.1.0 | |||
| Active as of 2025-11-25 | Computable Name: HIEEpisodeOfCare | |||
EpisodeOfCare is the representation of EpisodeOfCare FHIR resource to be used with national HIE
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |
![]() ![]() |
Σ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care |
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient |
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
![]() ![]() |
1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) | |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() |
1..1 | Reference(Organization) | Organization that assumes care | |
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient |
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
![]() ![]() |
Σ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | ||||
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | ||||
![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | EpisodeOfCare.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |
![]() ![]() |
Σ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) |
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care |
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care |
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient |
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
![]() ![]() |
1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) | |
![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
![]() ![]() |
1..1 | Reference(Organization) | Organization that assumes care | |
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient |
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() |
S | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
![]() ![]() ![]() |
1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
![]() ![]() |
Σ | 1..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: Episode of Care Service Types (required) | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() |
S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | ||||
![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | ||||
![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() |
S | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| EpisodeOfCare.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.statusHistory.status | Base | required | EpisodeOfCareStatus | 📍4.3.0 | FHIR Std. |
| EpisodeOfCare.type | Base | required | Episode of Care Service Types | 📦0.1.0 | This IG |
| EpisodeOfCare.diagnosis.role | Base | preferred | DiagnosisRole | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | EpisodeOfCare.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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
Other representations of profile: CSV, Excel, Schematron