Example CRVS Implementation Guide
0.1.0 - ci-build
| Active as of 2025-03-28 |
Definitions for the BirthNotification resource profile.
Guidance on how to interpret the contents of this table can be found here
| 0. BirthNotification | |
| Definition | A new base resource for capturing birth data in the CRVS realm. This is the base resource type for everything. |
| Short | Birth Notification ResourceBase Resource |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| 2. BirthNotification.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. BirthNotification.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. BirthNotification.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. BirthNotification.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. BirthNotification.dateOfBirth | |
| Definition | Date of birth |
| Short | Date of birth |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. BirthNotification.placeOfBirth[x] | |
| Definition | Country of birth of the person |
| Short | Country of birth of the person |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CountryValueSet (extensible to http://hl7.org/fhir/ValueSet/country) |
| Type | Choice of: Coding, Address, Reference(Location) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 14. BirthNotification.mother | |
| Definition | Mother of the child |
| Short | Mother of the child |
| Control | 1..1 |
| Type | Reference(Individual Person) |
| 16. BirthNotification.father | |
| Definition | Father of the child |
| Short | Father of the child |
| Control | 0..1 |
| Type | Reference(Individual Person) |
| 18. BirthNotification.name | |
| Definition | Name of the child |
| Short | Name of the child |
| Control | 0..1 |
| Type | HumanName |
| 20. BirthNotification.sex | |
| Definition | Sex of the child |
| Short | Sex of the child |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Sex Value Set (required to http://acsa.afrika/standard/ValueSet/sex) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. BirthNotification.specialMark | |
| Definition | Special mark or note about the birth |
| Short | Special mark or note about the birth |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. BirthNotification.weightAtBirth | |
| Definition | Weight at birth |
| Short | Weight at birth |
| Control | 0..1 |
| Type | Quantity |
Guidance on how to interpret the contents of this table can be found here
| 0. BirthNotification | |
| Definition | A new base resource for capturing birth data in the CRVS realm. |
| Short | Birth Notification Resource |
| 2. BirthNotification.dateOfBirth | |
| Definition | Date of birth |
| Short | Date of birth |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. BirthNotification.placeOfBirth[x] | |
| Definition | Country of birth of the person |
| Short | Country of birth of the person |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CountryValueSet (extensible to http://hl7.org/fhir/ValueSet/country) |
| Type | Choice of: Coding, Address, Reference(Location) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 6. BirthNotification.mother | |
| Definition | Mother of the child |
| Short | Mother of the child |
| Control | 1..1 |
| Type | Reference(Individual Person) |
| 8. BirthNotification.father | |
| Definition | Father of the child |
| Short | Father of the child |
| Control | 0..1 |
| Type | Reference(Individual Person) |
| 10. BirthNotification.name | |
| Definition | Name of the child |
| Short | Name of the child |
| Control | 0..1 |
| Type | HumanName |
| 12. BirthNotification.sex | |
| Definition | Sex of the child |
| Short | Sex of the child |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Sex Value Set (required to http://acsa.afrika/standard/ValueSet/sex) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. BirthNotification.specialMark | |
| Definition | Special mark or note about the birth |
| Short | Special mark or note about the birth |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BirthNotification.weightAtBirth | |
| Definition | Weight at birth |
| Short | Weight at birth |
| Control | 0..1 |
| Type | Quantity |
Guidance on how to interpret the contents of this table can be found here
| 0. BirthNotification | |
| Definition | A new base resource for capturing birth data in the CRVS realm. |
| Short | Birth Notification Resource |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| 2. BirthNotification.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. BirthNotification.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. BirthNotification.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. BirthNotification.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. BirthNotification.dateOfBirth | |
| Definition | Date of birth |
| Short | Date of birth |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. BirthNotification.placeOfBirth[x] | |
| Definition | Country of birth of the person |
| Short | Country of birth of the person |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from CountryValueSet (extensible to http://hl7.org/fhir/ValueSet/country) |
| Type | Choice of: Coding, Address, Reference(Location) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 14. BirthNotification.mother | |
| Definition | Mother of the child |
| Short | Mother of the child |
| Control | 1..1 |
| Type | Reference(Individual Person) |
| 16. BirthNotification.father | |
| Definition | Father of the child |
| Short | Father of the child |
| Control | 0..1 |
| Type | Reference(Individual Person) |
| 18. BirthNotification.name | |
| Definition | Name of the child |
| Short | Name of the child |
| Control | 0..1 |
| Type | HumanName |
| 20. BirthNotification.sex | |
| Definition | Sex of the child |
| Short | Sex of the child |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Sex Value Set (required to http://acsa.afrika/standard/ValueSet/sex) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. BirthNotification.specialMark | |
| Definition | Special mark or note about the birth |
| Short | Special mark or note about the birth |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. BirthNotification.weightAtBirth | |
| Definition | Weight at birth |
| Short | Weight at birth |
| Control | 0..1 |
| Type | Quantity |