National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
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 2.0.0-current 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-Group | Version: 2.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhGroup | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.41 | |||||
This profile enables NDH to represent multidisciplinary provider groups as directory entities so consumers can discover team-based programs and services and understand the practitioner and practitioner-role membership that supports coordinated care delivery; it adds extensions for location and endpoint references, verification, artifact description, and effective period, and uses ValueSet-constrained group coding to standardize program/service classification.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:location |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
| extension:endpoint |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |
| extension:service-offered |
0..* | CodeableConcept | Service Offered URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-offered Binding: Healthcare Service Category Value Set (extensible) | |
| extension:verification-status |
0..1 | CodeableConcept | Group Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| extension:artifact-description |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
 extension:artifact-effectivePeriod |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..* | Identifier | Unique id | |
| active |
1..1 | boolean | Whether this group's record is in active use Fixed Value: true (no extensions allowed) | |
| type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner (no extensions allowed) | |
| actual |
C | 1..1 | boolean | Descriptive or actual Fixed Value: true (no extensions allowed) |
| code |
1..1 | CodeableConcept | NDH Group type (Care Team Category) Binding: NDH Care Team Category Value Set (extensible) | |
| name |
1..1 | string | Label for Group | |
 managingEntity |
0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | |
 member |
C | 0..* | BackboneElement | Who or what is in group |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| entity |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |
| period |
0..1 | Period | Period member belonged to the group | |
 inactive |
0..1 | boolean | If member is no longer in group | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Group
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:location |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
| extension:endpoint |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
| extension:service-offered |
0..* | CodeableConcept | Service Offered URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-offered Binding: Healthcare Service Category Value Set (extensible) | |||||
| extension:verification-status |
0..1 | CodeableConcept | Group Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| extension:artifact-description |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| extension:artifact-effectivePeriod |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique id | |||||
| active |
1..1 | boolean | Whether this group's record is in active use Fixed Value: true (no extensions allowed) | |||||
| type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner (no extensions allowed) | |||||
| actual |
C | 1..1 | boolean | Descriptive or actual Fixed Value: true (no extensions allowed) | ||||
| code |
1..1 | CodeableConcept | NDH Group type (Care Team Category) Binding: NDH Care Team Category Value Set (extensible) | |||||
| name |
1..1 | string | Label for Group | |||||
| quantity |
0..1 | unsignedInt | Number of members | |||||
| managingEntity |
0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | |||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| 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 | |||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
 value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
| member |
C | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | |||||
| entity |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Group
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 8 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:location |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |
| extension:endpoint |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |
| extension:service-offered |
0..* | CodeableConcept | Service Offered URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-offered Binding: Healthcare Service Category Value Set (extensible) | |
| extension:verification-status |
0..1 | CodeableConcept | Group Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| extension:artifact-description |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| extension:artifact-effectivePeriod |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Unique id | |
| active |
1..1 | boolean | Whether this group's record is in active use Fixed Value: true (no extensions allowed) | |
| type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner (no extensions allowed) | |
| actual |
C | 1..1 | boolean | Descriptive or actual Fixed Value: true (no extensions allowed) |
| code |
1..1 | CodeableConcept | NDH Group type (Care Team Category) Binding: NDH Care Team Category Value Set (extensible) | |
| name |
1..1 | string | Label for Group | |
| managingEntity |
0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | |
| member |
C | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| entity |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |
| period |
0..1 | Period | Period member belonged to the group | |
| inactive |
0..1 | boolean | If member is no longer in group | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Group
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:location |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
| extension:endpoint |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
| extension:service-offered |
0..* | CodeableConcept | Service Offered URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-offered Binding: Healthcare Service Category Value Set (extensible) | |||||
| extension:verification-status |
0..1 | CodeableConcept | Group Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| extension:artifact-description |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| extension:artifact-effectivePeriod |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique id | |||||
| active |
1..1 | boolean | Whether this group's record is in active use Fixed Value: true (no extensions allowed) | |||||
| type |
1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner (no extensions allowed) | |||||
| actual |
C | 1..1 | boolean | Descriptive or actual Fixed Value: true (no extensions allowed) | ||||
| code |
1..1 | CodeableConcept | NDH Group type (Care Team Category) Binding: NDH Care Team Category Value Set (extensible) | |||||
| name |
1..1 | string | Label for Group | |||||
| quantity |
0..1 | unsignedInt | Number of members | |||||
| managingEntity |
0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | |||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| 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 | |||||
| code |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
| value[x] |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| exclude |
1..1 | boolean | Group includes or excludes | |||||
| period |
0..1 | Period | Period over which characteristic is tested | |||||
| member |
C | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | |||||
| entity |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | If member is no longer in group | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Group.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | NDH Care Team Category Value Set | 📦2.0.0-current | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Group
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 8 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression |
| actual | token |
Descriptive or actual |
Group.actual
|
| characteristic | token |
Kind of characteristic |
Group.characteristic.code
|
| characteristic-value | composite |
A composite of both characteristic and value |
Group.characteristic
|
| code | token |
The kind of resources contained |
Group.code
|
| exclude | token |
Group includes or excludes |
Group.characteristic.exclude
|
| identifier | token |
Unique id |
Group.identifier
|
| managing-entity | reference |
Entity that is the custodian of the Group's definition |
Group.managingEntity
|
| member | reference |
Reference to the group member |
Group.member.entity
|
| service-offered | token |
Use this search parameter to find Group records by services offered to identify groups that provide specific services. Applies to Group records. |
Group.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-serviceoffered').extension.value.ofType(CodeableConcept)
|
| type | token |
The type of resources the group contains |
Group.type
|
| value | token |
Value held by characteristic |
(Group.characteristic.value as CodeableConcept) | (Group.characteristic.value as boolean)
|
| verification-status | token |
Use this search parameter to find records by verification standing to prioritize trusted and current directory data. Applies to Endpoint, HealthcareService, Organization, Location, Practitioner, PractitionerRole, InsurancePlan, OrganizationAffiliation, and Group records. |
extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status').value
|
None defined.
None defined.
None defined.
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
