This page is part of the US Public Health Profiles Library (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: US Public Health Survey Practitioner Group

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

Usages:

• Examples for this Profile: Group/us-ph-survey-practitioner-group-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group	C	0..*	Group	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
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
name	SΣ	0..1	string	Label for Group
managingEntity	SΣ	1..1	Reference(US Public Health Organization)	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	S	1..1	Reference(US Core Practitioner Profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group		0..*	Group	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
actual	S	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)	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)	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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group	C	0..*	Group	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
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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)	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	S	1..1	Reference(US Core Practitioner Profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 From the FHIR Standard
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 1 element(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Maturity: 3

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group	C	0..*	Group	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
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
name	SΣ	0..1	string	Label for Group
managingEntity	SΣ	1..1	Reference(US Public Health Organization)	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	S	1..1	Reference(US Core Practitioner Profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group		0..*	Group	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
actual	S	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)	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)	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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Group	C	0..*	Group	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
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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)	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	S	1..1	Reference(US Core Practitioner Profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 From the FHIR Standard
Group.code	example
Group.characteristic.code	example
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 1 element(1 nested mandatory element)
Must-Support: 10 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Maturity: 3

Other representations of profile: CSV, Excel, Schematron