Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2
US
Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2
US
This page is part of the Vital Records Mortality and Morbidity Reporting FHIR IG (v2.0.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 
| 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
| # | 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:
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:
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Parameters | 0..* | Parameters | Operation Request or Response | |
  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 Slice: Unordered, Open by type:$this | |
 valueDate | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |||||
| id | Σ | 0..1 | string | 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.
| |||||
| Slices for parameter | ΣI | 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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource | ||||
 part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:shipmentNumber | ΣI | 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] | ΣI | 1..1 | string | If parameter is a data type | ||||
| parameter:receiptDate | ΣI | 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 | ||||
 Slices for value[x] | ΣI | 1..1 | date | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueDate | ΣI | 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 | ΣI | 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] | ΣI | 1..1 | integer | If parameter is a data type | ||||
| parameter:intentionalReject | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: Intentional Reject ValueSet (required) | ||||
| parameter:acmeSystemReject | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: System Reject ValueSet (required) | ||||
| parameter:transaxConversion | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: Transax Conversion ValueSet (required) | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |
| 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:
Differential View
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |
| 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 Slice: Unordered, Open by type:$this | |
| valueDate | 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters | 0..* | Parameters | Operation Request or Response | |||||
| id | Σ | 0..1 | string | 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.
| |||||
| Slices for parameter | ΣI | 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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource | ||||
| part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
| parameter:shipmentNumber | ΣI | 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] | ΣI | 1..1 | string | If parameter is a data type | ||||
| parameter:receiptDate | ΣI | 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 | ||||
| Slices for value[x] | ΣI | 1..1 | date | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| value[x]:valueDate | ΣI | 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 | ΣI | 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] | ΣI | 1..1 | integer | If parameter is a data type | ||||
| parameter:intentionalReject | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: Intentional Reject ValueSet (required) | ||||
| parameter:acmeSystemReject | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: System Reject ValueSet (required) | ||||
| parameter:transaxConversion | ΣI | 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] | ΣI | 1..1 | CodeableConcept | If parameter is a data type Binding: Transax Conversion ValueSet (required) | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Parameters.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Parameters.parameter:intentionalReject.value[x] | required | IntentionalRejectVS |
| Parameters.parameter:acmeSystemReject.value[x] | required | SystemRejectVS |
| Parameters.parameter:transaxConversion.value[x] | required | TransaxConversionVS |
IG © 2022+ HL7 Public Health Working Group. Package hl7.fhir.us.vrdr#2.0.0 based on FHIR 4.0.1. Generated 2022-08-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change