UK Core Implementation Guide Assets in Development

UK Core Implementation Guide Assets in Development

StructureDefinition-UKCore-CareTeam

Defines the UK Core constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve an individual’s care team.

Profile Purpose

This profile allows recording of the care team which includes all the people and organisations who plan to participate in the coordination and delivery of care for an individual. This is not limited to practitioners, but may include other caregivers such as family members, guardians, the individual themselves, or others. The care team, depending on where used, may include care team members specific to a particular care plan, an episode, an encounter, or may reflect all known team members across these perspectives. An individual's care team can be dynamic over time, such that there can be transience of team members, such as a rehabilitation team.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
categoryΣ0..*CodeableConcept
nameΣ0..1string
subjectΣ I0..1Reference(Group | UK Core Patient)
encounterΣ I0..1Reference(Encounter)
periodΣ I0..1Period
roleΣ0..*CodeableConcept
memberΣ I0..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam)
onBehalfOfΣ I0..1Reference(UK Core Organization)
periodI0..1Period
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition)
managingOrganizationΣ I0..*Reference(UK Core Organization)
telecomI0..*ContactPoint
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
categoryΣ0..*CodeableConcept
nameΣ0..1string
subjectΣ I0..1Reference(Group | UK Core Patient)
encounterΣ I0..1Reference(Encounter)
periodΣ I0..1Period
roleΣ0..*CodeableConcept
memberΣ I0..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam)
onBehalfOfΣ I0..1Reference(UK Core Organization)
periodI0..1Period
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition)
managingOrganizationΣ I0..*Reference(UK Core Organization)
telecomI0..*ContactPoint
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!0..1codeBinding
categoryΣ0..*CodeableConcept
nameΣ0..1string
subjectΣ I0..1Reference(Group | UK Core Patient)
encounterΣ I0..1Reference(Encounter)
periodΣ I0..1Period
roleΣ0..*CodeableConcept
memberΣ I0..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam)
onBehalfOfΣ I0..1Reference(UK Core Organization)
periodI0..1Period
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition)
managingOrganizationΣ I0..*Reference(UK Core Organization)
telecomI0..*ContactPoint
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown

Table View

CareTeam..
CareTeam.identifier..
CareTeam.identifier.assignerReference(UK Core Organization)..
CareTeam.subjectReference(Group | UK Core Patient)..
CareTeam.participant..
CareTeam.participant.memberReference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam)..
CareTeam.participant.onBehalfOfReference(UK Core Organization)..
CareTeam.managingOrganizationReference(UK Core Organization)..
CareTeam.note..
CareTeam.note.author[x]Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization), string..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-CareTeam" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam" />
    <version value="2.1.0" />
    <name value="UKCoreCareTeam" />
    <title value="UK Core CareTeam" />
    <status value="draft" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [CareTeam](https://hl7.org/fhir/R4/CareTeam.html)." />
    <purpose value="This profile allows recording of the care team which includes all the people and organisations who plan to participate in the coordination and delivery of care for an individual. This is not limited to practitioners, but may include other caregivers such as family members, guardians, the individual themselves, or others. The care team, depending on where used, may include care team members specific to a particular care plan, an episode, an encounter, or may reflect all known team members across these perspectives. An individual&#39;s care team can be dynamic over time, such that there can be transience of team members, such as a rehabilitation team." />
    <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="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="CareTeam" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
    <derivation value="constraint" />
    <differential>
        <element id="CareTeam.identifier.assigner">
            <path value="CareTeam.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="CareTeam.subject">
            <path value="CareTeam.subject" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="CareTeam.participant.member">
            <path value="CareTeam.participant.member" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam" />
            </type>
        </element>
        <element id="CareTeam.participant.onBehalfOf">
            <path value="CareTeam.participant.onBehalfOf" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="CareTeam.managingOrganization">
            <path value="CareTeam.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="CareTeam.note.author[x]">
            <path value="CareTeam.note.author[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
            <type>
                <code value="string" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-CareTeam",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam",
    "version": "2.1.0",
    "name": "UKCoreCareTeam",
    "title": "UK Core CareTeam",
    "status": "draft",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [CareTeam](https://hl7.org/fhir/R4/CareTeam.html).",
    "purpose": "This profile allows recording of the care team which includes all the people and organisations who plan to participate in the coordination and delivery of care for an individual. This is not limited to practitioners, but may include other caregivers such as family members, guardians, the individual themselves, or others. The care team, depending on where used, may include care team members specific to a particular care plan, an episode, an encounter, or may reflect all known team members across these perspectives. An individual's care team can be dynamic over time, such that there can be transience of team members, such as a rehabilitation team.",
    "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": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "CareTeam",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CareTeam",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "CareTeam.identifier.assigner",
                "path": "CareTeam.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "CareTeam.subject",
                "path": "CareTeam.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "CareTeam.participant.member",
                "path": "CareTeam.participant.member",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam"
                        ]
                    }
                ]
            },
            {
                "id": "CareTeam.participant.onBehalfOf",
                "path": "CareTeam.participant.onBehalfOf",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "CareTeam.managingOrganization",
                "path": "CareTeam.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "CareTeam.note.author[x]",
                "path": "CareTeam.note.author[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    },
                    {
                        "code": "string"
                    }
                ]
            }
        ]
    }
}

Examples

Care Team Weight Management Team - An example to illustrate a weight management care team scenario.

Example UKCore-CareTeam-WeightManagementTeam

Example Usage Scenarios

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

  • Text will be added when available
  • Text will be added when available

Profile specific implementation guidance:

back to top