Vital Records FHIR Messaging (VRFM) IG
3.0.0-Preview1 - 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 3.0.0-Preview1 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 BirthRecordIdentifierChild-ExtensiveExample1
.... 3.78 BirthRecordIdentifierChild-ExtensiveExample2
.... 3.79 BirthRecordIdentifierChildNoCert-Example1
.... 3.80 BirthReportHeader-Example1
.... 3.81 BirthReportMessage-Example1
.... 3.82 BirthReportUpdateHeader-Example1
.... 3.83 BirthReportUpdateMessage-Example1
.... 3.84 CauseOfDeathCodingHeader-Example1
.... 3.85 CauseOfDeathCodingMessage-Example1
.... 3.86 CauseOfDeathCodingUpdateHeader-Example1
.... 3.87 CauseOfDeathCodingUpdateMessage1
.... 3.88 CodedCauseOfFetalDeathHeader-Example1
.... 3.89 CodedCauseOfFetalDeathMessage-Example1
.... 3.90 CodedCauseOfFetalDeathUpdateHeader-Example1
.... 3.91 CodedCauseOfFetalDeathUpdateMessage-Example1
.... 3.92 DeathRecordAliasMessage-Example1
.... 3.93 DeathRecordSubmissionHeaderExample1
.... 3.94 DeathRecordSubmissionMessage-Example1
.... 3.95 DemographicsCodingHeader-Example1
.... 3.96 DemographicsCodingMessage-Example1
.... 3.97 DemographicsCodingUpdateHeader-Example1
.... 3.98 DemographicsCodingUpdateMessage1
.... 3.99 DummyBundle
.... 3.100 DummyDeathBundle
.... 3.101 ExtractionErrorHeader-Example1
.... 3.102 ExtractionErrorMessage-Example1
.... 3.103 FetalDeathRecordIdentifier-Example1
.... 3.104 FetalDeathRecordIdentifier-Example2
.... 3.105 FetalDeathRecordIdentifier-ExtensiveExample1
.... 3.106 FetalDeathRecordIdentifier-ExtesnvieExample2
.... 3.107 FetalDeathRecordIdentifierNoCert-Example3
.... 3.108 FetalDeathRecordIdentifierNoCert-Example4
.... 3.109 FetalDeathReportHeader-Example1
.... 3.110 FetalDeathReportMessage-Example1
.... 3.111 FetalDeathReportUpdateHeader-Example1
.... 3.112 FetalDeathReportUpdateMessage-Example1
.... 3.113 IndustryOccupationCodingHeader-Example1
.... 3.114 IndustryOccupationCodingMessage-Example1
.... 3.115 IndustryOccupationCodingUpdateHeader-Example1
.... 3.116 IndustryOccupationCodingUpdateMessage1
.... 3.117 MaternalLinkageBundle-Birth
.... 3.118 MaternalLinkageBundle-BirthNoCert
.... 3.119 MaternalLinkageBundle-BirthPendingCert
.... 3.120 MaternalLinkageBundle-EctopicPregnancy
.... 3.121 MaternalLinkageBundle-Extensive-PluralBirthAndFetalDeathWithCert
.... 3.122 MaternalLinkageBundle-FetalDeathWithCertPending
.... 3.123 MaternalLinkageBundle-PluralBirthAndFetalDeathWithCert
.... 3.124 MaternalLinkageBundle-PluralBirthWithCert
.... 3.125 MaternalLinkageRequestHeaderExample1
.... 3.126 MaternalLinkageRequestMessage-Example1
.... 3.127 MaternalLinkageSubmissionHeaderExample1
.... 3.128 MaternalLinkageSubmissionMessage-Example1
.... 3.129 MaternalLinkageUpdateHeaderExample1
.... 3.130 MaternalLinkageUpdateMessage-Example1
.... 3.131 Outcome-Example1
.... 3.132 Outcome-Example2
.... 3.133 Parameters-Example1
.... 3.134 ParametersBirth-Example1
.... 3.135 ParametersDeathExample1
.... 3.136 ParametersFD-Example2
.... 3.137 ParametersLinkage-EctopicPregnancy
.... 3.138 ParametersLinkage-Extensive-PluralBirthAndFetalDeath
.... 3.139 ParametersLinkage-FetalDeathWithCertPending
.... 3.140 ParametersLinkage-LiveBirthWithCert
.... 3.141 ParametersLinkage-LiveBirthWithoutCert
.... 3.142 ParametersLinkage-LiveBirthWithPendingCert
.... 3.143 ParametersLinkage-PluralBirthAndFetalDeath
.... 3.144 ParametersLinkage-PluralBirthWithCert
.... 3.145 ParentalDemographicsCodingHeader-Example1
.... 3.146 ParentalDemographicsCodingMessage-Example1
.... 3.147 ParentalDemographicsCodingUpdateHeader-Example1
.... 3.148 ParentalDemographicsCodingUpdateMessage-Example1
.... 3.149 StatusHeader-Example1
.... 3.150 StatusMessage-Example1
.... 3.151 StatusParameters-Example1
.... 3.152 SubmissionHeader-Example1
.... 3.153 UpdateHeader-Example1
.... 3.154 UpdateMessage-Example1
.... 3.155 VoidHeader-Example1
.... 3.156 VoidMessage-Example1
.... 3.157 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