Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services
1.0.1 - ci-build Ethiopia flag

Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/ethiopia-hiv/ and changes regularly. See the Directory of published versions

Resource Profile: Group - Patient's Family Members

Official URL: http://moh.gov.et/fhir/hiv/StructureDefinition/patient-family-members-group Version: 1.0.1
Active as of 2024-10-14 Computable Name: PatientFamilymembersGroup

Represents the patient and the family members being referenced as part of healthcare-related activity

Usage:

Formal Views of Profile Content

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

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..* Group Group of multiple entities
... type 1..1 code person | animal | practitioner | device | medication | substance
Required Pattern: person
... actual 1..1 boolean Descriptive or actual
Required Pattern: true
... Slices for member 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:IndexCase 1..1 BackboneElement Who or what is in group
..... entity 1..1 Reference(Patient) Reference to the group member
...... display 1..1 string Text alternative for the resource
Required Pattern: Index Patient
.... member:RelatedPatient S 0..1 BackboneElement Who or what is in group
..... entity 1..1 Reference(Patient) Reference to the group member
...... display 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
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
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Required Pattern: person
... Slices for member C 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
.... member:IndexCase C 1..1 BackboneElement Who or what is in group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient) Reference to the group member
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: Index Patient
.... member:RelatedPatient SC 0..1 BackboneElement Who or what is in group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient) Reference to the group member
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
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
... 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 Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... 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
... Slices for member C 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:All Slices Content/Rules for all slices
..... 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(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group
.... member:IndexCase C 1..1 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(Patient) Reference to the group member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: Index Patient
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group
.... member:RelatedPatient SC 0..1 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(Patient) Reference to the group member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.member:IndexCase.entity.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Group.member:RelatedPatient.entity.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.member

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..* Group Group of multiple entities
... type 1..1 code person | animal | practitioner | device | medication | substance
Required Pattern: person
... actual 1..1 boolean Descriptive or actual
Required Pattern: true
... Slices for member 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:IndexCase 1..1 BackboneElement Who or what is in group
..... entity 1..1 Reference(Patient) Reference to the group member
...... display 1..1 string Text alternative for the resource
Required Pattern: Index Patient
.... member:RelatedPatient S 0..1 BackboneElement Who or what is in group
..... entity 1..1 Reference(Patient) Reference to the group member
...... display 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
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
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Required Pattern: person
... Slices for member C 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
.... member:IndexCase C 1..1 BackboneElement Who or what is in group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient) Reference to the group member
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: Index Patient
.... member:RelatedPatient SC 0..1 BackboneElement Who or what is in group
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... entity 1..1 Reference(Patient) Reference to the group member
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
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
... 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 Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... 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
... Slices for member C 1..* BackboneElement Who or what is in group
Slice: Unordered, Open by value:entity.display
.... member:All Slices Content/Rules for all slices
..... 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(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group
.... member:IndexCase C 1..1 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(Patient) Reference to the group member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: Index Patient
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group
.... member:RelatedPatient SC 0..1 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(Patient) Reference to the group member
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Text alternative for the resource
Required Pattern: A Patient Who Is Related to the Index Patient
..... period 0..1 Period Period member belonged to the group
..... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.member:IndexCase.entity.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Group.member:RelatedPatient.entity.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.member

 

Other representations of profile: CSV, Excel, Schematron