Violent Death and Overdose Reporting (VDOR) FHIR Implementation Guide
0.1.1-cibuild - CI Build United States of America flag

Violent Death and Overdose Reporting (VDOR) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 0.1.1-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-vdor/ and changes regularly. See the Directory of published versions

Resource Profile: VDOR Weapons - Firearm ( Experimental )

Official URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm Version: 0.1.1-cibuild
Standards status: Informative Computable Name: VDORFirearm

Defines constraints on the Observation resource to capture information on a Firearm for VDRS records.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Representing Firearm data for exchange between law enforcement systems and local and state registries
  • Representing Firearm data explicitly for the NVDRS/SUDORS platform specifications

Mandatory and Must Support Data Elements

Each Firearm Must Support:

  1. A component of type
  2. A component of make
  3. A component of model
  4. A component of caliber
  5. A component of gauge

*† see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the VDOR profile to support implementation.

  • Systems SHALL support all Observation components representing:
    • Firearm Type
    • Firearm Make
    • Firearm Model
    • Firearm Caliber
    • Firearm Gauge
  • Systems SHOULD support Firearm Serial Number. Systems which only collect general descriptive information and do not have a requirement to record explicitly identifiable information about a specific firearm may not support the handling of serial numbers.
  • Systems which intend to interact with the NVDRS/SUDORS platform SHALL support the following extensions to this profile:
    • Firearm Stolen
    • Firearm Stored Loaded
    • Firearm Stored Locked
    • Firearm Owner (Note: Code and Narrative only. Reference is optional.)
  • Systems which intend to interact with the NVDRS/SUDORS platform SHALL require make codes to be from the preferred valueset binding of NCIC Make codes. For more information, see NVDRS Coding Manual Alignment.
  • Systems which intend to interact with the NVDRS/SUDORS platform SHALL require all codes in other fields aside from Make and Model to be from the preferred valueset bindings. For more information, see NVDRS Coding Manual Alignment.

NCIC Gun Data Codes Alignment

A selection of Firearm Make codes from the NCIC Gun Data Codes publication are provided for improved standardization and alignment with most systems. The provided valueset within this implementation guide should not be considered exhaustive. If a code representing a specific manufacturer is not found within the provided valueset, please check the official NCIC gun data code publication for the appropriate code. For more information about using NCIC Make codes with the NVDRS/SUDORS platform, please see NVDRS Coding Manual Alignment.

NVDRS Coding Manual Alignment

Following the guidelines outlined in the NVDRS Coding Manual, Firearm Make leverages the NCIC coded representation for Make values. This is generally a specific manufacturer, though some manufacturers may have distinct codes based on location of manufacture.

Firearm Model values in the are provided based on a representation of pre-loaded values within the NVDRS/SUDORS platform and are not part of the NVDRS Coding Manual. While a code from this set should always be preferred for improved standardization where possible, coding a value of Other and providing a plain text representation in the CodeableConcept's text field is common and valid as the codes available do not attempt to be an exhaustive list.

Preferred valuesets are provided for all other fields captured by the NVDRS/SUDORS platform, as documented by the NVDRS coding manual. The codes provided in this implementation guide are one to one representations of the fields.

For additional information on the specific meaning of a value you may consult the NVDRS Coding Manual.

Additional Guidance by Field

Firearm Make and Model When targeting NCIC gun data codes for Firearm Make, for any any manufacturers not found in the NCIC gun make codes, the coded value SHALL be set to other and relevant information provided in the CodeableConcept text field. For example, if there is a known new or small manufacturer not yet captured by the NCIC codes.

Firearm Caliber and Firearm Gauge To support processing related to the NVDRS/SUDORS platform and avoid semantic pitfalls, Firearm Caliber and Firearm Gauge are provided as separate fields. Values in the preferred valueset are given based on the NVDRS/SUDORS platform, in alignment with common language when discussing calibers and gauges, and are not representative of absolute measurements.

Caliber and Gauge are generally mututally exclusive fields and SHALL be used based on the type of firearm(e.g., gauge for shotguns). For rifle and shotgun combinaton firearms ("over-under" barrels) both Caliber and Gauge SHOULD be included. The inclusion of both fields is defined as a validation warning to improve error resolution, which may be ignored in cases when it is appropriate.

  • The VDOR Weapon Type profile SHALL be present alongside a VDOR Firearm profile, with a type set to "Firearm". The VDOR Weapon Type resource SHOULD provide a focus to the VDOR Firearm profile, creating a reference explicitly documenting the weapon to which the Weapon Type resource describes. For more information, please see the VDOR Weapon Type profile page.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* VDORWeapons Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category S 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: weapons
..... display 1..1 string Representation defined by the system
Fixed Value: Weapon(s)
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: VDOR Violent Death - Weapons Category Value Set (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:type SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
.... component:make SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
.... component:model SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
.... component:caliber SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
.... component:gauge SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required VDOR Violent Death - Weapons Category Value Set 📦0.1.1-cibuild This IG
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:make.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:model.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG
Observation.component:caliber.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​code Base example LOINC Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from VDORWeapons

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* VDORWeapons Measurements and simple assertions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
... Slices for component S 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component:type S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
.... component:make S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
.... component:model S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
.... component:caliber S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
..... value[x] 0..1 string Actual component result
.... component:gauge S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
..... value[x] 0..1 string Actual component result

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* VDORWeapons Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category S 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: weapons
..... display 1..1 string Representation defined by the system
Fixed Value: Weapon(s)
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: VDOR Violent Death - Weapons Category Value Set (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] ΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... 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
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component: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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:type SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:make SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:model SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:caliber SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:gauge SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required VDOR Violent Death - Weapons Category Value Set 📦0.1.1-cibuild This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:type.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:type.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:type.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:make.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:make.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:make.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:model.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG
Observation.component:model.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:model.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:caliber.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:caliber.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:caliber.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:gauge.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* VDORWeapons Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category S 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: weapons
..... display 1..1 string Representation defined by the system
Fixed Value: Weapon(s)
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: VDOR Violent Death - Weapons Category Value Set (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:type SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
.... component:make SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
.... component:model SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
.... component:caliber SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
.... component:gauge SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required VDOR Violent Death - Weapons Category Value Set 📦0.1.1-cibuild This IG
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:make.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:model.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG
Observation.component:caliber.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​code Base example LOINC Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from VDORWeapons

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* VDORWeapons Measurements and simple assertions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... code 1..1 CodeableConcept Type of observation (code / type)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
... Slices for component S 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component:type S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
.... component:make S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
.... component:model S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
..... value[x] 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
.... component:caliber S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
..... value[x] 0..1 string Actual component result
.... component:gauge S 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
..... value[x] 0..1 string Actual component result

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* VDORWeapons Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:firearm-stolen S 0..1 CodeableConcept VDOR Firearm Stolen Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stolen-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-loaded S 0..1 CodeableConcept VDOR Firearm Stored Loaded Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-loaded-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:stored-locked S 0..1 CodeableConcept VDOR Firearm Stored Locked Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-stored-locked-extension
Binding: Value Set - Yes No Unknown NotApplicable Vital Records (extensible)
.... extension:gun-access-narrative S 0..1 string VDOR Gun Access Narrative Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-gun-access-narrative-extension
.... extension:firearm-owner S 0..1 (Complex) VDOR Firearm Owner Extension
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-owner-extension
.... extension:serial-number 0..1 Identifier VDOR Firearm Serial Number
URL: http://hl7.org/fhir/us/vdor/StructureDefinition/vdor-firearm-serial-number
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category S 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: weapons
..... display 1..1 string Representation defined by the system
Fixed Value: Weapon(s)
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: VDOR Violent Death - Weapons Category Value Set (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm
..... display 1..1 string Representation defined by the system
Fixed Value: Details on Firearm
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] ΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... 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
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component SΣ 0..* BackboneElement Component results
Slice: Unordered, Open by pattern:code
.... component: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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:type SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-type
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Firearm Type
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Type Valueset (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:make SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-make
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Make or NCIC Code
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NCIC Firearm Make Code (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:model SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-model
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gun Model
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept Actual component result
Binding: VDOR - NVDRS Firearm Model Code (preferred)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:caliber SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-caliber
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Caliber
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:gauge SΣ 0..1 BackboneElement Component results
..... 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
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vdor/CodeSystem/vdor-custom-code-system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: firearm-gauge
....... display 1..1 string Representation defined by the system
Fixed Value: Firearm - Gauge
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 string Actual component result
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required VDOR Violent Death - Weapons Category Value Set 📦0.1.1-cibuild This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:type.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:type.​value[x] Base preferred VDOR - NVDRS Firearm Type Valueset 📦0.1.1-cibuild This IG
Observation.component:type.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:type.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:make.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:make.​value[x] Base preferred VDOR - NCIC Firearm Make Code 📦0.1.1-cibuild This IG
Observation.component:make.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:make.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:model.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:model.​value[x] Base preferred VDOR - NVDRS Firearm Model Code 📦0.1.1-cibuild This IG
Observation.component:model.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:model.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:caliber.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:caliber.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:caliber.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:gauge.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:gauge.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron