HL7 PT FHIR Implementation Guide: Community Health, published by HL7 Portugal. 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/AnaCeciliaCoimbra/community-health-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Episode Of Care

Este perfil representa um período estruturado durante o qual um paciente recebe atendimento para um problema de saúde específico ou um conjunto de condições. Ele serve como base para organizar e vincular atividades de saúde relacionadas, como sintomas, problemas, observações e planos de cuidado.

Usage:

• Refer to this Resource Profile: Encounter - Iteraction with the artificial intelligence algorithm, Encounter - Finish Interaction, Encounter - Follow-Up Interaction and Encounter - Validation Iteraction
• Examples for this Resource Profile: EpisodeOfCare/exemplo-episodeofcare-episodio-activo, EpisodeOfCare/exemplo-episodeofcare-episodio-em-espera and EpisodeOfCare/exemplo-episodeofcare-episodio-finalizado

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare			EpisodeOfCare
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required)
managingOrganization		1..1	Reference(Organization)	Organization that assumes care Required Pattern: At least the following
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
careManager		0..1	Reference(Practitioner)	Care manager/care coordinator for the patient
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	EpisodeOfCare	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	The patient who is the focus of this episode of care ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
careManager		0..1	Reference(Practitioner)	Care manager/care coordinator for the patient ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG

Constraints

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		0..*	EpisodeOfCare	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required)
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	Σ	0..*	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
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 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
type		0..1	uri	Type the reference refers to (e.g. "Patient")
identifier		0..1	Identifier	Logical reference, when literal reference is not known
display		0..1	string	Text alternative for the resource
period	Σ	0..1	Period	Interval during responsibility is assumed
referralRequest		0..*	Reference(ServiceRequest)	Originating Referral Request(s)
careManager		0..1	Reference(Practitioner)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard

Constraints

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 EpisodeOfCare

Summary

Mandatory: 1 element

Differential View

This structure is derived from EpisodeOfCare

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare			EpisodeOfCare
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required)
managingOrganization		1..1	Reference(Organization)	Organization that assumes care Required Pattern: At least the following
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
careManager		0..1	Reference(Practitioner)	Care manager/care coordinator for the patient
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	EpisodeOfCare	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	The patient who is the focus of this episode of care ele-1: All FHIR elements must have a @value or children
managingOrganization	Σ	1..1	Reference(Organization)	Organization that assumes care ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
careManager		0..1	Reference(Practitioner)	Care manager/care coordinator for the patient ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG

Constraints

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		0..*	EpisodeOfCare	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
status	?!Σ	1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: Subset of Episode Of Care Status (required)
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	Σ	0..*	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care.
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 Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
reference		1..1	string	Literal reference, Relative, internal or absolute URL Fixed Value: Organization/P5Organization
type		0..1	uri	Type the reference refers to (e.g. "Patient")
identifier		0..1	Identifier	Logical reference, when literal reference is not known
display		0..1	string	Text alternative for the resource
period	Σ	0..1	Period	Interval during responsibility is assumed
referralRequest		0..*	Reference(ServiceRequest)	Originating Referral Request(s)
careManager		0..1	Reference(Practitioner)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
EpisodeOfCare.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.status	required	EpisodeOfCareStatusSubset https://hl7.pt/fhir/community-health/ValueSet/episode-of-care-status-subset from this IG
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard
EpisodeOfCare.type	example	EpisodeOfCareType http://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard

Constraints

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 EpisodeOfCare

Summary

Mandatory: 1 element

Other representations of profile: CSV, Excel, Schematron