Example CRVS Implementation Guide
0.1.0 - ci-build

Resource Profile: Birth Declaration Resource

Official URL: http://acsa.africa/standard/StructureDefinition/BirthDeclaration Version: 0.1.0
Active as of 2025-03-28 Computable Name: BirthDeclaration

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

Usage:

  • This Resource is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter

ele-1: All FHIR elements must have a @value or children
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BirthDeclaration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... 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
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BirthDeclaration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter

ele-1: All FHIR elements must have a @value or children
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BirthDeclaration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BirthDeclaration 0..* Resource Birth Declaration Resource
... 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
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... specialMark 0..1 string Special mark or note about the birth
... weightAtBirth 0..1 Quantity Weight at birth
... identifier 0..* Identifier Identifiers of the Registered birth
... active 0..1 boolean is the resource active
... subject 0..1 Reference(Individual Person) Subject that was born
... nationality 0..1 Coding Nationality of the child
Binding: CountryValueSet (extensible)
... placeOfRegistration[x] 1..1 place where this registration was officially created
.... placeOfRegistrationAddress Address
.... placeOfRegistrationReference Reference(Location)
... dateOfRegistration 1..1 date date when this registration was officially created
... officer 1..1 Reference(Practitioner) Officer who registered the birth
... birthNotification 0..1 Reference(Birth Notification Resource) link toward the birth notification
... statistic 0..1 BirthStatisticBackbone Mother's occupation details

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BirthDeclaration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
BirthDeclaration.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
BirthDeclaration.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
BirthDeclaration.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

 

Other representations of profile: CSV, Excel, Schematron