National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 United States of America flag

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 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

Resource Profile: NDH Base CareTeam Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-CareTeam Version: 1.0.0
Standards status: Trial-use 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)

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 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:

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
.... extension:careteam-alias 0..* string Alternate names by which the care team is also known
URL: http://hl7.org/fhir/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
.... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:endpoint 0..* Reference(NDH Base Endpoint Profile) Endpoints for the care team
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension: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)
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
.... 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
..... extension:identifier-status 0..1 code Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: 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 ?!Σ 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
.... assigner Σ 0..1 Reference(NDH Base Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 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: NDH Care Team Category Value Set (extensible)
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
... managingOrganization Σ 0..1 Reference(NDH Base Organization Profile) Organization responsible for the care team
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.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryextensibleNDHCareTeamCategoryVS
http://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS
from this IG

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

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

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

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 Search Parameter

_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 Search parameter

_revinclude Example
VerifcationResult:target GET [base]/CareTeam?_revinclude=VerifcationResult:target.type=CareTeam

Special Search Parameters

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.