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 | ||
The NDH Group represents a group of multi-disciplinary providers organized around a specific healthcare program or service, not an individual patient. For example, a diabetic care team may include an endocrinologist, a diabetes educator, and a nutritionist.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | Healthcare Service Category Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from Group
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | extensible | Healthcare Service Category Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
![]() ![]() ![]() |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Unique id | ||||
![]() ![]() |
SΣ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | ||||
![]() ![]() |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner | ||||
![]() ![]() |
ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: Healthcare Service Category Value Set (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | string | Label for Group | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() |
SΣ | 0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | ||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Who or what is in group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Period member belonged to the group | ||||
![]() ![]() ![]() |
S | 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 | Healthcare Service 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 |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
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
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | extensible | Healthcare Service Category Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Differential View
This structure is derived from Group
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | extensible | Healthcare Service Category Value Set | 📦2.0.0-current | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Location Profile) | Network coverage area URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | |||||
![]() ![]() ![]() |
0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | markdown | Group Description URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
![]() ![]() ![]() |
0..1 | Period | Group Effective Period URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Unique id | ||||
![]() ![]() |
SΣ | 1..1 | boolean | Whether this group's record is in active use Fixed Value: true | ||||
![]() ![]() |
Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: practitioner | ||||
![]() ![]() |
ΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: Healthcare Service Category Value Set (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | string | Label for Group | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() |
SΣ | 0..1 | Reference(NDH Organization Profile) | Entity that is the custodian of the Group's definition | ||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Who or what is in group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(NDH Practitioner Profile | NDH PractitionerRole) | Reference to the group member | |||||
![]() ![]() ![]() |
S | 0..1 | Period | Period member belonged to the group | ||||
![]() ![]() ![]() |
S | 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 | Healthcare Service 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 |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
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
None defined.
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 |
|---|---|---|
| member | reference | GET [base]/Group?member=Patient/123 |
| managing-entity | reference | GET [base]/Group?managing-entity={system}|{value} |
| type | token | GET [base]/Group?type=some-type |
| code | token | GET [base]/Group?code=some-code |
None defined.
None defined.
None defined.