Example CRVS Implementation Guide
0.1.0 - ci-build

Resource Profile: Birth Notification Resource

Official URL: https://acsa.africa/std/StructureDefinition/BirthNotification Version: 0.1.0
Draft as of 2025-12-08 Computable Name: BirthNotification

A new base resource for capturing birth data in the CRVS realm.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... dateOfBirth 1..1 date Date of birth
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BirthNotification.language Base required All Languages 📍5.0.0 FHIR Std.
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... identifier 0..* Identifier Business identifiers for the notification
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... dateOfBirth 1..1 date Date of birth
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BirthNotification.language Base required All Languages 📍5.0.0 FHIR Std.
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... dateOfBirth 1..1 date Date of birth
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BirthNotification.language Base required All Languages 📍5.0.0 FHIR Std.
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

Differential View

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... identifier 0..* Identifier Business identifiers for the notification
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BirthNotification 0..* Resource Birth Notification Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... subject 0..1 Reference(Individual Person) Subject of the event (person the event happened to)
... eventDetail 0..1 string Free text note about the event
... dateOfBirth 1..1 date Date of birth
... placeOfBirth 0..1 BackboneElement place of birth of the person
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... biologicalMother 0..1 Reference(Individual Person) Biological Mother of the child
... biologicalFather 0..1 Reference(Individual Person) Biological Father of the child
... parties 0..1 Reference(Individual Person) Gardians, ... of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... ethnicity 0..1 Coding Ethnicity
... nationality 0..* Coding Nationalities
Binding: CountryValueSet (extensible)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BirthNotification.language Base required All Languages 📍5.0.0 FHIR Std.
BirthNotification.placeOfBirth.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
BirthNotification.sex Base required Sex Value Set 📦0.1.0 This IG
BirthNotification.nationality Base extensible Country ValueSet 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

 

​Other representations of profile: CSV, Excel, Schematron