Vital Records Death Reporting FHIR Implementation Guide
1.1.0 - STU 2
US
Vital Records Death Reporting FHIR Implementation Guide
1.1.0 - STU 2
US
Vital Records Death Reporting FHIR Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Cause-of-Death-Pathway | Version: 1.1.0 | |||
| Draft as of 2022-04-04 | Computable Name: VRDR_CauseOfDeathPathway | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List | 0..* | List | A list is a curated collection of resources | |
  id | 0..1 | string | id | |
 status | 1..1 | code | status Fixed Value: current | |
| mode | 1..1 | code | mode Fixed Value: snapshot | |
 source | 1..1 | Reference(VRDR Certifier) | source | |
  orderedBy | 1..1 | CodeableConcept | orderedBy Fixed Value: As shown | |
   coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-order | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Sorted by Priority | |
| entry | 1..5 | BackboneElement | entry | |
| item | 1..1 | Reference(Cause Of Death Condition) | item | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | I | 0..* | List | A list is a curated collection of resources |
| id | Σ | 0..1 | string | id |
| 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Business identifier | |
| status | ?!Σ | 1..1 | code | status Binding: ListStatus (required): The current state of the list. Fixed Value: current |
| mode | ?!Σ | 1..1 | code | mode Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot |
| title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. |
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 1..1 | Reference(VRDR Certifier) | source |
| orderedBy | 1..1 | CodeableConcept | orderedBy Binding: ListOrderCodes (preferred): What order applies to the items in a list. Fixed Value: As shown | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-order | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Sorted by Priority | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| note | 0..* | Annotation | Comments about the list | |
| entry | I | 1..5 | BackboneElement | entry |
| 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 |
| flag | 0..1 | CodeableConcept | Status/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 | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Cause Of Death Condition) | item | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | I | 0..* | List | A list is a curated collection of resources |
| Documentation for this format | ||||
This structure is derived from List
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | 0..* | List | A list is a curated collection of resources | |
| id | 0..1 | string | id | |
| status | 1..1 | code | status Fixed Value: current | |
| mode | 1..1 | code | mode Fixed Value: snapshot | |
| source | 1..1 | Reference(VRDR Certifier) | source | |
| orderedBy | 1..1 | CodeableConcept | orderedBy Fixed Value: As shown | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-order | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Sorted by Priority | |
| entry | 1..5 | BackboneElement | entry | |
| item | 1..1 | Reference(Cause Of Death Condition) | item | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | I | 0..* | List | A list is a curated collection of resources |
| id | Σ | 0..1 | string | id |
| 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Business identifier | |
| status | ?!Σ | 1..1 | code | status Binding: ListStatus (required): The current state of the list. Fixed Value: current |
| mode | ?!Σ | 1..1 | code | mode Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot |
| title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. |
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
| encounter | 0..1 | Reference(Encounter) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 1..1 | Reference(VRDR Certifier) | source |
| orderedBy | 1..1 | CodeableConcept | orderedBy Binding: ListOrderCodes (preferred): What order applies to the items in a list. Fixed Value: As shown | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..0 | string | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-order | |
| version | 0..0 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: priority | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Sorted by Priority | |
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
| text | 0..0 | string | Plain text representation of the concept | |
| note | 0..* | Annotation | Comments about the list | |
| entry | I | 1..5 | BackboneElement | entry |
| 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 |
| flag | 0..1 | CodeableConcept | Status/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 | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Cause Of Death Condition) | item | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| List.language | preferred | CommonLanguages Max Binding: AllLanguages |
| List.status | required | Fixed Value: current |
| List.mode | required | Fixed Value: snapshot |
| List.code | example | ExampleUseCodesForList |
| List.orderedBy | preferred | Fixed Value: priority("Sorted by Priority") |
| List.entry.flag | example | PatientMedicineChangeTypes |
| List.emptyReason | preferred | ListEmptyReasons |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | List | If 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-4 | error | List | If 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-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | List | A resource should have narrative for robust management : text.`div`.exists() | |
| lst-1 | error | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() | |
| ele-1 | error | List.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | List.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | List.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | List.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | List.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | List.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | List.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | List.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | List.entry.flag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.entry.deleted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.entry.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.entry.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | List.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2021+ Health Level Seven International. Package hl7.fhir.us.vrdr#1.1.0 based on FHIR 4.0.1. Generated 2022-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change