FHIR Core Implementation Guide (CO) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Profile: Family Group CO

FHIR Core profile of Colombian family groups, defined by HL7 CO.

Standardize the recording and exchange of data of a family group [ES: Estandarizar los datos de registro e intercambo de datos de un grupo familiar.]

Usage:

• Examples for this Resource Profile: Grupo familiar: 324283476

Formal Views of Profile Content

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

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

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	Group	Family Group.
active	S	0..1	boolean	Whether this group's record is in active use
type		1..1	code	Types of resources that are part of group. Fixed Value: person
actual		1..1	boolean	Descriptive or actual Fixed Value: true
code		1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/ColombianGroups
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 35359004
display		1..1	string	Representation defined by the system Required Pattern: familia
text		0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
member	S	0..*	BackboneElement	Who or what is in group
entity	S	1..1	Reference(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
start		1..1	dateTime	Starting time with inclusive boundary
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Family Group. grp-1: Can only have members if group is "actual"
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	Σ	1..1	code	Types of resources that are part of group. Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	ΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
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(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
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
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes

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)

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Family Group. grp-1: Can only have members if group is "actual"
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
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	Σ	1..1	code	Types of resources that are part of group. Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	ΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/ColombianGroups
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 35359004
display	Σ	1..1	string	Representation defined by the system Required Pattern: familia
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
name	Σ	0..1	string	Label for Group
quantity	Σ	0..1	unsignedInt	Number of members
managingEntity	Σ	0..1	Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)	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 (No ValueSet): (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 (No ValueSet): (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(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes
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(4 nested mandatory elements)
Must-Support: 5 elements
Fixed: 5 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)

Differential View

This structure is derived from Group

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	Group	Family Group.
active	S	0..1	boolean	Whether this group's record is in active use
type		1..1	code	Types of resources that are part of group. Fixed Value: person
actual		1..1	boolean	Descriptive or actual Fixed Value: true
code		1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/ColombianGroups
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 35359004
display		1..1	string	Representation defined by the system Required Pattern: familia
text		0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
member	S	0..*	BackboneElement	Who or what is in group
entity	S	1..1	Reference(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
start		1..1	dateTime	Starting time with inclusive boundary
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Family Group. grp-1: Can only have members if group is "actual"
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	Σ	1..1	code	Types of resources that are part of group. Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	ΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
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(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
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
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes

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)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	Group	Family Group. grp-1: Can only have members if group is "actual"
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
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	Σ	1..1	code	Types of resources that are part of group. Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	ΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	1..1	CodeableConcept	Kind of Group members Binding: http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/ColombianGroups
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 35359004
display	Σ	1..1	string	Representation defined by the system Required Pattern: familia
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: Grupo familiar
name	Σ	0..1	string	Label for Group
quantity	Σ	0..1	unsignedInt	Number of members
managingEntity	Σ	0..1	Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)	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 (No ValueSet): (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 (No ValueSet): (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(Profile: Patient CO)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	required	http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes http://terminology.fhir.guide/co/ValueSet/ColombianGroupCodes
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(4 nested mandatory elements)
Must-Support: 5 elements
Fixed: 5 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)

Other representations of profile: CSV, Excel, Schematron