Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectEpisodeOfCare1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1 Version: 0.1.0
Draft as of 2019-03-04 Computable Name: CareConnect-EpisodeOfCare-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

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.

[NOT CURATED BY INTEROPEN see: http://www.interopen.org/careconnect-curation-methodology/] Initial development for the Digital Maternity programme

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 0..*EpisodeOfCareAn association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... identifier
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... diagnosis
.... condition 1..1Reference(CareConnect-Condition-1)Conditions/problems/diagnoses this episode of care is for
... patient 1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(CareConnect-Practitioner-1)Care manager/care co-ordinator for the patient
... team 0..*Reference(CareConnect-CareTeam-1)Other practitioners facilitating this episode of care

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that assumes care
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(CareConnect-Practitioner-1)Care manager/care co-ordinator for the patient
... team 0..*Reference(CareConnect-CareTeam-1)Other practitioners facilitating this episode of care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.statusrequiredEpisodeOfCareStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory 0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care


... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this episode of care
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... condition Σ1..1Reference(CareConnect-Condition-1)Conditions/problems/diagnoses this episode of care is for
.... role Σ0..1CodeableConceptRole 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..1positiveIntRanking of the diagnosis (for each role type)
... patient Σ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that assumes care
... period Σ0..1PeriodInterval during responsibility is assumed
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typeexampleEpisodeOfCareType
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
... identifier
.... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... diagnosis
.... condition 1..1Reference(CareConnect-Condition-1)Conditions/problems/diagnoses this episode of care is for
... patient 1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(CareConnect-Practitioner-1)Care manager/care co-ordinator for the patient
... team 0..*Reference(CareConnect-CareTeam-1)Other practitioners facilitating this episode of care

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that assumes care
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(CareConnect-Practitioner-1)Care manager/care co-ordinator for the patient
... team 0..*Reference(CareConnect-CareTeam-1)Other practitioners facilitating this episode of care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.statusrequiredEpisodeOfCareStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*EpisodeOfCareAn 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

... statusHistory 0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type Σ0..*CodeableConceptType/class - e.g. specialist referral, disease management
Binding: EpisodeOfCareType (example): The type of the episode of care


... diagnosis Σ0..*BackboneElementThe list of diagnosis relevant to this episode of care
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... condition Σ1..1Reference(CareConnect-Condition-1)Conditions/problems/diagnoses this episode of care is for
.... role Σ0..1CodeableConceptRole 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..1positiveIntRanking of the diagnosis (for each role type)
... patient Σ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that assumes care
... period Σ0..1PeriodInterval during responsibility is assumed
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)Originating Referral Request(s)
... careManager 0..1Reference(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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typeexampleEpisodeOfCareType
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())

 

Other representations of profile: CSV, Excel, Schematron