National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-CareTeam | Version: 1.0.0-ballot | |||
Active as of 2024-11-01 | Computable Name: NdhCareTeam | |||
Copyright/Legal: HL7 International |
Defines the basic constraints and extensions on the CareTeam resource for use in a National Directory of Healthcare Providers & Service (NDH)
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 the National Directory of Healthcare Providers & Services (NDH). Therefore, this care team profile constrains out elements which reference or describe patient-level data. In general, the NDH is more likely to represent administrative teams, or teams that are relevant beyond the direct clinical care of specific patients.
Individuals participating on the NDH 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.
For all reasons above, this IG is using CareTeam Base profile, instead of US Core CareTeam profile. See variance Request ticket
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareTeam
Path | Conformance | ValueSet | URI |
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG | |
CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS from this IG |
Path | Conformance | ValueSet | URI |
CareTeam.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | |
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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.
| |||||
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 | |||||
careteam-alias | 0..* | string | Alternate names by which the care team is also known URL: http://hl7.org/fhir/StructureDefinition/careteam-alias | |||||
location | 0..* | Reference(NDH Base Location Profile) | The location(s) at which the care team operates or delivers services URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
healthcareservice | 0..* | Reference(NDH Base HealthcareService Profile) | Services provided by the care team URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference | |||||
endpoint | 0..* | Reference(NDH Base Endpoint Profile) | Endpoints for the care team URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | 0..1 | CodeableConcept | Indicate care team resource instance verifcation status. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | 0..1 | code | Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 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 | Σ | 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(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 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: NDH Care Team Category Value Set (extensible) | ||||
name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
period | Σ | 0..1 | Period | Time period team covers | ||||
participant | C | 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 | Σ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) | ||||
member | Σ | 0..1 | Reference(NDH Base CareTeam Profile | NDH Base PractitionerRole | NDH Base Organization Profile) | Who is involved | ||||
period | 0..1 | Period | Time period of participant | |||||
managingOrganization | Σ | 0..1 | Reference(NDH Base Organization Profile) | 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 | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contactpoint-availabletime | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(NDH Base Practitioner Profile | NDH Base Organization Profile) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
CareTeam.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CareTeam.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CareTeam.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | ||||
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG | ||||
CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS from this IG | ||||
CareTeam.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
CareTeam.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
This structure is derived from CareTeam
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 3 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CareTeam
Path | Conformance | ValueSet | URI |
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG | |
CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS from this IG |
Key Elements View
Path | Conformance | ValueSet | URI |
CareTeam.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | |
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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.
| |||||
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 | |||||
careteam-alias | 0..* | string | Alternate names by which the care team is also known URL: http://hl7.org/fhir/StructureDefinition/careteam-alias | |||||
location | 0..* | Reference(NDH Base Location Profile) | The location(s) at which the care team operates or delivers services URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
healthcareservice | 0..* | Reference(NDH Base HealthcareService Profile) | Services provided by the care team URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference | |||||
endpoint | 0..* | Reference(NDH Base Endpoint Profile) | Endpoints for the care team URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | 0..1 | CodeableConcept | Indicate care team resource instance verifcation status. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | 0..1 | code | Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 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 | Σ | 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(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 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: NDH Care Team Category Value Set (extensible) | ||||
name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
period | Σ | 0..1 | Period | Time period team covers | ||||
participant | C | 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 | Σ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) | ||||
member | Σ | 0..1 | Reference(NDH Base CareTeam Profile | NDH Base PractitionerRole | NDH Base Organization Profile) | Who is involved | ||||
period | 0..1 | Period | Time period of participant | |||||
managingOrganization | Σ | 0..1 | Reference(NDH Base Organization Profile) | 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 | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contactpoint-availabletime | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
via-intermediary | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
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 | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(NDH Base Practitioner Profile | NDH Base Organization Profile) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
CareTeam.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CareTeam.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CareTeam.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | ||||
CareTeam.category | extensible | NDHCareTeamCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS from this IG | ||||
CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS from this IG | ||||
CareTeam.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
CareTeam.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
This structure is derived from CareTeam
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 3 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
SearchParameter Name | Type | Example |
---|---|---|
endpoint | reference | GET [base]/CareTeam?endpoint.indentifier=1234567 |
location | reference | GET [base]/CareTeam?location.addr-state=MD |
name | string | GET [base]/CareTeame?name=VA-Oncology |
organization | reference | GET [base]/CareTeam?organization.name=Hartford General Hospital |
service | reference | GET [base]/CareTeame?service.active=true |
verification-status | token | GET [base]/CareTeame?verification-status=complete |
Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.
SearchParameter Name | Type | Example |
---|---|---|
category | token | GET [base]/CareTeam?category=behav |
identifier | token | GET [base]/CareTeam?identifier=http://hl7.org/fhir/R4/v2/0203/index.html|SB |
participant | reference | GET [base]/CareTeam?participant.name=Hamilton Clinic |
status | token | GET [base]/CareTeam?status=active |
_include | Example |
---|---|
CareTeam:location | GET [base]/CareTeam?_include=CareTeam:location |
CareTeam:organization | GET [base]/CareTeam?_include=CareTeam:organization |
CareTeam:participant | GET [base]/CareTeam?_include=&CareTeam:participant |
_revinclude | Example |
---|---|
VerifcationResult:target | GET [base]/CareTeam?_revinclude=VerifcationResult:target.type=CareTeam |
The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.