Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services
1.0.1 - ci-build Ethiopia flag

Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/ethiopia-hiv/ and changes regularly. See the Directory of published versions

Resource Profile: Episode of Care

Official URL: http://moh.gov.et/fhir/hiv/StructureDefinition/eth-episode-of-care Version: 1.0.1
Active as of 2024-10-14 Computable Name: EthEpisodeOfCare

Records the health related activities for patients associated with HIV, TB and Cervical Cancer treatment and care services.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare EpisodeOfCare
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value 1..1 string The value that is unique
... Slices for type 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
.... type:HIV-Tracking S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
.... type:ART S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
.... type:TB S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
.... type:TPT S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
.... type:Cervical-Cancer S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
... patient 1..1 Reference(Patient) The patient who is the focus of this episode of care
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value Σ 1..1 string The value that is unique
Example General: 123456
... Slices for type Σ 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
Binding: EpisodeOfCareType (example): The type of the episode of care.


.... type:HIV-Tracking SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
.... type:ART SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
.... type:TB SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
.... type:TPT SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
.... type:Cervical-Cancer SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization Σ 1..1 Reference(Organization) Organization that assumes care
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier:EpisodeOfCareID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:HIV-TrackingexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:ARTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TBexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TPTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:Cervical-CancerexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..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 ?!Σ 0..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 Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value Σ 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 ?!Σ 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
... Slices for type Σ 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
Binding: EpisodeOfCareType (example): The type of the episode of care.


.... type:HIV-Tracking SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:ART SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:TB SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:TPT SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:Cervical-Cancer SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this episode of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition) Conditions/problems/diagnoses this episode of care is for
.... role Σ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank Σ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization Σ 1..1 Reference(Organization) Organization that assumes care
... period Σ 0..1 Period Interval during responsibility is assumed
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)
... careManager 0..1 Reference(Practitioner | PractitionerRole) Care manager/care coordinator for the patient
... team 0..* Reference(CareTeam) Other practitioners facilitating this episode of care
... account 0..* Reference(Account) The set of accounts that may be used for billing for this EpisodeOfCare

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:EpisodeOfCareID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:EpisodeOfCareID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:HIV-TrackingexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:ARTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TBexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TPTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:Cervical-CancerexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EpisodeOfCare.identifier
  • The element 1 is sliced based on the value of EpisodeOfCare.type
  • The element 1 is sliced based on the value of EpisodeOfCare.referralRequest

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare EpisodeOfCare
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value 1..1 string The value that is unique
... Slices for type 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
.... type:HIV-Tracking S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
.... type:ART S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
.... type:TB S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
.... type:TPT S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
.... type:Cervical-Cancer S 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
... patient 1..1 Reference(Patient) The patient who is the focus of this episode of care
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value Σ 1..1 string The value that is unique
Example General: 123456
... Slices for type Σ 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
Binding: EpisodeOfCareType (example): The type of the episode of care.


.... type:HIV-Tracking SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
.... type:ART SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
.... type:TB SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
.... type:TPT SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
.... type:Cervical-Cancer SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization Σ 1..1 Reference(Organization) Organization that assumes care
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.identifier:EpisodeOfCareID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:HIV-TrackingexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:ARTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TBexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TPTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:Cervical-CancerexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:EpisodeOfCareID S 0..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 ?!Σ 0..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 Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.gov.et/fhir/hiv/identifier/episode-of-care
..... value Σ 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 ?!Σ 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
... Slices for type Σ 1..* CodeableConcept Type/class - e.g. specialist referral, disease management
Slice: Unordered, Open by value:coding
Binding: EpisodeOfCareType (example): The type of the episode of care.


.... type:HIV-Tracking SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LA28577-7
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:ART SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP66375-4
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:TB SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 171126009
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:TPT SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 699618001
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... type:Cervical-Cancer SΣ 0..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 702455009
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this episode of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... condition Σ 1..1 Reference(Condition) Conditions/problems/diagnoses this episode of care is for
.... role Σ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.

.... rank Σ 0..1 positiveInt Ranking of the diagnosis (for each role type)
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization Σ 1..1 Reference(Organization) Organization that assumes care
... period Σ 0..1 Period Interval during responsibility is assumed
... Slices for referralRequest S 0..* Reference(ServiceRequest) Originating Referral Request(s)
Slice: Unordered, Open by profile:resolve()
.... referralRequest:Incoming S 0..1 Reference(Service Request - Incoming Referral Information) Originating Referral Request(s)
.... referralRequest:Outgoing S 0..1 Reference(Service Request - Request for Referral) Originating Referral Request(s)
... careManager 0..1 Reference(Practitioner | PractitionerRole) Care manager/care coordinator for the patient
... team 0..* Reference(CareTeam) Other practitioners facilitating this episode of care
... account 0..* Reference(Account) The set of accounts that may be used for billing for this EpisodeOfCare

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:EpisodeOfCareID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:EpisodeOfCareID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typeexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:HIV-TrackingexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:ARTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TBexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:TPTexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.type:Cervical-CancerexampleEpisodeOfCareType
http://hl7.org/fhir/ValueSet/episodeofcare-type
from the FHIR Standard
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EpisodeOfCare.identifier
  • The element 1 is sliced based on the value of EpisodeOfCare.type
  • The element 1 is sliced based on the value of EpisodeOfCare.referralRequest

 

Other representations of profile: CSV, Excel, Schematron