Vital Records FHIR Messaging (VRFM) IG
2.0.0 - release

Vital Records FHIR Messaging (VRFM) IG - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

### Message Profiles

Message Profiles

Acknowledgement Message | Acknowledgement Message
Birth Report Message | Message for reporting birth records
Birth Report Update Message | Message for updating birth records
Cause of Death Coding Message | Message for cause of death coding response to death records
Cause Of Death Coding Update Message | Message for updating Cause Of Death coding response to death records
Coded Cause of Fetal Death Message | Message for reporting coded cause of fetal death
Coded Cause of Fetal Death Update Message | Message for updating coded cause of fetal death
Death Record Alias Message | Message for aliasing death records
Death Record Submission Message | Message for submitting death records
Death Record Update Message | Message for updating death records
Demographics Coding Message | Message for demographics coding response to death records
Demographics Coding Update Message | Message for updating Demographics coding response to death records
Extraction Error Message | Message for Errors during content extraction
Fetal Death Report Message | Message for reporting fetal death records
Fetal Death Report Message | Message for updating fetal death records
Industry Occupation Coding Message | Message for industry occupation coding response to death records
Industry Occupation Coding Update Message | Message for updating industry occupation coding response to death records
Status Message | Message for sending status of DeathRecord processing

### Message Header Profiles

Message Header Profiles

Acknowledgement Header | Acknowledgement Header
Alias Header | Alias Header
Cause of Death Coding Header | Cause of Death Coding Header
Cause of Death Coding Update Header | Cause of Death Coding Update Header
Demographics Coding Header | Demographics Coding Header
Demographics Coding Update Header | Demographics Coding Update Header
Extraction Error Header | Extraction Error Message Header
Industry Occupation Coding Header | Industry Occupation Coding Header
Industy Occupation Coding Update Header | Industry Occupation Coding Update Header
Message Update Header | Message Update Header
Status Header | Status Header
Submission Message Header | Message Submission Header
Void Header | Void Header for all submission types

### Message Parameter Profiles

Message Parameter Profiles

Alias Message Parameters | Parameters for an Alias Message
Message Parameters | Parameter set for most Messages. Parameters with all-caps names are defined as per the 2022 IJE specification.
Status Message Parameters | Parameters for a Status Message
Void Message Parameters | Parameters for a Void Message

### Outcome Profiles

Outcome Profile | Outcome profile to support profile-based slicing of bundles

### Codesystems

Codesystems

MessageHeader URI Values | MessageHeader URI Values

### Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Placeholder Profile for profile-based slicing | Placeholder for profile-based slicing
Void Message (for mortality, birth, and fetal death) | Message for voiding mortality, birth, and fetal death records.

### Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Acknowledgement MessageHeader URI Values | Acknowledgement MessageHeader URI Values
Cause of Death Coding MessageHeader URI Values | Cause of Death Coding MessageHeader URI Values
Cause of Death Coding Update MessageHeader URI Values | Cause of Death Coding Update MessageHeader URI Values
Demographics Coding MessageHeader URI Values | Demographics Coding MessageHeader URI Values
Demographics Coding Update MessageHeader URI Values | Demographics Coding Update MessageHeader URI Values
ExtractionError MessageHeader URI Values | ExtractionError MessageHeader URI Values
Industry and Occupation MessageHeader URI Values | Industry and Occupation MessageHeader URI Values
Industry and Occupation Update MessageHeader URI Values | Industry and Occupation Update MessageHeader URI Values
Payload Version Identifier Values | Payload Version Identifier Values
Status Codes Values | Status Codes Values
Status MessageHeader URI Values | Status MessageHeader URI Values
Submission MessageHeader URI Values | Submission MessageHeader URI Values
Update MessageHeader URI Values | Update MessageHeader URI Values
Void MessageHeader URI Values | Void MessageHeader URI Values

### Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Payload Version Identifier Values | Codesystem for Payload Version Identifier Values. Only versions that are in production use are listed.
Status Codes Values | Status Codes Values

### Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AcknowledgementHeader-Example1 | Acknowledgement Header: Example
AcknowledgementHeader-Example2 | Acknowledgement Header: Example with warnings
AcknowledgementMessage-Example1 | Acknowledgement message - Example
AcknowledgementMessage-Example2 | Acknowledgement message with warnings- Example
AliasHeader-Example1 | Alias Message Header- Example
AliasParameters-Example1 | Alias Message Parameters- Example
BirthReportHeader-Example1 | Header for Birth Report Message - Example
BirthReportMessage-Example1 | Live Birth Report Message - Example
BirthReportUpdateHeader-Example1 | Header for Birth Report Message Update - Example
BirthReportUpdateMessage-Example1 | Live Birth Report Message Update - Example
CauseOfDeathCodingHeader-Example1 | Header for Cause of Death Coding Message - Example1- coded content only
CauseOfDeathCodingMessage-Example1 | Cause of death coding message - Example1 – coded content only
CauseOfDeathCodingUpdateHeader-Example1 | Header for Cause Of Death Coding Update Message - Example
CauseOfDeathCodingUpdateMessage1 | Cause of Death Coding update message - Example
CodedCauseOfFetalDeathHeader-Example1 | Header for Coded Cause of Fetal Death Message - Example
CodedCauseOfFetalDeathMessage-Example1 | Coded Cause of Fetal Death Message - Example
CodedCauseOfFetalDeathUpdateHeader-Example1 | Header for Coded Cause of Fetal Death Message Update - Example
CodedCauseOfFetalDeathUpdateMessage-Example1 | Coded Cause of Fetal Death Message Update - Example
DeathRecordAliasMessage-Example1 | Alias Message - Example
DeathRecordSubmissionHeaderExample1 | Header for Death Record Submission - Example
DeathRecordSubmissionMessage-Example1 | Submission mesage - Example
DemographicsCodingHeader-Example1 | Header for Demographic Coding Message - Example
DemographicsCodingMessage-Example1 | Cause of death coding message - Example1 – coded content only
DemographicsCodingUpdateHeader-Example1 | Header for Demographic Coding Update Message - Example
DemographicsCodingUpdateMessage1 | Demographic Coding update message - Example
DummyBundle | Placeholder for all content sent in messages
DummyDeathBundle | Placeholder for death record
ExtractionErrorHeader-Example1 | Header for Extraction Error Message - Example
ExtractionErrorMessage-Example1 | Extraction error message - Example
FetalDeathReportHeader-Example1 | Header for Fetal Death Report Message - Example
FetalDeathReportMessage-Example1 | Fetal Death Report Message - Example
FetalDeathReportUpdateHeader-Example1 | Header for Fetal Death Report Message Update - Example
FetalDeathReportUpdateMessage-Example1 | Fetal Death Report Message Update - Example
IndustryOccupationCodingHeader-Example1 | Header for Industry Occupation Coding Message - Example
IndustryOccupationCodingMessage-Example1 | Industry Occupation coding message - Example1 – coded content only
IndustryOccupationCodingUpdateHeader-Example1 | Header for Industry Occupation Coding Update Message - Example
IndustryOccupationCodingUpdateMessage1 | Industry Occupation Coding update message - Example
Outcome-Example1 | Extraction Error Outcome - Example
Outcome-Example2 | Extraction Warning Outcome - Example
Parameters-Example1 | Parameters for Submission: Example
ParametersBirth-Example1 | Parameters for Submission: Example
ParametersDeathExample1 | Parameters for Submission: Example
ParametersFD-Example2 | Parameters for Submission: Example
ParentalDemographicsCodingHeader-Example1 | Header for Parental Demographics Message - Example
ParentalDemographicsCodingMessage-Example1 | Parental Demographics Message - Example
ParentalDemographicsCodingUpdateHeader-Example1 | Header for Parental Demographics Message Update - Example
ParentalDemographicsCodingUpdateMessage-Example1 | Parental Demographics Message Update - Example
StatusHeader-Example1 | Parameters for Status: Example1
StatusMessage-Example1 | Status message - Example1
StatusParameters-Example1 | Parameters for Status: Example
SubmissionHeader-Example1 | Header for Submission - Example
UpdateHeader-Example1 | Header for Update: Example
UpdateMessage-Example1 | Update message - example
VoidHeader-Example1 | Parameters for Void: Example
VoidMessage-Example1 | Void message - example
VoidParameters-Example1 | Parameters for Void: Example