IDEA4RC FHIR Implementation Guide, published by IDEA4RC Project. 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/hl7-eu/idea4rc/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/episodeOfCare-eu-i4rc | Version: 0.1.0 | |||
Draft as of 2025-01-13 | Computable Name: EpisodeOfCareI4rc |
This profile defines how to represent the Hospital Patient Records model in FHIR for the purpose of the IDEA4RC project.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Same custodian flag URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/same-custodian-flag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the EpisodeOfCare Binding: EpisodeOfCareStatus (required): The status of the episode of care. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient: IDEA4RC) | The patient who is the focus of this episode of care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Hospital Name ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard |
This structure is derived from EpisodeOfCare
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Same custodian flag URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/same-custodian-flag | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the EpisodeOfCare Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
![]() ![]() ![]() |
Σ | 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: Primary Cancer) | 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: IDEA4RC) | The patient who is the focus of this episode of care | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Hospital Name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | dateTime | First Contact Date | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
EpisodeOfCare.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | ||||
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
EpisodeOfCare.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 2 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Same custodian flag URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/same-custodian-flag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the EpisodeOfCare Binding: EpisodeOfCareStatus (required): The status of the episode of care. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient: IDEA4RC) | The patient who is the focus of this episode of care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Hospital Name ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard |
Differential View
This structure is derived from EpisodeOfCare
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Same custodian flag URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/same-custodian-flag | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the EpisodeOfCare Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
![]() ![]() ![]() |
Σ | 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: Primary Cancer) | 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: IDEA4RC) | The patient who is the focus of this episode of care | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Hospital Name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | dateTime | First Contact Date | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
EpisodeOfCare.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1 from the FHIR Standard | ||||
EpisodeOfCare.type | example | EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type from the FHIR Standard | ||||
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
EpisodeOfCare.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
This structure is derived from EpisodeOfCare
Summary
Mandatory: 2 elements(1 nested mandatory element)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron