Birth And Fetal Death (BFDR) - STU2-ballot
2.0.0-ballot - ballot
Birth And Fetal Death (BFDR) - STU2-ballot
2.0.0-ballot - ballot
This page is part of the Vital Records Birth and Fetal Death Reporting (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Composition-coded-race-and-ethnicity | Version: 2.0.0-ballot | |||
| Draft as of 2023-12-18 | Computable Name: CompositionCodedRaceAndEthnicity | |||
This Composition profile communicates coded race and ethnicity information to the appropriate jurisdictional Vital Records Office, along with the submitted input race and ethnicity information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | Composition | |||
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |
  type | 1..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
 subject | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about | |
| author | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | |
 Slices for section | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code | |
 section:mother | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report | |
  code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
 Slices for entry | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() | |
 entry:motherPatient | 0..1 | Reference(Patient - Mother Vital Records) | Mother | |
| entry:inputRaceAndEthnicity | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | |
 entry:codedRaceAndEthnicity | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | |
 section:father | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report | |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Slices for entry | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() | |
| entry:fatherPatient | 0..1 | Reference(Related Person - Parent Vital Records) | Father | |
| entry:inputRaceAndEthnicity | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | |
| entry:codedRaceAndEthnicity | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
 type | Σ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
| subject | Σ | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
| title | Σ | 1..1 | string | Human Readable name/title |
| Slices for section | C | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:mother | C | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() |
| entry:motherPatient | C | 0..1 | Reference(Patient - Mother Vital Records) | Mother |
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity |
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity |
| section:father | C | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() |
| entry:fatherPatient | C | 0..1 | Reference(Related Person - Parent Vital Records) | Father |
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity |
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | Pattern: LOINC code 86805-9 |
| Composition.section:mother.code | example | Pattern: MTH |
| Composition.section:father.code | example | Pattern: NFTH |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |||||
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| 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 | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
 target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| 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 | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code | ||||
| section: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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:mother | C | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report | ||||
| 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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() | ||||
| entry:motherPatient | C | 0..1 | Reference(Patient - Mother Vital Records) | Mother | ||||
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | ||||
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
 section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:father | C | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report | ||||
| 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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() | ||||
| entry:fatherPatient | C | 0..1 | Reference(Related Person - Parent Vital Records) | Father | ||||
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | ||||
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | Pattern: LOINC code 86805-9 | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:mother.code | example | Pattern: MTH | ||||
| Composition.section:mother.mode | required | ListMode | ||||
| Composition.section:mother.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:mother.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:father.code | example | Pattern: NFTH | ||||
| Composition.section:father.mode | required | ListMode | ||||
| Composition.section:father.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:father.emptyReason | preferred | ListEmptyReasons |
This structure is derived from Composition
Summary
Mandatory: 1 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | Composition | |||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |
| type | 1..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
| subject | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about | |
| author | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | |
| Slices for section | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code | |
| section:mother | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report | |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| Slices for entry | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() | |
| entry:motherPatient | 0..1 | Reference(Patient - Mother Vital Records) | Mother | |
| entry:inputRaceAndEthnicity | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | |
| entry:codedRaceAndEthnicity | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | |
| section:father | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report | |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Slices for entry | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() | |
| entry:fatherPatient | 0..1 | Reference(Related Person - Parent Vital Records) | Father | |
| entry:inputRaceAndEthnicity | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | |
| entry:codedRaceAndEthnicity | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type | Σ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
| subject | Σ | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
| title | Σ | 1..1 | string | Human Readable name/title |
| Slices for section | C | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code |
| section:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:mother | C | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() |
| entry:motherPatient | C | 0..1 | Reference(Patient - Mother Vital Records) | Mother |
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity |
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity |
| section:father | C | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() |
| entry:fatherPatient | C | 0..1 | Reference(Related Person - Parent Vital Records) | Father |
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity |
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | Pattern: LOINC code 86805-9 |
| Composition.section:mother.code | example | Pattern: MTH |
| Composition.section:father.code | example | Pattern: NFTH |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| fetalDeathReportNumber | 0..1 | Identifier | Extension - Fetal Death Report Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | |||||
| liveBirthCertificateNumber | 0..1 | Identifier | Extension - Live Birth Certificate Number URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type | Σ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject | Σ | 0..1 | Reference(Patient - Child Vital Records | Patient - Decedent Fetus) | Who and/or what the composition is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date | Σ | 1..1 | dateTime | Composition editing time | ||||
| author | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | ||||
| title | Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
| 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 | ||||
| mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time | 0..1 | dateTime | When the composition was attested | |||||
| party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
| 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] | 1..1 | Target of the relationship | ||||||
| targetIdentifier | Identifier | |||||||
| targetReference | Reference(Composition) | |||||||
| event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| 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 | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| period | Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section | C | 1..2 | BackboneElement | The Composition is broken into sections, where each section includes the input and output race and ethnicity for one individual. Slice: Unordered, Open by pattern:code | ||||
| section: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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry | C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:mother | C | 0..1 | BackboneElement | mother Section on the Race and Ethnicity - Mother Report | ||||
| 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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MTH | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the mother Section Slice: Unordered, Open by profile:$this.resolve() | ||||
| entry:motherPatient | C | 0..1 | Reference(Patient - Mother Vital Records) | Mother | ||||
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | ||||
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| section:father | C | 0..1 | BackboneElement | father Section on the Race and Ethnicity - Father Report | ||||
| 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 | ||||
| title | 0..1 | string | Label for section (e.g. for ToC) | |||||
| code | 1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NFTH | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
| mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| Slices for entry | C | 0..* | Reference(Resource) | Entries that are contained in the father Section Slice: Unordered, Open by profile:$this.resolve() | ||||
| entry:fatherPatient | C | 0..1 | Reference(Related Person - Parent Vital Records) | Father | ||||
| entry:inputRaceAndEthnicity | C | 0..1 | Reference(Observation - Input Race and Ethnicity Vital Records) | Input Race And Ethnicity | ||||
| entry:codedRaceAndEthnicity | C | 0..1 | Reference(Observation - Coded Race and Ethnicity Vital Records) | Coded Race And Ethnicity | ||||
| emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section | C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Composition.language | preferred | CommonLanguages
| ||||
| Composition.status | required | CompositionStatus | ||||
| Composition.type | preferred | Pattern: LOINC code 86805-9 | ||||
| Composition.category | example | DocumentClassValueSet | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
| Composition.attester.mode | required | CompositionAttestationMode | ||||
| Composition.relatesTo.code | required | DocumentRelationshipType | ||||
| Composition.event.code | example | ActCode | ||||
| Composition.section.code | example | DocumentSectionCodes | ||||
| Composition.section.mode | required | ListMode | ||||
| Composition.section.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:mother.code | example | Pattern: MTH | ||||
| Composition.section:mother.mode | required | ListMode | ||||
| Composition.section:mother.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:mother.emptyReason | preferred | ListEmptyReasons | ||||
| Composition.section:father.code | example | Pattern: NFTH | ||||
| Composition.section:father.mode | required | ListMode | ||||
| Composition.section:father.orderedBy | preferred | ListOrderCodes | ||||
| Composition.section:father.emptyReason | preferred | ListEmptyReasons |
This structure is derived from Composition
Summary
Mandatory: 1 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Public Health. Package hl7.fhir.us.bfdr#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change