WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: WHO Group

Official URL: http://fhir.org/guides/who/core/StructureDefinition/who-group Version: 0.3.0
Draft as of 2024-09-10 Computable Name: WHOGroup

WHO Group

Usage:

Formal Views of Profile Content

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

This structure is derived from CPGGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..* CPGGroup Group of multiple entities
... identifier S 1..* Identifier Unique id
.... use S 1..1 code usual | official | temp | secondary | old (If known)
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether this group's record is in active use
... member 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(WHO Patient) Reference to the group member

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* CPGGroup 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
... identifier SΣ 1..* Identifier Unique id
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... 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 SΣ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ 1..1 string Label for Group
... 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(WHO Patient) 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

PathConformanceValueSet / CodeURI
Group.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.typerequiredFixed Value: 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

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..* CPGGroup 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 SΣ 1..* Identifier Unique id
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active SΣ 1..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 SΣ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ 1..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
... 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(WHO Patient) 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

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.typerequiredFixed Value: 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

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 CPGGroup

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from CPGGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..* CPGGroup Group of multiple entities
... identifier S 1..* Identifier Unique id
.... use S 1..1 code usual | official | temp | secondary | old (If known)
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether this group's record is in active use
... member 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(WHO Patient) Reference to the group member

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* CPGGroup 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
... identifier SΣ 1..* Identifier Unique id
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... 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 SΣ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ 1..1 string Label for Group
... 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(WHO Patient) 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

PathConformanceValueSet / CodeURI
Group.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.typerequiredFixed Value: 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

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..* CPGGroup 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 SΣ 1..* Identifier Unique id
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active SΣ 1..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 SΣ 0..1 CodeableConcept Kind of Group members
Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ 1..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
... 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(WHO Patient) 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

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.typerequiredFixed Value: 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

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 CPGGroup

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron