Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: OHH CareTeam

Official URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-team Version: 0.1.0
Active as of 2025-12-03 Computable Name: OhhCareTeam

A profile on the CareTeam resource describing the information returned by the GET operation and search.

Scope and Usage

The CareTeam resembles the (additional) participants in a program. There are two types of CareTeams:

  • The set of participants as defined in Designer’s Add colleagues step. Since the actual participants allowed to see the patient data differ per patient, the CareTeam is linked to a specific CarePlan for a patient.
    The ID of the CareTeam will match with the ID of the CarePlan.
    This CareTeam will have a category code with system care-team-category and value care-providers.
  • The set of caregivers that should fill out questionnaires for the patient. The roles of these participants are specified in the Designer’s Program planner step, and linked to actual caregivers when the patient is invited to participate in the program.
    The ID of this CareTeam consists of the ID of the CarePlan, followed by a -caregivers suffix.
    This CareTeam will have a category code with system care-team-category and value caregivers.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... status S 0..1 code proposed | active | suspended | inactive | entered-in-error
... category S 0..1 CodeableConcept Type of team
Binding: Care Team Category Value Set (required)
.... coding S 0..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... code S 1..1 code Symbol in syntax defined by the system
... name S 0..1 string Name of the team, such as crisis assessment team
... participant S 0..* BackboneElement Members of the team
.... role S 0..* CodeableConcept Type of involvement
..... text 1..1 string Plain text representation of the concept
.... member S 1..1 Reference(Practitioner) Who is involved

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... code SΣ 1..1 code Symbol in syntax defined by the system
... name SΣ 0..1 string Name of the team, such as crisis assessment team
... subject SΣ 1..1 Reference(Ohh Patient Profile) Who care team is for
... participant SC 0..* BackboneElement Members of the team
Constraints: ctm-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role SΣ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
..... text Σ 1..1 string Plain text representation of the concept
.... member SΣ 1..1 Reference(Practitioner) Who is involved

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ctm-1 error 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()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 External Ids for this team
... status ?!SΣ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category SΣ 0..1 CodeableConcept Type of team
Binding: Care Team Category Value Set (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 0..1 string Name of the team, such as crisis assessment team
... subject SΣ 1..1 Reference(Ohh Patient Profile) Who care team is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period team covers
... participant SC 0..* BackboneElement Members of the team
Constraints: ctm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role SΣ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 1..1 string Plain text representation of the concept
.... member SΣ 1..1 Reference(Practitioner) Who is involved
.... onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner
.... period 0..1 Period Time period of participant
... reasonCode 0..* CodeableConcept Why the care team exists
Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team.
... reasonReference 0..* Reference(Condition) Why the care team exists
... managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
... telecom 0..* ContactPoint A contact detail for the care team (that applies to all members)
... note 0..* Annotation Comments made about the CareTeam

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.
CareTeam.reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ctm-1 error 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()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CareTeam

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... status S 0..1 code proposed | active | suspended | inactive | entered-in-error
... category S 0..1 CodeableConcept Type of team
Binding: Care Team Category Value Set (required)
.... coding S 0..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... code S 1..1 code Symbol in syntax defined by the system
... name S 0..1 string Name of the team, such as crisis assessment team
... participant S 0..* BackboneElement Members of the team
.... role S 0..* CodeableConcept Type of involvement
..... text 1..1 string Plain text representation of the concept
.... member S 1..1 Reference(Practitioner) Who is involved

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... code SΣ 1..1 code Symbol in syntax defined by the system
... name SΣ 0..1 string Name of the team, such as crisis assessment team
... subject SΣ 1..1 Reference(Ohh Patient Profile) Who care team is for
... participant SC 0..* BackboneElement Members of the team
Constraints: ctm-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role SΣ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
..... text Σ 1..1 string Plain text representation of the concept
.... member SΣ 1..1 Reference(Practitioner) Who is involved

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ctm-1 error 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()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 External Ids for this team
... status ?!SΣ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category SΣ 0..1 CodeableConcept Type of team
Binding: Care Team Category Value Set (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/care-team-category
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 0..1 string Name of the team, such as crisis assessment team
... subject SΣ 1..1 Reference(Ohh Patient Profile) Who care team is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period team covers
... participant SC 0..* BackboneElement Members of the team
Constraints: ctm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role SΣ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 1..1 string Plain text representation of the concept
.... member SΣ 1..1 Reference(Practitioner) Who is involved
.... onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner
.... period 0..1 Period Time period of participant
... reasonCode 0..* CodeableConcept Why the care team exists
Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team.
... reasonReference 0..* Reference(Condition) Why the care team exists
... managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
... telecom 0..* ContactPoint A contact detail for the care team (that applies to all members)
... note 0..* Annotation Comments made about the CareTeam

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base required Care Team Category Value Set 📦0.1.0 This IG
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.
CareTeam.reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ctm-1 error 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()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CareTeam

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron