US Public Health Profiles Library
2.0.0 - United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.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-ph-library/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Survey Practitioner Group

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-survey-practitioner-group Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthSurveyPractitionerGroup
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.58

This Group profile represents survey participant groups, research groups, etc.

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(4.0.1) US Public Health Survey Practitioner Group
Constraints: grp-1
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... name SΣ 0..1 string Label for Group
... managingEntity SΣ 1..1 Reference(US Public Health Organization(2.0.0)) 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
Constraints: ext-1
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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.

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 Group.meta, Group.meta.lastUpdated, Group.implicitRules, Group.modifierExtension, Group.active, Group.type, Group.actual, Group.name, Group.managingEntity, Group.member, Group.member.modifierExtension, Group.member.entity, Group.member.period, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.modifierExtension, Group.member.modifierExtension 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(4.0.1) US Public Health Survey Practitioner Group
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... active S 0..1 boolean Whether this group's record is in active use
... type S 1..1 code person | animal | practitioner | device | medication | substance
Fixed Value: person
... name S 0..1 string Label for Group
... managingEntity S 1..1 Reference(US Public Health Organization(2.0.0)) Entity that is the custodian of the Group's definition
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.0.1) US Public Health Survey Practitioner Group
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
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Unique id
... active SΣ 0..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 0..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(US Public Health Organization(2.0.0)) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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 example Not Stated Unknown
Group.characteristic.​code Base example Not Stated Unknown
Group.characteristic.​value[x] Base example Not Stated 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 Group.meta, Group.meta.extension, Group.meta.versionId, Group.meta.lastUpdated, Group.meta.source, Group.meta.profile, Group.meta.security, Group.meta.tag, Group.implicitRules, Group.language, Group.text, Group.extension, Group.modifierExtension, Group.identifier, Group.active, Group.type, Group.actual, Group.code, Group.name, Group.quantity, Group.managingEntity, Group.characteristic, Group.characteristic.extension, Group.characteristic.modifierExtension, Group.characteristic.code, Group.characteristic.value[x], Group.characteristic.exclude, Group.characteristic.period, Group.member, Group.member.extension, Group.member.modifierExtension, Group.member.entity, Group.member.period, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.meta.extension, Group.extension, Group.modifierExtension, Group.characteristic.extension, Group.characteristic.modifierExtension, Group.member.extension, Group.member.modifierExtension 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)

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.0.1) US Public Health Survey Practitioner Group
Constraints: grp-1
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 1..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... name SΣ 0..1 string Label for Group
... managingEntity SΣ 1..1 Reference(US Public Health Organization(2.0.0)) 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
Constraints: ext-1
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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.

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 Group.meta, Group.meta.lastUpdated, Group.implicitRules, Group.modifierExtension, Group.active, Group.type, Group.actual, Group.name, Group.managingEntity, Group.member, Group.member.modifierExtension, Group.member.entity, Group.member.period, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.modifierExtension, Group.member.modifierExtension 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(4.0.1) US Public Health Survey Practitioner Group
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... active S 0..1 boolean Whether this group's record is in active use
... type S 1..1 code person | animal | practitioner | device | medication | substance
Fixed Value: person
... name S 0..1 string Label for Group
... managingEntity S 1..1 Reference(US Public Health Organization(2.0.0)) Entity that is the custodian of the Group's definition
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group(4.0.1) US Public Health Survey Practitioner Group
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
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Unique id
... active SΣ 0..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
Fixed Value: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 0..1 string Label for Group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(US Public Health Organization(2.0.0)) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... entity S 1..1 Reference(US Core Practitioner Profile(6.1.0)) 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 example Not Stated Unknown
Group.characteristic.​code Base example Not Stated Unknown
Group.characteristic.​value[x] Base example Not Stated 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 Group.meta, Group.meta.extension, Group.meta.versionId, Group.meta.lastUpdated, Group.meta.source, Group.meta.profile, Group.meta.security, Group.meta.tag, Group.implicitRules, Group.language, Group.text, Group.extension, Group.modifierExtension, Group.identifier, Group.active, Group.type, Group.actual, Group.code, Group.name, Group.quantity, Group.managingEntity, Group.characteristic, Group.characteristic.extension, Group.characteristic.modifierExtension, Group.characteristic.code, Group.characteristic.value[x], Group.characteristic.exclude, Group.characteristic.period, Group.member, Group.member.extension, Group.member.modifierExtension, Group.member.entity, Group.member.period, Group.member.inactive All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Group.meta.extension, Group.extension, Group.modifierExtension, Group.characteristic.extension, Group.characteristic.modifierExtension, Group.member.extension, Group.member.modifierExtension 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)

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron