Vital Records FHIR Messaging (VRFM) IG
1.1.0
- ci-build
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
Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-MessageParameters | Version: 1.1.0 | |||
Draft as of 2024-03-04 | Responsible: CDC NCHS | Computable Name: MessageParameters |
Base parameter set for most Messages. Parameters with all-caps names are defined as per the 2022 IJE specification.
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_year | string(4) |
AUXNO | Auxiliary State file number | state_auxiliary_id | string(12) |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | Parameters | |||
id | S | 0..1 | id | Logical id of this artifact |
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 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | 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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | |||||||
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 inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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: 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) | ||||
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 inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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: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) | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
This structure is derived from Parameters
Summary
Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 1 element
Prohibited: 12 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | Parameters | |||
id | S | 0..1 | id | Logical id of this artifact |
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 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | 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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | |||||||
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 inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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: 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) | ||||
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 inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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: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) | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Parameters.parameter:jurisdiction_id.value[x] | required | JurisdictionVShttp://hl7.org/fhir/us/vrdr/ValueSet/vrdr-jurisdiction-vs |
This structure is derived from Parameters
Summary
Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 1 element
Prohibited: 12 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron