UK Core Implementation Guide 0.2.0 - STU1

StructureDefinition-UKCore-EpisodeOfCare

Defines the UK Core constraints and extensions on the EpisodeOfCare resource for the minimal set of data to query and retrieve episode of care information.

Profile Purpose

This profile allows exchange of information about an association between a patient and an organisation / healthcare provider(s) during which time encounters may occur. The managing organisation assumes a level of responsibility for the individual during this time.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
status1..1codeBinding
periodI1..1Period
typeΣ0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
roleΣ0..1CodeableConceptBinding
rankΣ0..1positiveInt
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
status1..1codeBinding
periodI1..1Period
typeΣ0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
roleΣ0..1CodeableConceptBinding
rankΣ0..1positiveInt
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
status1..1codeBinding
periodI1..1Period
typeΣ0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
roleΣ0..1CodeableConceptBinding
rankΣ0..1positiveInt
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodΣ I0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Table View

EpisodeOfCare..
EpisodeOfCare.identifier..
EpisodeOfCare.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.diagnosis..
EpisodeOfCare.diagnosis.conditionReference(UK Core Condition)..
EpisodeOfCare.diagnosis.condition.identifier..
EpisodeOfCare.diagnosis.condition.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.patientReference(UK Core Patient)..
EpisodeOfCare.patient.identifier..
EpisodeOfCare.patient.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.managingOrganizationReference(UK Core Organization)..
EpisodeOfCare.managingOrganization.identifier..
EpisodeOfCare.managingOrganization.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.referralRequestReference(UK Core ServiceRequest)..
EpisodeOfCare.referralRequest.identifier..
EpisodeOfCare.referralRequest.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.careManagerReference(UK Core Practitioner | UK Core PractitionerRole)..
EpisodeOfCare.careManager.identifier..
EpisodeOfCare.careManager.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.teamReference(UK Core CareTeam)..
EpisodeOfCare.team.identifier..
EpisodeOfCare.team.identifier.assignerReference(UK Core Organization)..
EpisodeOfCare.account..
EpisodeOfCare.account.identifier..
EpisodeOfCare.account.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-EpisodeOfCare" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare" />
    <version value="2.1.0" />
    <name value="UKCoreEpisodeOfCare" />
    <title value="UK Core EpisodeOfCare" />
    <status value="active" />
    <date value="2022-01-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the EpisodeOfCare resource for the minimal set of data to query and retrieve episode of care information." />
    <purpose value="This profile allows exchange of information about an association between a patient and an organisation / healthcare provider(s) during which time encounters may occur. The managing organisation assumes a level of responsibility for the individual during this time." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="EpisodeOfCare" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" />
    <derivation value="constraint" />
    <differential>
        <element id="EpisodeOfCare.identifier.assigner">
            <path value="EpisodeOfCare.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.diagnosis.condition">
            <path value="EpisodeOfCare.diagnosis.condition" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
            </type>
        </element>
        <element id="EpisodeOfCare.diagnosis.condition.identifier.assigner">
            <path value="EpisodeOfCare.diagnosis.condition.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.patient">
            <path value="EpisodeOfCare.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="EpisodeOfCare.patient.identifier.assigner">
            <path value="EpisodeOfCare.patient.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.managingOrganization">
            <path value="EpisodeOfCare.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.managingOrganization.identifier.assigner">
            <path value="EpisodeOfCare.managingOrganization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.referralRequest">
            <path value="EpisodeOfCare.referralRequest" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest" />
            </type>
        </element>
        <element id="EpisodeOfCare.referralRequest.identifier.assigner">
            <path value="EpisodeOfCare.referralRequest.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.careManager">
            <path value="EpisodeOfCare.careManager" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="EpisodeOfCare.careManager.identifier.assigner">
            <path value="EpisodeOfCare.careManager.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.team">
            <path value="EpisodeOfCare.team" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam" />
            </type>
        </element>
        <element id="EpisodeOfCare.team.identifier.assigner">
            <path value="EpisodeOfCare.team.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="EpisodeOfCare.account.identifier.assigner">
            <path value="EpisodeOfCare.account.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-EpisodeOfCare",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare",
    "version": "2.1.0",
    "name": "UKCoreEpisodeOfCare",
    "title": "UK Core EpisodeOfCare",
    "status": "active",
    "date": "2022-01-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the EpisodeOfCare resource for the minimal set of data to query and retrieve episode of care information.",
    "purpose": "This profile allows exchange of information about an association between a patient and an organisation / healthcare provider(s) during which time encounters may occur. The managing organisation assumes a level of responsibility for the individual during this time.",
    "copyright": "Copyright © 2021+ 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.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "EpisodeOfCare",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "EpisodeOfCare.identifier.assigner",
                "path": "EpisodeOfCare.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.diagnosis.condition",
                "path": "EpisodeOfCare.diagnosis.condition",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.diagnosis.condition.identifier.assigner",
                "path": "EpisodeOfCare.diagnosis.condition.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.patient",
                "path": "EpisodeOfCare.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.patient.identifier.assigner",
                "path": "EpisodeOfCare.patient.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.managingOrganization",
                "path": "EpisodeOfCare.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.managingOrganization.identifier.assigner",
                "path": "EpisodeOfCare.managingOrganization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.referralRequest",
                "path": "EpisodeOfCare.referralRequest",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.referralRequest.identifier.assigner",
                "path": "EpisodeOfCare.referralRequest.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.careManager",
                "path": "EpisodeOfCare.careManager",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.careManager.identifier.assigner",
                "path": "EpisodeOfCare.careManager.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.team",
                "path": "EpisodeOfCare.team",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.team.identifier.assigner",
                "path": "EpisodeOfCare.team.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "EpisodeOfCare.account.identifier.assigner",
                "path": "EpisodeOfCare.account.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Example Usage Scenarios

The following are example usage scenarios for the UK Core EpisodeOfCare profile:

  • Query for a information about an episode of care associated with a patient
  • Record or update information about an episode of care for a patient

Profile Minimum Viable Content

Each EpisodeOfCare resource must have:

  • A status
  • A subject
  • A type

Each EpisodeOfCare resource should support:

  • A diagnosis
  • A referralRequest

Profile specific implementation guidance:


identifier

Business Identifier(s) relevant for this EpisodeOfCare

Provider Systems

It is recommended that the identifier value is a Universally Unique Identifier (UUID) as there is no nationally recognised business indentier for an instance of a recorded Episode of Care.

Consumer Systems

Consumer systems MUST consume this data.


status

A code to indicate the status of the Episode of Care.

This element must be present and use a value from the CodeSystem below:

HTML View

This code system http://hl7.org/fhir/episode-of-care-status defines the following codes:

CodeDisplayDefinition
plannedPlannedThis episode of care is planned to start at the date specified in the period.start. During this status, an organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to make resources available to provide care services.
waitlistWaitlistThis episode has been placed on a waitlist, pending the episode being made active (or cancelled).
activeActiveThis episode of care is current.
onholdOn HoldThis episode of care is on hold; the organization has limited responsibility for the patient (such as while on respite).
finishedFinishedThis episode of care is finished and the organization is not expecting to be providing further care to the patient. Can also be known as "closed", "completed" or other similar terms.
cancelledCancelledThe episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care. It indicates that services terminated outside the planned/expected workflow.
entered-in-errorEntered in ErrorThis instance should not have been part of this patient's medical record.

Table View

CodeSystem.id[0]episode-of-care-status
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]2
CodeSystem.url[0]http://hl7.org/fhir/episode-of-care-status
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.665
CodeSystem.version[0]4.0.1
CodeSystem.name[0]EpisodeOfCareStatus
CodeSystem.title[0]EpisodeOfCareStatus
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.publisher[0]HL7 (FHIR Project)
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.contact[0].telecom[1].system[0]email
CodeSystem.contact[0].telecom[1].value[0]fhir@lists.hl7.org
CodeSystem.description[0]The status of the episode of care.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/episode-of-care-status
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]planned
CodeSystem.concept[0].display[0]Planned
CodeSystem.concept[0].definition[0]This episode of care is planned to start at the date specified in the period.start. During this status, an organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to make resources available to provide care services.
CodeSystem.concept[1].code[0]waitlist
CodeSystem.concept[1].display[0]Waitlist
CodeSystem.concept[1].definition[0]This episode has been placed on a waitlist, pending the episode being made active (or cancelled).
CodeSystem.concept[2].code[0]active
CodeSystem.concept[2].display[0]Active
CodeSystem.concept[2].definition[0]This episode of care is current.
CodeSystem.concept[3].code[0]onhold
CodeSystem.concept[3].display[0]On Hold
CodeSystem.concept[3].definition[0]This episode of care is on hold; the organization has limited responsibility for the patient (such as while on respite).
CodeSystem.concept[4].code[0]finished
CodeSystem.concept[4].display[0]Finished
CodeSystem.concept[4].definition[0]This episode of care is finished and the organization is not expecting to be providing further care to the patient. Can also be known as "closed", "completed" or other similar terms.
CodeSystem.concept[5].code[0]cancelled
CodeSystem.concept[5].display[0]Cancelled
CodeSystem.concept[5].definition[0]The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care. It indicates that services terminated outside the planned/expected workflow.
CodeSystem.concept[6].code[0]entered-in-error
CodeSystem.concept[6].display[0]Entered in Error
CodeSystem.concept[6].definition[0]This instance should not have been part of this patient's medical record.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="episode-of-care-status" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="2" />
    </extension>
    <url value="http://hl7.org/fhir/episode-of-care-status" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.665" />
    </identifier>
    <version value="4.0.1" />
    <name value="EpisodeOfCareStatus" />
    <title value="EpisodeOfCareStatus" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="HL7 (FHIR Project)" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="fhir@lists.hl7.org" />
        </telecom>
    </contact>
    <description value="The status of the episode of care." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/episode-of-care-status" />
    <content value="complete" />
    <concept>
        <code value="planned" />
        <display value="Planned" />
        <definition value="This episode of care is planned to start at the date specified in the period.start. During this status, an organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to make resources available to provide care services." />
    </concept>
    <concept>
        <code value="waitlist" />
        <display value="Waitlist" />
        <definition value="This episode has been placed on a waitlist, pending the episode being made active (or cancelled)." />
    </concept>
    <concept>
        <code value="active" />
        <display value="Active" />
        <definition value="This episode of care is current." />
    </concept>
    <concept>
        <code value="onhold" />
        <display value="On Hold" />
        <definition value="This episode of care is on hold; the organization has limited responsibility for the patient (such as while on respite)." />
    </concept>
    <concept>
        <code value="finished" />
        <display value="Finished" />
        <definition value="This episode of care is finished and the organization is not expecting to be providing further care to the patient. Can also be known as &quot;closed&quot;, &quot;completed&quot; or other similar terms." />
    </concept>
    <concept>
        <code value="cancelled" />
        <display value="Cancelled" />
        <definition value="The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care. It indicates that services terminated outside the planned/expected workflow." />
    </concept>
    <concept>
        <code value="entered-in-error" />
        <display value="Entered in Error" />
        <definition value="This instance should not have been part of this patient&#39;s medical record." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "episode-of-care-status",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 2
        }
    ],
    "url": "http://hl7.org/fhir/episode-of-care-status",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.665"
        }
    ],
    "version": "4.0.1",
    "name": "EpisodeOfCareStatus",
    "title": "EpisodeOfCareStatus",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "HL7 (FHIR Project)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                },
                {
                    "system": "email",
                    "value": "fhir@lists.hl7.org"
                }
            ]
        }
    ],
    "description": "The status of the episode of care.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/episode-of-care-status",
    "content": "complete",
    "concept":  [
        {
            "code": "planned",
            "display": "Planned",
            "definition": "This episode of care is planned to start at the date specified in the period.start. During this status, an organization may perform assessments to determine if the patient is eligible to receive services, or be organizing to make resources available to provide care services."
        },
        {
            "code": "waitlist",
            "display": "Waitlist",
            "definition": "This episode has been placed on a waitlist, pending the episode being made active (or cancelled)."
        },
        {
            "code": "active",
            "display": "Active",
            "definition": "This episode of care is current."
        },
        {
            "code": "onhold",
            "display": "On Hold",
            "definition": "This episode of care is on hold; the organization has limited responsibility for the patient (such as while on respite)."
        },
        {
            "code": "finished",
            "display": "Finished",
            "definition": "This episode of care is finished and the organization is not expecting to be providing further care to the patient. Can also be known as \"closed\", \"completed\" or other similar terms."
        },
        {
            "code": "cancelled",
            "display": "Cancelled",
            "definition": "The episode of care was cancelled, or withdrawn from service, often selected during the planned stage as the patient may have gone elsewhere, or the circumstances have changed and the organization is unable to provide the care. It indicates that services terminated outside the planned/expected workflow."
        },
        {
            "code": "entered-in-error",
            "display": "Entered in Error",
            "definition": "This instance should not have been part of this patient's medical record."
        }
    ]
}

This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.


statusHistory

The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).


type

A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.


diagnosis

A reference to Conditions/problems/diagnoses this episode of care is for. Profiled as a reference to Profile UKCore-Condition.


patient

The patient who is the focus of this episode of care.

Profiled as a reference to Profile UKCore-Patient.


managingOrganization

A reference to the Organization that assumes care profiled as Profile UKCore-Organization.

period

Interval during responsibility is assumed.


referralRequest

A reference to theOriginating Referral Request(s)

careManager

A reference to the Care manager/care coordinator for the patient.

This can be Profiled as a reference to:


team

Other practitioners facilitating this episode of care as a reference to the CareTeam resource.


account

The set of accounts that may be used for billing for this EpisodeOfCare.


back to top