National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build 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 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

Resource Profile: NDH Group

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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
... active SΣ 1..1 boolean Whether this group's record is in active use
Fixed Value: true
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: practitioner
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name SΣ 1..1 string Label for Group
... managingEntity SΣ 0..1 Reference(NDH Organization Profile) Entity that is the custodian of the Group's definition
... member SC 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 S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

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

Constraints

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)

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... identifier S 0..* Identifier Unique id
... type 1..1 code person | animal | practitioner | device | medication | substance
Fixed Value: practitioner
... actual 1..1 boolean Descriptive or actual
Fixed Value: true
... code S 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name S 1..1 string Label for Group
... managingEntity S 0..1 Reference(NDH Organization Profile) Entity that is the custodian of the Group's definition
... member S 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(NDH Practitioner Profile | NDH PractitionerRole) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base extensible NDH Care Team Category Value Set 📦2.0.0-current This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
.... 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 SΣ 0..* Identifier Unique id
... active SΣ 1..1 boolean Whether this group's record is in active use
Fixed Value: true
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: practitioner
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name SΣ 1..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 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 SC 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 S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

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

Constraints

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)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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
... active SΣ 1..1 boolean Whether this group's record is in active use
Fixed Value: true
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: practitioner
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name SΣ 1..1 string Label for Group
... managingEntity SΣ 0..1 Reference(NDH Organization Profile) Entity that is the custodian of the Group's definition
... member SC 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 S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

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

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... meta
.... lastUpdated 1..1 instant When the resource version last changed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
... identifier S 0..* Identifier Unique id
... type 1..1 code person | animal | practitioner | device | medication | substance
Fixed Value: practitioner
... actual 1..1 boolean Descriptive or actual
Fixed Value: true
... code S 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name S 1..1 string Label for Group
... managingEntity S 0..1 Reference(NDH Organization Profile) Entity that is the custodian of the Group's definition
... member S 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(NDH Practitioner Profile | NDH PractitionerRole) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base extensible NDH Care Team Category Value Set 📦2.0.0-current This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
.... 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 SΣ 0..* Identifier Unique id
... active SΣ 1..1 boolean Whether this group's record is in active use
Fixed Value: true
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: practitioner
... actual ΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code SΣ 1..1 CodeableConcept NDH Group type (Care Team Category)
Binding: NDH Care Team Category Value Set (extensible)
... name SΣ 1..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 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 SC 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 S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

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

Constraints

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)

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

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

_include Search Parameter

None defined.

_revinclude Search Parameter

None defined.

Special Search Parameters

None defined.