Vital Records Death Reporting FHIR Implementation Guide
1.1.0 - STU 2 US

Vital Records Death Reporting FHIR Implementation Guide - Local Development build (v1.1.0). See the Directory of published versions

Resource Profile: VRDR Death Location

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Death-Location Version: 1.1.0
Draft as of 2020-05-09 Computable Name: DeathLocation

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

Summary

Mandatory: 5 elements

Extensions

This structure refers to these extensions:

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Location-Jurisdiction-Id 1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=282D4DD8-39EA-4C5B-B8A9-B2C3E5878A15# (required): PHVS_USVitalRecordsJurisdictions_NCHS


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..1stringname
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ1..1stringdescription
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ1..1CodeableConcepttype
Binding: Place of Death (required): Place of Death


... telecom S0..*ContactPointContact details of the location
... address S1..1Addressaddress
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=C2F2220B-270F-4BDF-9F8C-D5CB369F7212 (required): PHVS_DivisionVitalStatistics__County


Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ1..1stringname
... telecom 0..*ContactPointContact details of the location
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
... managingOrganization Σ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

This structure is derived from USCoreLocation

Summary

Mandatory: 5 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from USCoreLocation

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Location-Jurisdiction-Id 1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=282D4DD8-39EA-4C5B-B8A9-B2C3E5878A15# (required): PHVS_USVitalRecordsJurisdictions_NCHS


... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..1stringname
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ1..1stringdescription
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ1..1CodeableConcepttype
Binding: Place of Death (required): Place of Death


... telecom S0..*ContactPointContact details of the location
... address S1..1Addressaddress
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?id=C2F2220B-270F-4BDF-9F8C-D5CB369F7212 (required): PHVS_DivisionVitalStatistics__County


Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typerequiredPlaceOfDeath
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.districtrequiredhttps://phinvads.cdc.gov/vads/ViewValueSet.action?id=C2F2220B-270F-4BDF-9F8C-D5CB369F7212
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePathDetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorLocation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.extension:nationalReportingJurisdictionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension:nationalReportingJurisdictionIdMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.operationalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.physicalTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.positionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.position.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.position.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.position.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.position.longitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.latitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.altitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.hoursOfOperation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.hoursOfOperation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.hoursOfOperation.daysOfWeekAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.allDayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.openingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.closingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.availabilityExceptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())