INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
Summary
Structures
This structure refers to these other structures:
This structure is derived from EpisodeOfCare
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | I | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 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 | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..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(CareConnect-Organization-1) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required) |
statusHistory | I | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required) | |
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) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | Σ | 1..1 | Reference(CareConnect-Condition-1) | 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) |
rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | Σ | 1..1 | Reference(CareConnect-Patient-1) | The patient who is the focus of this episode of care |
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that assumes care |
period | Σ | 0..1 | Period | Interval during responsibility is assumed |
referralRequest | 0..* | Reference(CareConnect-ReferralRequest-1) | Originating Referral Request(s) | |
careManager | 0..1 | Reference(CareConnect-Practitioner-1) | Care manager/care co-ordinator for the patient | |
team | 0..* | Reference(CareConnect-CareTeam-1) | 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 |
This structure is derived from EpisodeOfCare
Summary
Structures
This structure refers to these other structures:
Differential View
This structure is derived from EpisodeOfCare
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EpisodeOfCare | I | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 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 | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..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(CareConnect-Organization-1) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required) |
statusHistory | I | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required) | |
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) |
diagnosis | ΣI | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
condition | Σ | 1..1 | Reference(CareConnect-Condition-1) | 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) |
rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
patient | Σ | 1..1 | Reference(CareConnect-Patient-1) | The patient who is the focus of this episode of care |
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that assumes care |
period | Σ | 0..1 | Period | Interval during responsibility is assumed |
referralRequest | 0..* | Reference(CareConnect-ReferralRequest-1) | Originating Referral Request(s) | |
careManager | 0..1 | Reference(CareConnect-Practitioner-1) | Care manager/care co-ordinator for the patient | |
team | 0..* | Reference(CareConnect-CareTeam-1) | 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 |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
EpisodeOfCare.language | extensible | Common Languages Max Binding: All Languages |
EpisodeOfCare.identifier.use | required | IdentifierUse |
EpisodeOfCare.identifier.type | extensible | Identifier Type Codes |
EpisodeOfCare.status | required | EpisodeOfCareStatus |
EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatus |
EpisodeOfCare.type | example | EpisodeOfCareType |
EpisodeOfCare.diagnosis.role | preferred | DiagnosisRole |
Id | Path | Details | Requirements |
dom-2 | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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-3 | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | EpisodeOfCare.statusHistory | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | EpisodeOfCare.diagnosis | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |