Standard Death Record

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:

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

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)

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*		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..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: Common Languages (extensible)
identifier	Î£	0..1	Identifier	Persistent identifier for the bundle
type	Î£	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required) Fixed Value: document
total	Î£I	0..1	unsignedInt	If search, the total number of matches
link	Î£I	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
relation	Î£	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Î£	1..1	uri	Reference details for the link
entry	Î£I		BackboneElement	Entry 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	Î£I	0..*	BackboneElement	DeathRecordContents bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
link	Î£	0..*		Unknown reference to #Bundle.link Links related to this entry
fullUrl	Î£	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Î£	1..1	DeathRecordContentsProfile	A resource in the bundle
search	Î£I	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
mode	Î£	0..1	code	match \| include \| outcome - why this is in the result set Binding: SearchEntryMode (required)
score	Î£	0..1	decimal	Search ranking (between 0 and 1)
request	Î£I	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
method	Î£	1..1	code	GET \| POST \| PUT \| DELETE Binding: HTTPVerb (required)
url	Î£	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Î£	0..1	string	For managing cache currency
ifModifiedSince	Î£	0..1	instant	For managing update contention
ifMatch	Î£	0..1	string	For managing update contention
ifNoneExist	Î£	0..1	string	For conditional creates
response	Î£I	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
status	Î£	1..1	string	Status response code (text optional)
location	Î£	0..1	uri	The location, if the operation returns a location
etag	Î£	0..1	string	The etag for the resource (if relevant)
lastModified	Î£	0..1	instant	Server's date time modified
outcome	Î£	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Î£	0..1	Signature	Digital Signature
Documentation for this format

Summary

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

Structures

This structure refers to these other structures:

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

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

Name	Card.	Type	Description & Constraints
Bundle			SDR DeathRecord Profile
type			Fixed Value: document
entry			Slice: Unordered, Open by profile:resource
entry			DeathRecordContents
resource	1..1	DeathRecordContentsProfile
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	I	0..*		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..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: Common Languages (extensible)
identifier	Î£	0..1	Identifier	Persistent identifier for the bundle
type	Î£	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required) Fixed Value: document
total	Î£I	0..1	unsignedInt	If search, the total number of matches
link	Î£I	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
relation	Î£	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Î£	1..1	uri	Reference details for the link
entry	Î£I		BackboneElement	Entry 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	Î£I	0..*	BackboneElement	DeathRecordContents bdl-8: fullUrl cannot be a version specific reference bdl-5: must be a resource unless there's a request or response
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
link	Î£	0..*		Unknown reference to #Bundle.link Links related to this entry
fullUrl	Î£	0..1	uri	Absolute URL for resource (server address, or UUID/OID)
resource	Î£	1..1	DeathRecordContentsProfile	A resource in the bundle
search	Î£I	0..1	BackboneElement	Search related information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
mode	Î£	0..1	code	match \| include \| outcome - why this is in the result set Binding: SearchEntryMode (required)
score	Î£	0..1	decimal	Search ranking (between 0 and 1)
request	Î£I	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
method	Î£	1..1	code	GET \| POST \| PUT \| DELETE Binding: HTTPVerb (required)
url	Î£	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatch	Î£	0..1	string	For managing cache currency
ifModifiedSince	Î£	0..1	instant	For managing update contention
ifMatch	Î£	0..1	string	For managing update contention
ifNoneExist	Î£	0..1	string	For conditional creates
response	Î£I	0..1	BackboneElement	Transaction Related Information
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Î£	0..*	Extension	Extensions that cannot be ignored
status	Î£	1..1	string	Status response code (text optional)
location	Î£	0..1	uri	The location, if the operation returns a location
etag	Î£	0..1	string	The etag for the resource (if relevant)
lastModified	Î£	0..1	instant	Server's date time modified
outcome	Î£	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signature	Î£	0..1	Signature	Digital Signature
Documentation for this format

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

Terminology Bindings

Path	Name	Conformance	ValueSet
Bundle.language	Common Languages	extensible	Common Languages
Bundle.type	BundleType	required	BundleType
Bundle.entry.search.mode	SearchEntryMode	required	SearchEntryMode
Bundle.entry.request.method	HTTPVerb	required	HTTPVerb

Constraints

Id	Path	Details	Requirements
bdl-7	Bundle	FullUrl 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-9	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-3	Bundle	entry.request only for some types of bundles : entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4	Bundle	entry.response only for some types of bundles : entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-1	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
ele-1	Bundle.link	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ele-1	Bundle.entry	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
bdl-8	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-5	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
ele-1	Bundle.entry	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
bdl-8	Bundle.entry	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-5	Bundle.entry	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
ele-1	Bundle.entry.search	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ele-1	Bundle.entry.request	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ele-1	Bundle.entry.response	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())

Standard Death Record, Version: 0.1.0 © ; FHIR Version: 3.0.1 (IG Publisher v3.0.1-11917) ; Generated on Thu, Jun 14, 2018 15:34-0400.