Vital Records FHIR Messaging (VRFM) IG
2.0.0-Preview2 - 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-Preview2 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: Void Message Parameters

Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-VoidParameters Version: 2.0.0-Preview2
Draft as of 2024-10-07 Computable Name: VoidParameters

Parameters for a Void Message

Parameters included:

IJE Name Description **Parameter ** Encoding or Type
DSTATE State, U.S. Territory or Canadian Province of Death - code jurisdiction_id string(2) from JurisdictionVS
FILENO Certificate Number cert_no string(6)
DOD_YR Date of Death–Year death_year(allowed, but being phased out) string(4)
DOD_YR, DOB_YR, FDOB_YR Date of event–Year event_year (preferred) string(4)
AUXNO Auxiliary State file number state_auxiliary_id string(12)
N/A Block Count - Number of records to void starting at the certificate number specified by the 'cert_no' parameter block_count unsigned int

Usage:

Formal Views of Profile Content

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:jurisdiction_id 0..1 BackboneElement jurisdiction identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
..... resource 0..0
..... part 0..0
.... parameter:cert_no 0..1 BackboneElement FILENO death certificate number
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:death_year 0..1 BackboneElement DOD_YR death year
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:event_year 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:state_auxiliary_id 0..1 BackboneElement AUXNO state auxiliary identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] 1..1 string If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:payload_version_id 0..1 BackboneElement Payload version identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
..... resource 0..0
..... part 0..0
.... parameter:block_count 1..1 BackboneElement number of records to void
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:jurisdiction_id ΣC 0..1 BackboneElement jurisdiction identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
.... parameter:cert_no ΣC 0..1 BackboneElement FILENO death certificate number
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:death_year ΣC 0..1 BackboneElement DOD_YR death year
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:event_year ΣC 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:state_auxiliary_id ΣC 0..1 BackboneElement AUXNO state auxiliary identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:payload_version_id ΣC 0..1 BackboneElement Payload version identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
.... parameter:block_count ΣC 1..1 BackboneElement number of records to void
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... 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
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter: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
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:jurisdiction_id ΣC 0..1 BackboneElement jurisdiction identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
.... parameter:cert_no ΣC 0..1 BackboneElement FILENO death certificate number
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:death_year ΣC 0..1 BackboneElement DOD_YR death year
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:event_year ΣC 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:state_auxiliary_id ΣC 0..1 BackboneElement AUXNO state auxiliary identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:payload_version_id ΣC 0..1 BackboneElement Payload version identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
.... parameter:block_count ΣC 1..1 BackboneElement number of records to void
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG

This structure is derived from Parameters

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Prohibited: 21 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:jurisdiction_id 0..1 BackboneElement jurisdiction identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
..... resource 0..0
..... part 0..0
.... parameter:cert_no 0..1 BackboneElement FILENO death certificate number
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:death_year 0..1 BackboneElement DOD_YR death year
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:event_year 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:state_auxiliary_id 0..1 BackboneElement AUXNO state auxiliary identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] 1..1 string If parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:payload_version_id 0..1 BackboneElement Payload version identifier
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
..... resource 0..0
..... part 0..0
.... parameter:block_count 1..1 BackboneElement number of records to void
..... extension 0..0
..... name 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] 1..1 unsignedInt If parameter is a data type
..... resource 0..0
..... part 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:jurisdiction_id ΣC 0..1 BackboneElement jurisdiction identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
.... parameter:cert_no ΣC 0..1 BackboneElement FILENO death certificate number
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:death_year ΣC 0..1 BackboneElement DOD_YR death year
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:event_year ΣC 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:state_auxiliary_id ΣC 0..1 BackboneElement AUXNO state auxiliary identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:payload_version_id ΣC 0..1 BackboneElement Payload version identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
.... parameter:block_count ΣC 1..1 BackboneElement number of records to void
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... 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
... Slices for parameter ΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter: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
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:jurisdiction_id ΣC 0..1 BackboneElement jurisdiction identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: jurisdiction_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Value Set - Jurisdictions Vital Records (required)
.... parameter:cert_no ΣC 0..1 BackboneElement FILENO death certificate number
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: cert_no
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:death_year ΣC 0..1 BackboneElement DOD_YR death year
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: death_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:event_year ΣC 0..1 BackboneElement DOD_YR or DOB_YR or FDOD_YR event year
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: event_year
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type
.... parameter:state_auxiliary_id ΣC 0..1 BackboneElement AUXNO state auxiliary identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: state_auxiliary_id
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:payload_version_id ΣC 0..1 BackboneElement Payload version identifier
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: payload_version_id
..... value[x] ΣC 1..1 string If parameter is a data type
Binding: Payload Version Identifier Values (extensible)
.... parameter:block_count ΣC 1..1 BackboneElement number of records to void
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Required Pattern: block_count
..... value[x] ΣC 1..1 unsignedInt If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:jurisdiction_id.value[x]requiredValueSetJurisdictionVitalRecords
http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]extensiblePayloadVersionVS (a valid code from Payload Version Identifier Values)
http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs
from this IG

This structure is derived from Parameters

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Prohibited: 21 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter

 

Other representations of profile: CSV, Excel, Schematron