VITAL-RECORDS-FHIR-MESSAGING\Alias Message Parameters

Vital Records FHIR Messaging (VRFM) IG, published by CDC NCHS. This guide is not an authorized publication; it is the continuous build for version 1.1.0 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: Alias Message Parameters

Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-AliasParameters				Version: 1.1.0
Draft as of 2024-03-04			Responsible: CDC NCHS	Computable Name: AliasParameters

Parameters for an Alias 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_yr	string(4)
GNAME	Alias: Decendent first/given name	alias_decedent_first_name	string
LNAME	Alias: Decendent last/sur name	alias_decedent_last_name	string
MNAME	Alias: Decendent middle name	alias_decedent_middle_name	string
SUFF	Alias: Decedemt name suffix	alias_decedent_name_suffix	string
FLNAME	Alias: Father last/sur name	alias_father_surname	string(6)
SSN	Alias: Decedent Social Security Number	alias_social_security_number	string

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_yr

string(4)

GNAME

Alias: Decendent first/given name

alias_decedent_first_name

string

LNAME

Alias: Decendent last/sur name

alias_decedent_last_name

string

MNAME

Alias: Decendent middle name

alias_decedent_middle_name

string

SUFF

Alias: Decedemt name suffix

alias_decedent_name_suffix

string

FLNAME

Alias: Father last/sur name

alias_father_surname

string(6)

SSN

Alias: Decedent Social Security Number

alias_social_security_number

string

Usage:

Use this Resource Profile: Death Record Alias Message
Refer to this Resource Profile: Alias Header
Examples for this Resource Profile: Parameters/AliasParameters-Example1

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Parameters

Name	Card.	Type	Description & Constraints
Parameters		Parameters
Slices for parameter	0..*	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: Jurisdictions Value Set (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: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:alias_decedent_first_name	0..1	BackboneElement	ALIAS: GNAME Decendent first name
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_decedent_first_name
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
parameter:alias_decedent_last_name	0..1	BackboneElement	ALIAS: LNAME Decedent last Name
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_decedent_last_name
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
parameter:alias_decedent_middle_name	0..1	BackboneElement	ALIAS: MNAME Decedent Middle Name
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_decedent_middle_name
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
parameter:alias_decedent_name_suffix	0..1	BackboneElement	ALIAS: SUFF Decedent Name Suffix
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_decedent_name_suffix
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
parameter:alias_father_surname	0..1	BackboneElement	ALIAS: FLNAME Father Surname
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_father_surname
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
parameter:alias_social_security_number	0..1	BackboneElement	ALIAS: SSN Social Security Number
extension	0..0
name	1..1	string	Name from the definition Required Pattern: alias_social_security_number
value[x]	1..1	string	If parameter is a data type
resource	0..0
part	0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	JurisdictionVS `http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs`

Name	Flags	Card.	Type	Description & Constraints
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	0..*	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: Jurisdictions Value Set (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: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:alias_decedent_first_name	ΣC	0..1	BackboneElement	ALIAS: GNAME Decendent first name 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: alias_decedent_first_name
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:alias_decedent_last_name	ΣC	0..1	BackboneElement	ALIAS: LNAME Decedent last Name 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: alias_decedent_last_name
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:alias_decedent_middle_name	ΣC	0..1	BackboneElement	ALIAS: MNAME Decedent Middle Name 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: alias_decedent_middle_name
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:alias_decedent_name_suffix	ΣC	0..1	BackboneElement	ALIAS: SUFF Decedent Name Suffix 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: alias_decedent_name_suffix
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:alias_father_surname	ΣC	0..1	BackboneElement	ALIAS: FLNAME Father Surname 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: alias_father_surname
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:alias_social_security_number	ΣC	0..1	BackboneElement	ALIAS: SSN Social Security 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: alias_social_security_number
value[x]	ΣC	1..1	string	If parameter is a data type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.parameter:jurisdiction_id.value[x]	required	JurisdictionVS `http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs`