Standard Death Record

DeathRecordProfile

 

The official URL for this profile is:

http://nightingaleproject.github.io/fhirDeathRecord/StructureDefinition/sdr-deathRecord-DeathRecord

A document that details information about the death of an individual. The contents correspond to items included in the U.S. Standard Certificate of Death.

This profile builds on Bundle.

This profile was published on Thu Jun 14 00:00:00 EDT 2018 as a draft by The MITRE Corporation: Nightingale Project.

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of profile:resource

SDR Mapping Source

This structure represents the following SDR mapping definition:

sdr.deathRecord.DeathRecord maps to Bundle:
  fix type to http://hl7.org/fhir/bundle-type#document
  DeathRecordContents maps to entry.resource (slice at = entry; slice on = resource; slice on type = profile)

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SDR DeathRecord Profile
... type Fixed Value: document
... entry Slice: Unordered, Open by profile:resource
... entry DeathRecordContents
.... resource 1..1DeathRecordContentsProfile

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*SDR DeathRecord Profile
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request only for some types of bundles
bdl-4: entry.response only for some types of bundles
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: document
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry ΣIBackboneElementEntry in the bundle - will have a resource, or information
Slice: Unordered, Open by profile:resource
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
... entry ΣI0..*BackboneElementDeathRecordContents
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource Σ1..1DeathRecordContentsProfileA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of profile:resource

SDR Mapping Source

This structure represents the following SDR mapping definition:

sdr.deathRecord.DeathRecord maps to Bundle:
  fix type to http://hl7.org/fhir/bundle-type#document
  DeathRecordContents maps to entry.resource (slice at = entry; slice on = resource; slice on type = profile)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SDR DeathRecord Profile
... type Fixed Value: document
... entry Slice: Unordered, Open by profile:resource
... entry DeathRecordContents
.... resource 1..1DeathRecordContentsProfile

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*SDR DeathRecord Profile
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request only for some types of bundles
bdl-4: entry.response only for some types of bundles
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type Σ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: document
... total ΣI0..1unsignedIntIf search, the total number of matches
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry ΣIBackboneElementEntry in the bundle - will have a resource, or information
Slice: Unordered, Open by profile:resource
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
... entry ΣI0..*BackboneElementDeathRecordContents
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link Σ0..*Unknown reference to #Bundle.link
Links related to this entry
.... fullUrl Σ0..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource Σ1..1DeathRecordContentsProfileA resource in the bundle
.... search ΣI0..1BackboneElementSearch related information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
..... score Σ0..1decimalSearch ranking (between 0 and 1)
.... request ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... method Σ1..1codeGET | POST | PUT | DELETE
Binding: HTTPVerb (required)
..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing update contention
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣI0..1BackboneElementTransaction Related Information
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location, if the operation returns a location
..... etag Σ0..1stringThe etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Bundle.languageCommon LanguagesextensibleCommon Languages
Bundle.typeBundleTyperequiredBundleType
Bundle.entry.search.modeSearchEntryModerequiredSearchEntryMode
Bundle.entry.request.methodHTTPVerbrequiredHTTPVerb

 

Constraints

IdPathDetailsRequirements
bdl-7BundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
: entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9BundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-3Bundleentry.request only for some types of bundles
: entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4Bundleentry.response only for some types of bundles
: entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
ele-1Bundle.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
ele-1Bundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Bundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())