This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions
StructureDefinition-vhdir-careteam
This profile sets minimum expectations for searching for and fetching information associated with a care team. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the CareTeam resource when using this profile.
Background & Scope
A care team consists of the providers and/or organizations responsible for the care of a patient. Individuals participating on a VHDir CareTeam SHALL be represented through an associated role. Therefore, this profile removes references to the Practitioner resource in CareTeam.participant.member
. For example, Dr. Smith (an individual) does not participate on a care team. Rather, Dr. Smith in his role as a provider at Acme Hospital participates on a care team.
A care team may be functionally “empty,” i.e. the roles on the care team are not filled by individuals. For example, a care team may be comprised of a primary care provider role, care coordinator role, and specialist role without indicating the individuals filling those roles. This enables entities to describe existing care teams while masking the identity of the individuals/organizations that are involved, or to represent standing care teams that are filled by individuals on an ad hoc basis in response to a condition/event.
This profile modifies the base CareTeam resource in the following manner:
-
Constrains the cardinality of
careTeam.status
(1..1),careTeam.category
(1..*),careTeam.context
(0..0),careTeam.subject
(0..0),careTeam.onBehalfOf
(0..0),careTeam.managingOrganization
(0..1),careTeam.reasonCode
(0..0),careTeam.reasonReference
(0..0),careTeam.telecom.system
(1..1), andcareTeam.telecom.value
(1..1) -
Modifies the data type of careTeam.note.author (removes references to Patient and RelatedPerson resources)
-
Modifies the data type of CareTeam.participant.member (removes references to Patient, RelatedPerson, and Practitioner resources)
-
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
-
Adds extensions:
- Identifier status (1..1) - indicates the status of a care team’s identifier
- Via intermediary (0..1) - a reference to an alternative point of contact for this care team
- Available time (0..*) - indicates when a care team is available for contact
- Alias (0..*) - indicates alternate names by which the care team is known
- Location (0..*) - reference(s) to the location resource, indicating the location(s) at which the care team operates or delivers services
- Service (0..*) - reference(s) to the healthcareService resource, indicating the services offered by the care team
- Endpoint (0..*) - reference(s) to the endpoint resource, indicating technical endpoints for the care team independent of its members, affiliated organizations, etc.
- Restriction (0..*) - indicates whether disclosure of any data associated with a care team is restricted
- Adds new value sets/updates value set bindings:
TBD
Examples:
The following are example uses for the vhdir-careteam profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each CareTeam must have:
- One status code in
careTeam.status
- At least one type of care team in
careTeam.category
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-careteam
Published on Wed Oct 18 04:22:04 AEST 2017 as a active by HL7 International.
This profile builds on CareTeam
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | I | 0..* | 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 |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usage-restriction | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | |
careteam-alias | 0..* | string | Alias URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias | |
location-reference | 0..* | Reference(VhDir Location) | Location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference | |
healthcareservice-reference | 0..* | Reference(VhDir Healthcareservice) | healthcareService URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference | |
endpoint-reference | 0..* | Reference(VhDir Endpoint) | Endpoint reference URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this team |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
valueCode | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
category | Σ | 1..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
name | Σ | 0..1 | string | Name of the team, such as crisis assessment team |
period | Σ | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
role | Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example) |
member | Σ | 0..1 | Reference(VhDir Careteam | VhDir Practitionerrole | VhDir Organization) | Who is involved |
period | 0..1 | Period | Time period of participant | |
managingOrganization | Σ | 0..1 | Reference(VhDir Organization) | Organization responsible for the care team |
telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-availabletime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Via intermediary | |
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
note | 0..* | Annotation | Comments made about the CareTeam | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Reference(VhDir Practitioner), string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Summary
Mandatory: 2 elements (3 nested mandatory elements)
Prohibited: 5 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-careteam
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitioner
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | I | 0..* | 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 |
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
usage-restriction | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | |
careteam-alias | 0..* | string | Alias URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias | |
location-reference | 0..* | Reference(VhDir Location) | Location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference | |
healthcareservice-reference | 0..* | Reference(VhDir Healthcareservice) | healthcareService URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference | |
endpoint-reference | 0..* | Reference(VhDir Endpoint) | Endpoint reference URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this team |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
valueCode | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
category | Σ | 1..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
name | Σ | 0..1 | string | Name of the team, such as crisis assessment team |
period | Σ | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
role | Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example) |
member | Σ | 0..1 | Reference(VhDir Careteam | VhDir Practitionerrole | VhDir Organization) | Who is involved |
period | 0..1 | Period | Time period of participant | |
managingOrganization | Σ | 0..1 | Reference(VhDir Organization) | Organization responsible for the care team |
telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactpoint-availabletime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "daysOfWeek" | ||
valueCode | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "allDay" | ||
valueBoolean | 1..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableStartTime" | ||
valueTime | 1..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "availableEndTime" | ||
valueTime | 1..1 | time | Available end time | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
contactpoint-viaintermediary | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
valueReference | 1..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Via intermediary | |
system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
note | 0..* | Annotation | Comments made about the CareTeam | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
author[x] | Σ | 0..1 | Reference(VhDir Practitioner), string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
Supported Searches
-
GET [base]/CareTeam?careteam-category=[code]
Support: MAY support search by the
careteam-category
parameter- including the modifiers:
text
- including the modifiers:
-
GET [base]/CareTeam?careteam-endpoint=[id]
Support: SHOULD support search by the
careteam-endpoint
parameter- with a target type:
Endpoint
- including these search paramaters which may be chained:
endpoint-identifier
,endpoint-connection-type
,endpoint-organization
- with a target type:
-
GET [base]/CareTeam?careteam-identifier=[code]
Support: SHALL support search by the
careteam-identifier
parameter- including the modifiers:
text
,ofType
- including the modifiers:
-
GET [base]/CareTeam?careteam-identifier-assigner=[id]
Support: MAY support search by the
careteam-identifier-assigner
parameter- with a target type:
Organization
- including the modifiers:
below
- including these search paramaters which may be chained:
organization-identifier
,organization-name
- with a target type:
-
GET [base]/CareTeam?careteam-location=[id]
Support: SHALL support search by the
careteam-location
parameter- with a target type:
Location
- including the modifiers:
above
,below
- including these search paramaters which may be chained:
location-identifier
,location-type
,location-address
,location-organization
- with a target type:
-
GET [base]/CareTeam?careteam-member=[id]
Support: SHALL support search by the
careteam-member
parameter- with a target type:
PractitionerRole
,Organization
,CareTeam
- including the modifier:
type
- including these search paramaters which may be chained:
practitionerrole-identifier
,practitionerrole-location
,practitionerrole-practitioner
,practitionerrole-organization
,practitionerrole-role
,organization-address
,organization-identifier
,organization-name
,organization-partof
,careteam-identifier
,careteam-location
,careteam-organization
- with a target type:
-
GET [base]/CareTeam?careteam-name=[string]
Support: SHOULD support search by the
careteam-name
parameter- including the modifiers:
exact
,contains
- including the modifiers:
-
GET [base]/CareTeam?careteam-organization=[id]
Support: SHALL support search by the
careteam-organization
parameter- with a target type:
Organization
- including the modifiers:
above
,below
- including these search paramaters which may be chained:
organization-identifier
,organization-name
,organization-address
,organization-partof
,organization-type
- with a target type:
-
GET [base]/CareTeam?careteam-service=[id]
Support: SHOULD support search by the
careteam-service
parameter- with a target type:
HealthcareService
- including these search paramaters which may be chained:
healthcareservice-identifier
,healthcareservice-category
,healthcareservice-organization
,healthcareservice-location
- with a target type:
-
GET [base]/CareTeam?careteam-status=[code]
Support: SHALL support search by the
careteam-status
parameter
-
GET [base]/CareTeam?careteam-via-intermediary=[id]
Support: MAY support search by the
careteam-via-intermediary
parameter- with a target type:
PractitionerRole
,Organization
,OrganizationAffiliation
,Location
- with a target type: