This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v2.2.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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

Resource Profile: Coding Status Values

Coding Status Values contains various status flags that result from the coding process

Usage:

• Use this Resource Profile: Cause of Death Coded Content Bundle
• Refer to this Resource Profile: Death Certificate
• Examples for this Resource Profile: Parameters/CodingStatusValues-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	Flags	Card.	Type	Description & Constraints
Parameters			Parameters
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:shipmentNumber		0..1	BackboneElement	shipment number
extension		0..0
name		1..1	string	Name from the definition Required Pattern: shipmentNumber
value[x]		1..1	string	If parameter is a data type
resource		0..0
part		0..0
parameter:receiptDate		0..1	BackboneElement	receipt date
extension		0..0
name		1..1	string	Name from the definition Required Pattern: receiptDate
value[x]		1..1	date	If parameter is a data type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
resource		0..0
part		0..0
parameter:coderStatus		0..1	BackboneElement	coder status
extension		0..0
name		1..1	string	Name from the definition Required Pattern: coderStatus
value[x]		1..1	integer	If parameter is a data type
resource		0..0
part		0..0
parameter:intentionalReject		0..1	BackboneElement	Intentional reject
extension		0..0
name		1..1	string	Name from the definition Required Pattern: intentionalReject
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
resource		0..0
part		0..0
parameter:acmeSystemReject		0..1	BackboneElement	ACME System Reject
extension		0..0
name		1..1	string	Name from the definition Required Pattern: acmeSystemReject
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
resource		0..0
part		0..0
parameter:transaxConversion		0..1	BackboneElement	ALIAS: Transax Conversion
extension		0..0
name		1..1	string	Name from the definition Required Pattern: transaxConversion
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
resource		0..0
part		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

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
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:shipmentNumber	ΣC	0..1	BackboneElement	shipment number
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: shipmentNumber
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:receiptDate	ΣC	0..1	BackboneElement	receipt date
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: receiptDate
value[x]	ΣC	1..1	date	If parameter is a data type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
parameter:coderStatus	ΣC	0..1	BackboneElement	coder status
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: coderStatus
value[x]	ΣC	1..1	integer	If parameter is a data type
parameter:intentionalReject	ΣC	0..1	BackboneElement	Intentional reject
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: intentionalReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
parameter:acmeSystemReject	ΣC	0..1	BackboneElement	ACME System Reject
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: acmeSystemReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
parameter:transaxConversion	ΣC	0..1	BackboneElement	ALIAS: Transax Conversion
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: transaxConversion
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

Name	Flags	Card.	Type	Description & Constraints
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
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	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
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:shipmentNumber	ΣC	0..1	BackboneElement	shipment number
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: shipmentNumber
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:receiptDate	ΣC	0..1	BackboneElement	receipt date
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: receiptDate
value[x]	ΣC	1..1	date	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
value		0..1	date	Primitive value for date
parameter:coderStatus	ΣC	0..1	BackboneElement	coder status
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: coderStatus
value[x]	ΣC	1..1	integer	If parameter is a data type
parameter:intentionalReject	ΣC	0..1	BackboneElement	Intentional reject
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: intentionalReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
parameter:acmeSystemReject	ΣC	0..1	BackboneElement	ACME System Reject
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: acmeSystemReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
parameter:transaxConversion	ΣC	0..1	BackboneElement	ALIAS: Transax Conversion
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: transaxConversion
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

This structure is derived from Parameters

Summary

Mandatory: 0 element (6 nested mandatory elements)
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters			Parameters
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:shipmentNumber		0..1	BackboneElement	shipment number
extension		0..0
name		1..1	string	Name from the definition Required Pattern: shipmentNumber
value[x]		1..1	string	If parameter is a data type
resource		0..0
part		0..0
parameter:receiptDate		0..1	BackboneElement	receipt date
extension		0..0
name		1..1	string	Name from the definition Required Pattern: receiptDate
value[x]		1..1	date	If parameter is a data type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
resource		0..0
part		0..0
parameter:coderStatus		0..1	BackboneElement	coder status
extension		0..0
name		1..1	string	Name from the definition Required Pattern: coderStatus
value[x]		1..1	integer	If parameter is a data type
resource		0..0
part		0..0
parameter:intentionalReject		0..1	BackboneElement	Intentional reject
extension		0..0
name		1..1	string	Name from the definition Required Pattern: intentionalReject
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
resource		0..0
part		0..0
parameter:acmeSystemReject		0..1	BackboneElement	ACME System Reject
extension		0..0
name		1..1	string	Name from the definition Required Pattern: acmeSystemReject
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
resource		0..0
part		0..0
parameter:transaxConversion		0..1	BackboneElement	ALIAS: Transax Conversion
extension		0..0
name		1..1	string	Name from the definition Required Pattern: transaxConversion
value[x]		1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
resource		0..0
part		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

Key Elements View

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
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:shipmentNumber	ΣC	0..1	BackboneElement	shipment number
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: shipmentNumber
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:receiptDate	ΣC	0..1	BackboneElement	receipt date
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: receiptDate
value[x]	ΣC	1..1	date	If parameter is a data type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
parameter:coderStatus	ΣC	0..1	BackboneElement	coder status
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: coderStatus
value[x]	ΣC	1..1	integer	If parameter is a data type
parameter:intentionalReject	ΣC	0..1	BackboneElement	Intentional reject
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: intentionalReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
parameter:acmeSystemReject	ΣC	0..1	BackboneElement	ACME System Reject
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: acmeSystemReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
parameter:transaxConversion	ΣC	0..1	BackboneElement	ALIAS: Transax Conversion
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Required Pattern: transaxConversion
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
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	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
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:shipmentNumber	ΣC	0..1	BackboneElement	shipment number
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: shipmentNumber
value[x]	ΣC	1..1	string	If parameter is a data type
parameter:receiptDate	ΣC	0..1	BackboneElement	receipt date
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: receiptDate
value[x]	ΣC	1..1	date	If parameter is a data type
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
partialDate		0..1	(Complex)	Partial Date URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
value		0..1	date	Primitive value for date
parameter:coderStatus	ΣC	0..1	BackboneElement	coder status
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: coderStatus
value[x]	ΣC	1..1	integer	If parameter is a data type
parameter:intentionalReject	ΣC	0..1	BackboneElement	Intentional reject
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: intentionalReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Intentional Reject ValueSet (required)
parameter:acmeSystemReject	ΣC	0..1	BackboneElement	ACME System Reject
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: acmeSystemReject
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: System Reject ValueSet (required)
parameter:transaxConversion	ΣC	0..1	BackboneElement	ALIAS: Transax Conversion
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: transaxConversion
value[x]	ΣC	1..1	CodeableConcept	If parameter is a data type Binding: Transax Conversion ValueSet (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:intentionalReject.value[x]	required	IntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]	required	SystemRejectVS
Parameters.parameter:transaxConversion.value[x]	required	TransaxConversionVS

This structure is derived from Parameters

Summary

Mandatory: 0 element (6 nested mandatory elements)
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron