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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Message Parameters

Parameter set for most Messages. Parameters with all-caps names are defined as per the 2022 IJE specification.

Usages:

• Use this Profile: Birth Report Message, Birth Report Update Message, Cause of Death Coding Message, Cause Of Death Coding Update Message... Show 13 more, Coded Cause of Fetal Death Message, Coded Cause of Fetal Death Update Message, Death Record Submission Message, Death Record Update Message, Demographics Coding Message, Demographics Coding Update Message, Fetal Death Report Message, Fetal Death Report Message, Industry Occupation Coding Message, Industry Occupation Coding Update Message, Maternal Linkage Request Message, Maternal Linkage Submission Message and Maternal Linkage Update Message
• Refer to this Profile: Acknowledgement Header and Extraction Error Header
• Examples for this Profile: Parameters/Parameters-Example1, Parameters/ParametersBirth-Example1, Parameters/ParametersDeathExample1 and Parameters/ParametersFD-Example2

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	SΣ	0..1	id	Logical id of this artifact
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 Constraints: inv-1
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 Constraints: inv-1
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	1..1	BackboneElement	FILENO death certificate number Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(a valid code from Payload Version Identifier Values) http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:jurisdiction_id, Parameters.parameter:cert_no, Parameters.parameter:death_year, Parameters.parameter:event_year, Parameters.parameter:state_auxiliary_id, Parameters.parameter:payload_version_id	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters			Parameters
id	S	0..1	id	Logical id of this artifact
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		1..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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(a valid code from Payload Version Identifier Values) http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	SΣ	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	1..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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 Constraints: inv-1
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	1..1	BackboneElement	FILENO death certificate number Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(a valid code from Payload Version Identifier Values) http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:jurisdiction_id, Parameters.parameter:cert_no, Parameters.parameter:death_year, Parameters.parameter:event_year, Parameters.parameter:state_auxiliary_id, Parameters.parameter:payload_version_id	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 1 element
Prohibited: 18 elements

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	SΣ	0..1	id	Logical id of this artifact
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 Constraints: inv-1
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 Constraints: inv-1
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	1..1	BackboneElement	FILENO death certificate number Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(a valid code from Payload Version Identifier Values) http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:jurisdiction_id, Parameters.parameter:cert_no, Parameters.parameter:death_year, Parameters.parameter:event_year, Parameters.parameter:state_auxiliary_id, Parameters.parameter:payload_version_id	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters			Parameters
id	S	0..1	id	Logical id of this artifact
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		1..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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
id	SΣ	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	1..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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 Constraints: inv-1
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	1..1	BackboneElement	FILENO death certificate number Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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 Constraints: inv-1
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:jurisdiction_id.value[x]	required	ValueSetJurisdictionVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-jurisdiction-vr
Parameters.parameter:payload_version_id.value[x]	extensible	PayloadVersionVS(a valid code from Payload Version Identifier Values) http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/ValueSet/Payload-version-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:jurisdiction_id, Parameters.parameter:cert_no, Parameters.parameter:death_year, Parameters.parameter:event_year, Parameters.parameter:state_auxiliary_id, Parameters.parameter:payload_version_id	A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 3 elements(5 nested mandatory elements)
Must-Support: 1 element
Prohibited: 18 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