HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
StructureDefinition: UKCoreCareTeam
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.
The official URL for this profile is:
https://fhir.nhs.uk/R4/StructureDefinition/UKCore-CareTeam
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareTeam
This structure is derived from CareTeam
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CareTeam | I | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
 identifier | ΣI | 0..* | Identifier | External Ids for this team |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
  assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| status | ?!ΣI | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
| category | ΣI | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
| name | ΣI | 0..1 | string | Name of the team, such as crisis assessment team |
| subject | ΣI | 0..1 | Reference(Group | UK Core Patient) | Who care team is for |
| encounter | ΣI | 0..1 | Reference(UK Core Encounter) | Encounter created as part of |
| period | ΣI | 0..1 | Period | Time period team covers |
| participant | I | 0..* | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | ΣI | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example) |
| member | ΣI | 0..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam) | Who is involved |
| onBehalfOf | ΣI | 0..1 | Reference(UK Core Organization) | Organization of the practitioner |
| period | I | 0..1 | Period | Time period of participant |
| reasonCode | I | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | I | 0..* | Reference(UK Core Condition) | Why the care team exists |
| managingOrganization | ΣI | 0..* | Reference(UK Core Organization) | Organization responsible for the care team |
| telecom | I | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
 note | I | 0..* | Annotation | Comments made about the CareTeam |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
 author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | ΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
This structure is derived from CareTeam
Differential View
This structure is derived from CareTeam
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam | I | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External Ids for this team |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| status | ?!ΣI | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
| category | ΣI | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
| name | ΣI | 0..1 | string | Name of the team, such as crisis assessment team |
| subject | ΣI | 0..1 | Reference(Group | UK Core Patient) | Who care team is for |
| encounter | ΣI | 0..1 | Reference(UK Core Encounter) | Encounter created as part of |
| period | ΣI | 0..1 | Period | Time period team covers |
| participant | I | 0..* | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | ΣI | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example) |
| member | ΣI | 0..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | UK Core Patient | UK Core Organization | UK Core CareTeam) | Who is involved |
| onBehalfOf | ΣI | 0..1 | Reference(UK Core Organization) | Organization of the practitioner |
| period | I | 0..1 | Period | Time period of participant |
| reasonCode | I | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | I | 0..* | Reference(UK Core Condition) | Why the care team exists |
| managingOrganization | ΣI | 0..* | Reference(UK Core Organization) | Organization responsible for the care team |
| telecom | I | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
| note | I | 0..* | Annotation | Comments made about the CareTeam |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | ΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| CareTeam.language | preferred | CommonLanguages Max Binding: AllLanguages |
| CareTeam.identifier.use | required | IdentifierUse |
| CareTeam.identifier.type | extensible | Identifier Type Codes |
| CareTeam.status | required | CareTeamStatus |
| CareTeam.category | example | CareTeamCategory |
| CareTeam.participant.role | example | ParticipantRoles |
| CareTeam.reasonCode | example | SNOMEDCTClinicalFindings |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | CareTeam | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | CareTeam | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | CareTeam | 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-5 | CareTeam | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | CareTeam | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | CareTeam.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ctm-1 | CareTeam.participant | CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner : onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists())) | |
| ele-1 | CareTeam.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.participant.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.participant.role | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.participant.member | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.participant.onBehalfOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.participant.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.note.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | CareTeam.note.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | CareTeam.note.author[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.note.time | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | CareTeam.note.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |