Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview5 - ci-build

Vital Records FHIR Messaging (VRFM) IG, published by CDC NCHS. This guide is not an authorized publication; it is the continuous build for version 2.0.0-Preview5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nightingaleproject/vital_records_fhir_messaging_ig/ and changes regularly. See the Directory of published versions

Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 Messages
... 3 Artifacts Summary
.... 3.1 Acknowledgement Message
.... 3.2 Birth Report Message
.... 3.3 Birth Report Update Message
.... 3.4 Cause of Death Coding Message
.... 3.5 Cause Of Death Coding Update Message
.... 3.6 Coded Cause of Fetal Death Message
.... 3.7 Coded Cause of Fetal Death Update Message
.... 3.8 Death Record Alias Message
.... 3.9 Death Record Submission Message
.... 3.10 Death Record Update Message
.... 3.11 Demographics Coding Message
.... 3.12 Demographics Coding Update Message
.... 3.13 Extraction Error Message
.... 3.14 Fetal Death Report Message
.... 3.15 Fetal Death Report Message
.... 3.16 Industry Occupation Coding Message
.... 3.17 Industry Occupation Coding Update Message
.... 3.18 Status Message
.... 3.19 Acknowledgement Header
.... 3.20 Alias Header
.... 3.21 Cause of Death Coding Header
.... 3.22 Cause of Death Coding Update Header
.... 3.23 Demographics Coding Header
.... 3.24 Demographics Coding Update Header
.... 3.25 Extraction Error Header
.... 3.26 Industry Occupation Coding Header
.... 3.27 Industy Occupation Coding Update Header
.... 3.28 Message Update Header
.... 3.29 Status Header
.... 3.30 Submission Message Header
.... 3.31 Void Header
.... 3.32 Alias Message Parameters
.... 3.33 Message Parameters
.... 3.34 Status Message Parameters
.... 3.35 Void Message Parameters
.... 3.36 Outcome Profile
.... 3.37 MessageHeader URI Values
.... 3.38 Birth Record Identifier Child
.... 3.39 Certificate Available Values
.... 3.40 Fetal Death Record Identifier
.... 3.41 Local Coded Pregnancy Status
.... 3.42 Maternal Linkage Content Bundle
.... 3.43 Pregnancy Outcome Values
.... 3.44 Recent Pregnancy Parameters
.... 3.45 Maternal Linkage Request Message
.... 3.46 Maternal Linkage Submission Message
.... 3.47 Maternal Linkage Update Message
.... 3.48 Maternal Linkage Request Message Header
.... 3.49 Placeholder Profile for profile-based slicing
.... 3.50 Void Message (for mortality, birth, and fetal death)
.... 3.51 Acknowledgement MessageHeader URI Values
.... 3.52 Cause of Death Coding MessageHeader URI Values
.... 3.53 Cause of Death Coding Update MessageHeader URI Values
.... 3.54 Demographics Coding MessageHeader URI Values
.... 3.55 Demographics Coding Update MessageHeader URI Values
.... 3.56 ExtractionError MessageHeader URI Values
.... 3.57 Industry and Occupation MessageHeader URI Values
.... 3.58 Industry and Occupation Update MessageHeader URI Values
.... 3.59 Payload Version Identifier Values
.... 3.60 Request MessageHeader URI Values
.... 3.61 Status Codes Values
.... 3.62 Status MessageHeader URI Values
.... 3.63 Submission MessageHeader URI Values
.... 3.64 Update MessageHeader URI Values
.... 3.65 Void MessageHeader URI Values
.... 3.66 Local Observation Identifiers
.... 3.67 Payload Version Identifier Values
.... 3.68 Status Codes Values
.... 3.69 AcknowledgementHeader-Example1
.... 3.70 AcknowledgementHeader-Example2
.... 3.71 AcknowledgementMessage-Example1
.... 3.72 AcknowledgementMessage-Example2
.... 3.73 AliasHeader-Example1
.... 3.74 AliasParameters-Example1
.... 3.75 BirthRecordIdentifierChild-Example1
.... 3.76 BirthRecordIdentifierChild-Example2
.... 3.77 BirthRecordIdentifierChildNoCert-Example1
.... 3.78 BirthReportHeader-Example1
.... 3.79 BirthReportMessage-Example1
.... 3.80 BirthReportUpdateHeader-Example1
.... 3.81 BirthReportUpdateMessage-Example1
.... 3.82 CauseOfDeathCodingHeader-Example1
.... 3.83 CauseOfDeathCodingMessage-Example1
.... 3.84 CauseOfDeathCodingUpdateHeader-Example1
.... 3.85 CauseOfDeathCodingUpdateMessage1
.... 3.86 CodedCauseOfFetalDeathHeader-Example1
.... 3.87 CodedCauseOfFetalDeathMessage-Example1
.... 3.88 CodedCauseOfFetalDeathUpdateHeader-Example1
.... 3.89 CodedCauseOfFetalDeathUpdateMessage-Example1
.... 3.90 DeathRecordAliasMessage-Example1
.... 3.91 DeathRecordSubmissionHeaderExample1
.... 3.92 DeathRecordSubmissionMessage-Example1
.... 3.93 DemographicsCodingHeader-Example1
.... 3.94 DemographicsCodingMessage-Example1
.... 3.95 DemographicsCodingUpdateHeader-Example1
.... 3.96 DemographicsCodingUpdateMessage1
.... 3.97 DummyBundle
.... 3.98 DummyDeathBundle
.... 3.99 ExtractionErrorHeader-Example1
.... 3.100 ExtractionErrorMessage-Example1
.... 3.101 FetalDeathRecordIdentifier-Example1
.... 3.102 FetalDeathRecordIdentifier-Example2
.... 3.103 FetalDeathRecordIdentifierNoCert-Example3
.... 3.104 FetalDeathRecordIdentifierNoCert-Example4
.... 3.105 FetalDeathReportHeader-Example1
.... 3.106 FetalDeathReportMessage-Example1
.... 3.107 FetalDeathReportUpdateHeader-Example1
.... 3.108 FetalDeathReportUpdateMessage-Example1
.... 3.109 IndustryOccupationCodingHeader-Example1
.... 3.110 IndustryOccupationCodingMessage-Example1
.... 3.111 IndustryOccupationCodingUpdateHeader-Example1
.... 3.112 IndustryOccupationCodingUpdateMessage1
.... 3.113 MaternalLinkageBundle-Birth
.... 3.114 MaternalLinkageBundle-BirthNoCert
.... 3.115 MaternalLinkageBundle-BirthPendingCert
.... 3.116 MaternalLinkageBundle-EctopicPregnancy
.... 3.117 MaternalLinkageBundle-FetalDeathWithCertPending
.... 3.118 MaternalLinkageBundle-PluralBirthAndFetalDeathWithCert
.... 3.119 MaternalLinkageBundle-PluralBirthWithCert
.... 3.120 MaternalLinkageRequestHeaderExample1
.... 3.121 MaternalLinkageRequestMessage-Example1
.... 3.122 MaternalLinkageSubmissionHeaderExample1
.... 3.123 MaternalLinkageSubmissionMessage-Example1
.... 3.124 MaternalLinkageUpdateHeaderExample1
.... 3.125 MaternalLinkageUpdateMessage-Example1
.... 3.126 Outcome-Example1
.... 3.127 Outcome-Example2
.... 3.128 Parameters-Example1
.... 3.129 ParametersBirth-Example1
.... 3.130 ParametersDeathExample1
.... 3.131 ParametersFD-Example2
.... 3.132 ParametersLinkage-EctopicPregnancy
.... 3.133 ParametersLinkage-FetalDeathWithCertPending
.... 3.134 ParametersLinkage-LiveBirthWithCert
.... 3.135 ParametersLinkage-LiveBirthWithoutCert
.... 3.136 ParametersLinkage-LiveBirthWithPendingCert
.... 3.137 ParametersLinkage-PluralBirthAndFetalDeath
.... 3.138 ParametersLinkage-PluralBirthWithCert
.... 3.139 ParentalDemographicsCodingHeader-Example1
.... 3.140 ParentalDemographicsCodingMessage-Example1
.... 3.141 ParentalDemographicsCodingUpdateHeader-Example1
.... 3.142 ParentalDemographicsCodingUpdateMessage-Example1
.... 3.143 StatusHeader-Example1
.... 3.144 StatusMessage-Example1
.... 3.145 StatusParameters-Example1
.... 3.146 SubmissionHeader-Example1
.... 3.147 UpdateHeader-Example1
.... 3.148 UpdateMessage-Example1
.... 3.149 VoidHeader-Example1
.... 3.150 VoidMessage-Example1
.... 3.151 VoidParameters-Example1
... 4 Download Specification
... 5 Change Log
... 6 Appendices
... 7 June 2022 Testing Event Examples
... 8 Business Rules for Death Record Submissions
... 9 Business Rules for Birth Record Submissions
... 10 Business Rules for Maternal Linkages
... 11 NCHS FHIR Implementation Notes
... 12 Maternal Linkage Records for Mortality