Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2 US

This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Coding Status Values

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-coding-status-values Version: 2.0.0
Active as of 2022-08-31 Computable Name: CodingStatusValues

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

Usage

# Description IJE Name IJE only Field Type Value Set
91 Receipt date – Year R_YR   parameter[receiptDate].value date See PartialDatesAndTimes
92 Receipt date – Month R_MO   parameter[receiptDate].value date See PartialDatesAndTimes
93 Receipt date – Day R_DY   parameter[receiptDate].value date See PartialDatesAndTimes
NA coder status CS (TRX Field, no IJE Mapping)   parameter[coderStatus].value integer -
NA shipment number SHIP (TRX Field, no IJE Mapping)   parameter[shipmentNumber].value string -
101 Intentional Reject INT_REJ   parameter[intentionalReject].value codeable IntentionalRejectVS
102 Acme System Reject Codes SYS_REJ   parameter[acmeSystemReject].value codeable ACMESystemRejectVS
107 Transax conversion flag: Computer Generated TRX_FLG   parameter[transaxConversion].value codeable TransaxConversionVS

Usage:

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name
  • The element Parameters.parameter.value[x] is sliced based on the value of type:$this

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:shipmentNumber 0..1BackboneElementshipment number
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: shipmentNumber
..... value[x] 1..1stringIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:receiptDate 0..1BackboneElementreceipt date
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: receiptDate
..... value[x] 1..1dateIf parameter is a data type
Slice: Unordered, Open by type:$this
..... valueDate 1..1dateIf parameter is a data type
...... Slices for extension 0..*ExtensionExtension
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..1BackboneElementcoder status
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: coderStatus
..... value[x] 1..1integerIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:intentionalReject 0..1BackboneElementIntentional reject
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: intentionalReject
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: Intentional Reject ValueSet (required)
..... resource 0..0
..... part 0..0
.... parameter:acmeSystemReject 0..1BackboneElementACME System Reject
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: acmeSystemReject
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: System Reject ValueSet (required)
..... resource 0..0
..... part 0..0
.... parameter:transaxConversion 0..1BackboneElementALIAS: Transax Conversion
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: transaxConversion
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: Transax Conversion ValueSet (required)
..... resource 0..0
..... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:shipmentNumber ΣI0..1BackboneElementshipment number
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: shipmentNumber
..... value[x] ΣI1..1stringIf parameter is a data type
.... parameter:receiptDate ΣI0..1BackboneElementreceipt date
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: receiptDate
..... Slices for value[x] ΣI1..1dateIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueDate ΣI1..1dateIf parameter is a data type
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... partialDate 0..1(Complex)Partial Date
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
....... value 0..1datePrimitive value for date
.... parameter:coderStatus ΣI0..1BackboneElementcoder status
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: coderStatus
..... value[x] ΣI1..1integerIf parameter is a data type
.... parameter:intentionalReject ΣI0..1BackboneElementIntentional reject
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: intentionalReject
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: Intentional Reject ValueSet (required)
.... parameter:acmeSystemReject ΣI0..1BackboneElementACME System Reject
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: acmeSystemReject
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: System Reject ValueSet (required)
.... parameter:transaxConversion ΣI0..1BackboneElementALIAS: Transax Conversion
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: transaxConversion
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: Transax Conversion ValueSet (required)

doco Documentation for this format

This structure is derived from Parameters

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name
  • The element Parameters.parameter.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:shipmentNumber 0..1BackboneElementshipment number
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: shipmentNumber
..... value[x] 1..1stringIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:receiptDate 0..1BackboneElementreceipt date
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: receiptDate
..... value[x] 1..1dateIf parameter is a data type
Slice: Unordered, Open by type:$this
..... valueDate 1..1dateIf parameter is a data type
...... Slices for extension 0..*ExtensionExtension
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..1BackboneElementcoder status
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: coderStatus
..... value[x] 1..1integerIf parameter is a data type
..... resource 0..0
..... part 0..0
.... parameter:intentionalReject 0..1BackboneElementIntentional reject
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: intentionalReject
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: Intentional Reject ValueSet (required)
..... resource 0..0
..... part 0..0
.... parameter:acmeSystemReject 0..1BackboneElementACME System Reject
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: acmeSystemReject
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: System Reject ValueSet (required)
..... resource 0..0
..... part 0..0
.... parameter:transaxConversion 0..1BackboneElementALIAS: Transax Conversion
..... extension 0..0
..... name 1..1stringName from the definition
Required Pattern: transaxConversion
..... value[x] 1..1CodeableConceptIf parameter is a data type
Binding: Transax Conversion ValueSet (required)
..... resource 0..0
..... part 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:shipmentNumber ΣI0..1BackboneElementshipment number
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: shipmentNumber
..... value[x] ΣI1..1stringIf parameter is a data type
.... parameter:receiptDate ΣI0..1BackboneElementreceipt date
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: receiptDate
..... Slices for value[x] ΣI1..1dateIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueDate ΣI1..1dateIf parameter is a data type
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... partialDate 0..1(Complex)Partial Date
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
....... value 0..1datePrimitive value for date
.... parameter:coderStatus ΣI0..1BackboneElementcoder status
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: coderStatus
..... value[x] ΣI1..1integerIf parameter is a data type
.... parameter:intentionalReject ΣI0..1BackboneElementIntentional reject
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: intentionalReject
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: Intentional Reject ValueSet (required)
.... parameter:acmeSystemReject ΣI0..1BackboneElementACME System Reject
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: acmeSystemReject
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: System Reject ValueSet (required)
.... parameter:transaxConversion ΣI0..1BackboneElementALIAS: Transax Conversion
..... id 0..1stringUnique id for inter-element referencing
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Required Pattern: transaxConversion
..... value[x] ΣI1..1CodeableConceptIf parameter is a data type
Binding: Transax Conversion ValueSet (required)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages
Parameters.parameter:intentionalReject.value[x]requiredIntentionalRejectVS
Parameters.parameter:acmeSystemReject.value[x]requiredSystemRejectVS
Parameters.parameter:transaxConversion.value[x]requiredTransaxConversionVS