Vital Records Death Reporting FHIR Implementation Guide
1.2.0 - STU 2 Ballot

This page is part of the Vital Records Mortality and Morbidity Reporting FHIR IG (v1.2.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Cause of Death Pathway

Defining URL:http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Cause-of-Death-Pathway
Version:1.2.0
Name:VRDR_CauseOfDeathPathway
Title:VRDR Cause of Death Pathway
Status:Draft as of 2021-08-13T12:59:07+00:00
Definition:

VRDR Cause of Death Pathway is an ordered list of cause of death conditions. It builds upon the FHIR LIST resource. The source of VRDR Cause of Death Pathway (LIST.source) is a cause of death certifier.

Publisher:Health Level Seven International
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Cause-of-Death-Pathway

Formal Views of Profile Content

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

This structure is derived from List

Summary

Mandatory: 6 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list is a curated collection of resources
... id 0..1stringid
... status 1..1codestatus
Fixed Value: current
... mode 1..1codemode
Fixed Value: snapshot
... orderedBy 1..1CodeableConceptorderedBy
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/list-order
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... display1..1stringRepresentation defined by the system
Fixed Value: Sorted by Priority
... entry 1..*BackboneElemententry
.... item 1..1Reference(VRDR Cause Of Death Condition)item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringid
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codestatus
Binding: ListStatus (required): The current state of the list.


Fixed Value: current
... mode ?!Σ1..1codemode
Binding: ListMode (required): The processing mode that applies to this list.


Fixed Value: snapshot
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code Σ0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.

... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ1..1Reference(VRDR Certifier)source
... orderedBy 1..1CodeableConceptorderedBy
Binding: ListOrderCodes (preferred): What order applies to the items in a list.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/list-order
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... display1..1stringRepresentation defined by the system
Fixed Value: Sorted by Priority
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... note 0..*AnnotationComments about the list
... entry I1..*BackboneElemententry
.... 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
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(VRDR Cause Of Death Condition)item
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

This structure is derived from List

Summary

Mandatory: 6 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list is a curated collection of resources
... id 0..1stringid
... status 1..1codestatus
Fixed Value: current
... mode 1..1codemode
Fixed Value: snapshot
... orderedBy 1..1CodeableConceptorderedBy
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/list-order
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... display1..1stringRepresentation defined by the system
Fixed Value: Sorted by Priority
... entry 1..*BackboneElemententry
.... item 1..1Reference(VRDR Cause Of Death Condition)item

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list is a curated collection of resources
... id Σ0..1stringid
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codestatus
Binding: ListStatus (required): The current state of the list.


Fixed Value: current
... mode ?!Σ1..1codemode
Binding: ListMode (required): The processing mode that applies to this list.


Fixed Value: snapshot
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code Σ0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.

... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ1..1Reference(VRDR Certifier)source
... orderedBy 1..1CodeableConceptorderedBy
Binding: ListOrderCodes (preferred): What order applies to the items in a list.


Fixed Value: As shown
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/list-order
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: priority
..... display1..1stringRepresentation defined by the system
Fixed Value: Sorted by Priority
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... note 0..*AnnotationComments about the list
... entry I1..*BackboneElemententry
.... 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
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(VRDR Cause Of Death Condition)item
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
List.languagepreferredCommonLanguages
Max Binding: AllLanguages
List.statusrequiredFixed Value: current
List.moderequiredFixed Value: snapshot
List.codeexampleExampleUseCodesForList
List.orderedBypreferredFixed Value: priority("Sorted by Priority")
List.entry.flagexamplePatientMedicineChangeTypes
List.emptyReasonpreferredListEmptyReasons

Constraints

IdPathDetailsRequirements
dom-2ListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ListIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4ListIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5ListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ListA resource should have narrative for robust management
: text.`div`.exists()
lst-1ListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2ListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3ListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
ele-1List.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.orderedByAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1List.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1List.entry.flagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.deletedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.entry.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1List.emptyReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())