Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview4 - 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-Preview4 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

Resource Profile: Extraction Error Header

Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-ExtractionErrorHeader Version: 2.0.0-Preview4
Draft as of 2024-11-04 Computable Name: ExtractionErrorHeader

Extraction Error Message Header

The ExtractionError Message’s MessageHeader.response.identifier must equal the value of the MessageHeader.id property of the message on which errors are being reported. When processing acknowledgements this identifier must be used to associate the extraction errors with the message that is being acknowledged. This association is the basis for implementing reliable messaging.

The MessageHeader.eventURI should be set as follows:

  • Death: http://nchs.cdc.gov/vrdr_extraction_error
  • Fetal Death: http://nchs.cdc.gov/fd_extraction_error
  • Birth: http://nchs.cdc.gov/birth_extraction_error

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id 1..1 id Logical id of this artifact
... Slices for event[x] 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventUri 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination 1..* BackboneElement Message destination application(s)
.... identifier 1..1 id The value of the MessageHeader.id for the message with errors
.... code 1..1 code ok | transient-error | fatal-error
Fixed Value: fatal-error
.... details 1..1 Reference(Outcome Profile) Specific list of hints/warnings/errors
... focus 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual destination address or id
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... 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
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... 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
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... 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
.... identifier Σ 1..1 id The value of the MessageHeader.id for the message with errors
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.


Fixed Value: fatal-error
.... details Σ 1..1 Reference(Outcome Profile) Specific list of hints/warnings/errors
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredFixed Value: fatal-error
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id 1..1 id Logical id of this artifact
... Slices for event[x] 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventUri 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination 1..* BackboneElement Message destination application(s)
.... identifier 1..1 id The value of the MessageHeader.id for the message with errors
.... code 1..1 code ok | transient-error | fatal-error
Fixed Value: fatal-error
.... details 1..1 Reference(Outcome Profile) Specific list of hints/warnings/errors
... focus 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual destination address or id
... source Σ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader A resource that describes a message that is exchanged between systems
... id Σ 1..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 uri Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri Σ 1..1 uri Code for the event this message represents or link to event definition
Binding: ExtractionError MessageHeader URI Values (required)
... destination Σ 1..* BackboneElement Message destination application(s)
.... 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
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... 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
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ 0..1 BackboneElement If this is a reply to prior message
.... 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
.... identifier Σ 1..1 id The value of the MessageHeader.id for the message with errors
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.


Fixed Value: fatal-error
.... details Σ 1..1 Reference(Outcome Profile) Specific list of hints/warnings/errors
... focus Σ 1..2 Reference(Message Parameters) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventUrirequiredExtractionErrorHeaderURIVS
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/VRM-ExtractionErrorHeaderURI-vs
from this IG
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredFixed Value: fatal-error
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements(1 nested mandatory element)
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

 

Other representations of profile: CSV, Excel, Schematron