Validated Healthcare Directory
1.0.0 - STU1 International flag

This page is part of the Validated Healthcare Directory FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: VhDir Care Team

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-careteam Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: VhdirCareTeam

Copyright/Legal: HL7 International

Defines the basic constraints and extensions on the CareTeam resource for use in a Validated Healthcare Directory

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 effectively delivering coordinated care. Care teams are conventionally associated with a specific patient. For example, a patient with diabetes may have a care team that consists of a physician, nurse, dietitian, certified diabetes educator, etc. Data about patients/caregivers, however, is out of scope for a Validated Healthcare Directory. Therefore, this care team profile constrains out elements which reference or describe patient-level data. In general, a Validated Healthcare Directory is more likely to represent administrative teams, or teams that are relevant beyond the direct clinical care of specific patients.

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 (i.e., by referencing a PractitionerRole resource that does not reference a Practitioner resource). 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.participant.onBehalfOf (0..0), careTeam.managingOrganization (0..1), careTeam.reasonCode (0..0), careTeam.reasonReference (0..0), careTeam.telecom.system (1..1), and careTeam.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:

  1. Identifier status (1..1) - indicates the status of a care team's identifier
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this care team
  3. Available time (0..*) - indicates when a care team is available for contact
  4. Alias (0..*) - indicates alternate names by which the care team is known
  5. Location (0..*) - reference(s) to the location resource, indicating the location(s) at which the care team operates or delivers services
  6. Service (0..*) - reference(s) to the healthcareService resource, indicating the services offered by the care team
  7. Endpoint (0..*) - reference(s) to the endpoint resource, indicating technical endpoints for the care team independent of its members, affiliated organizations, etc.
  8. Restriction (0..*) - indicates whether disclosure of any data associated with a care team is restricted

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:

  1. One status code in careTeam.status
  2. At least one type of care team in careTeam.category

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier External Ids for this team
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.


ele-1: All FHIR elements must have a @value or children
... category SΣ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.


ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Name of the team, such as crisis assessment team
ele-1: All FHIR elements must have a @value or children
... period SΣ 0..1 Period Time period team covers
ele-1: All FHIR elements must have a @value or children
... participant SC 0..* BackboneElement Members of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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.


ele-1: All FHIR elements must have a @value or children
.... member SΣ 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
ele-1: All FHIR elements must have a @value or children
.... period S 0..1 Period Time period of participant
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(VhDir Organization) Organization responsible for the care team
ele-1: All FHIR elements must have a @value or children
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
.... period SΣ 0..1 Period Time period when the contact point was/is in use
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Comments made about the CareTeam
ele-1: All FHIR elements must have a @value or children
.... author[x] SΣ 0..1 Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... identifier S 0..* Identifier External Ids for this team
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... period S 0..1 Period Time period when id is/was valid for use
.... assigner S 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... status S 1..1 code proposed | active | suspended | inactive | entered-in-error
... category S 1..* CodeableConcept Type of team
... name S 0..1 string Name of the team, such as crisis assessment team
... subject S 0..0
... encounter 0..0
... period S 0..1 Period Time period team covers
... participant S 0..* BackboneElement Members of the team
.... role S 0..* CodeableConcept Type of involvement
.... member S 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
.... onBehalfOf S 0..0
.... period S 0..1 Period Time period of participant
... reasonCode S 0..0
... reasonReference S 0..0
... managingOrganization S 0..1 Reference(VhDir Organization) Organization responsible for the care team
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period S 0..1 Period Time period when the contact point was/is in use
... note S 0..* Annotation Comments made about the CareTeam
.... author[x] S 0..1 Individual responsible for the annotation
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External Ids for this team
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category SΣ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name SΣ 0..1 string Name of the team, such as crisis assessment team
... period SΣ 0..1 Period Time period team covers
... participant SC 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 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.


.... member SΣ 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
.... period S 0..1 Period Time period of participant
... managingOrganization SΣ 0..1 Reference(VhDir Organization) Organization responsible for the care team
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... note S 0..* Annotation Comments made about the CareTeam
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] SΣ 0..1 Individual responsible for the annotation
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier External Ids for this team
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
ele-1: All FHIR elements must have a @value or children
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.


ele-1: All FHIR elements must have a @value or children
... category SΣ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.


ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Name of the team, such as crisis assessment team
ele-1: All FHIR elements must have a @value or children
... period SΣ 0..1 Period Time period team covers
ele-1: All FHIR elements must have a @value or children
... participant SC 0..* BackboneElement Members of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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.


ele-1: All FHIR elements must have a @value or children
.... member SΣ 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
ele-1: All FHIR elements must have a @value or children
.... period S 0..1 Period Time period of participant
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(VhDir Organization) Organization responsible for the care team
ele-1: All FHIR elements must have a @value or children
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
.... period SΣ 0..1 Period Time period when the contact point was/is in use
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Comments made about the CareTeam
ele-1: All FHIR elements must have a @value or children
.... author[x] SΣ 0..1 Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Differential View

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... identifier S 0..* Identifier External Ids for this team
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... period S 0..1 Period Time period when id is/was valid for use
.... assigner S 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... status S 1..1 code proposed | active | suspended | inactive | entered-in-error
... category S 1..* CodeableConcept Type of team
... name S 0..1 string Name of the team, such as crisis assessment team
... subject S 0..0
... encounter 0..0
... period S 0..1 Period Time period team covers
... participant S 0..* BackboneElement Members of the team
.... role S 0..* CodeableConcept Type of involvement
.... member S 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
.... onBehalfOf S 0..0
.... period S 0..1 Period Time period of participant
... reasonCode S 0..0
... reasonReference S 0..0
... managingOrganization S 0..1 Reference(VhDir Organization) Organization responsible for the care team
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period S 0..1 Period Time period when the contact point was/is in use
... note S 0..* Annotation Comments made about the CareTeam
.... author[x] S 0..1 Individual responsible for the annotation
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... alias S 0..* string Alternate name for care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/careteam-alias
.... location S 0..* Reference(VhDir Location) Where the care team operates
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
.... service S 0..* Reference(VhDir Healthcare Service) Services provided by the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/healthcareservice-reference
.... endpoint S 0..* Reference(VhDir Endpoint) Endpoints for the care team
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier External Ids for this team
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category SΣ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name SΣ 0..1 string Name of the team, such as crisis assessment team
... period SΣ 0..1 Period Time period team covers
... participant SC 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 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.


.... member SΣ 0..1 Reference(VhDir Care Team | VhDir Practitioner Role | VhDir Organization) Who is involved
.... period S 0..1 Period Time period of participant
... managingOrganization SΣ 0..1 Reference(VhDir Organization) Organization responsible for the care team
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) viaintermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... note S 0..* Annotation Comments made about the CareTeam
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] SΣ 0..1 Individual responsible for the annotation
..... authorReference Reference(VhDir Practitioner)
..... authorString string
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Searches

  1. GET [base]/CareTeam?category=[code]

    Support: MAY support search by the category parameter

    • including the modifiers: text

  1. GET [base]/CareTeam?endpoint=[id]

    Support: SHOULD support search by the endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint.identifier, endpoint.connection-type, endpoint.organization

  1. GET [base]/CareTeam?identifier=[code]

    Support: SHALL support search by the identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/CareTeam?identifier-assigner=[id]

    Support: MAY support search by the identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

  1. GET [base]/CareTeam?location=[id]

    Support: SHALL support search by the 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

  1. GET [base]/CareTeam?participant=[id]

    Support: SHALL support search by the participant parameter

    • with a target type: PractitionerRole, Organization, CareTeam
    • including the modifier: type
    • including these search paramaters which may be chained: participant.identifier, participant.location, participant.practitioner, participant.organization, participant.role, participant.address, participant.name, participant.partof

  1. GET [base]/CareTeam?name=[string]

    Support: SHOULD support search by the name parameter

    • including the modifiers: exact, contains

  1. GET [base]/CareTeam?organization=[id]

    Support: SHALL support search by the 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

  1. GET [base]/CareTeam?service=[id]

    Support: SHOULD support search by the service parameter

    • with a target type: HealthcareService
    • including these search paramaters which may be chained: service.identifier, service.service-category, service.organization, service.location

  1. GET [base]/CareTeam?status=[code]

    Support: SHALL support search by the status parameter


  1. GET [base]/CareTeam?via-intermediary=[id]

    Support: MAY support search by the via-intermediary parameter

    • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location