Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2
US
Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2
US
This page is part of the Vital Records Mortality and Morbidity Reporting FHIR IG (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-mortality-roster-bundle | Version: 2.0.0 | |||
| Active as of 2022-08-31 | Computable Name: MortalityRosterBundle | |||
Mortality Roster Bundle (Bundle): A bundle containing instances of the resources comprising mortality roster content. This bundle is information-content equivalent to the traditional Mortality Roster. The mortality roster is a supplemental report of death for the purpose of notifying the decedent’s jurisdiction of birth that the death has occurred. The roster data points are sufficient to locate the birth certificate of the decedent but do not otherwise contain the full death record. Once received, the jurisdiction of birth uses the mortality roster data to locate the record of birth and marks it as deceased.
There are some discrepancies that between roster and IJE field names, that are noted in the table below. See the MortalityRosterDataDictionary for full content of the Mortality Register.
| # | Description | Roster Name | IJE Name | Field | Type | Value Set |
|---|---|---|---|---|---|---|
| NA | Death Record Identifier | NO IJE MAPPING | identifier.value | string(12) | YYYYJJNNNNNN, YYYY = death year JJ = jurisdiction and NNNNNN = certificate number | |
| 15 | State File Number | FILENO | identifier.extension[ certificateNumber].value | string(6) | - | |
| 33 | Alias Record Flag | ALIAS | meta.extension[aliasStatus].value | boolean | ||
| 34 | Replacement Record Flag | REPLACE | meta.extension[replaceStatus].value | codeable | ReplaceStatusVS |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  meta | ||||
   aliasStatus | 0..1 | boolean | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AliasStatus | |
 replaceStatus | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/ReplaceStatus Binding: Replacement Status VS (required) | |
| identifier | 1..1 | Identifier | Persistent identifier for the bundle | |
| certificateNumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CertificateNumber | |
| auxiliaryStateIdentifier1 | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier1 | |
| auxiliaryStateIdentifier2 | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier2 | |
| value | 0..1 | string | Death Record Identifier (YYYYJJNNNNNN) Max Length: 12 | |
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
  Slices for entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
  entry:All Slices | Content/Rules for all slices | |||
  resource | 1..1 | Resource | A resource in the bundle | |
| entry:Decedent | 1..1 | BackboneElement | Decedent | |
 resource | 0..1 | Decedent | Information about an individual or animal receiving health care services | |
| entry:DecedentFather | 0..1 | BackboneElement | DecedentFather | |
| resource | 0..1 | DecedentFather | A person that is related to a patient, but who is not a direct target of care | |
| entry:DecedentMother | 0..1 | BackboneElement | DecedentMother | |
| resource | 0..1 | DecedentMother | A person that is related to a patient, but who is not a direct target of care | |
| entry:DeathLocation | 0..1 | BackboneElement | DeathLocation | |
| resource | 0..1 | DeathLocation | Details and position information for a physical place | |
 entry:DeathDate | 0..1 | BackboneElement | DeathDate | |
| resource | 0..1 | DeathDate | Measurements and simple assertions | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources | ||||
 id | Σ | 0..1 | string | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| aliasStatus | 0..1 | boolean | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AliasStatus | |||||
| replaceStatus | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/ReplaceStatus Binding: Replacement Status VS (required) | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| identifier | Σ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| certificateNumber | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CertificateNumber | |||||
| auxiliaryStateIdentifier1 | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier1 | |||||
| auxiliaryStateIdentifier2 | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier2 | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | Death Record Identifier (YYYYJJNNNNNN) Example General: 123456 Max Length: 12 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection | ||||
| timestamp | Σ | 0..1 | instant | When the bundle was assembled | ||||
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| 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 | ||||
| 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 | ||||
| Slices for entry | ΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry: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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 1..1 | Resource | A resource in the bundle | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:Decedent | ΣI | 1..1 | BackboneElement | Decedent This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | Decedent | Information about an individual or animal receiving health care services | ||||
 search | ΣI | 0..1 | BackboneElement | Search related information | ||||
 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
 response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DecedentFather | ΣI | 0..1 | BackboneElement | DecedentFather This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DecedentFather | A person that is related to a patient, but who is not a direct target of care | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DecedentMother | ΣI | 0..1 | BackboneElement | DecedentMother This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DecedentMother | A person that is related to a patient, but who is not a direct target of care | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DeathLocation | ΣI | 0..1 | BackboneElement | DeathLocation This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 0..1 | DeathLocation | Details and position information for a physical place | |||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DeathDate | ΣI | 0..1 | BackboneElement | DeathDate This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DeathDate | Measurements and simple assertions | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources |
| Documentation for this format | ||||
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| meta | ||||
| aliasStatus | 0..1 | boolean | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AliasStatus | |
| replaceStatus | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/ReplaceStatus Binding: Replacement Status VS (required) | |
| identifier | 1..1 | Identifier | Persistent identifier for the bundle | |
| certificateNumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CertificateNumber | |
| auxiliaryStateIdentifier1 | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier1 | |
| auxiliaryStateIdentifier2 | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier2 | |
| value | 0..1 | string | Death Record Identifier (YYYYJJNNNNNN) Max Length: 12 | |
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
| Slices for entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource | |
| entry:All Slices | Content/Rules for all slices | |||
| resource | 1..1 | Resource | A resource in the bundle | |
| entry:Decedent | 1..1 | BackboneElement | Decedent | |
| resource | 0..1 | Decedent | Information about an individual or animal receiving health care services | |
| entry:DecedentFather | 0..1 | BackboneElement | DecedentFather | |
| resource | 0..1 | DecedentFather | A person that is related to a patient, but who is not a direct target of care | |
| entry:DecedentMother | 0..1 | BackboneElement | DecedentMother | |
| resource | 0..1 | DecedentMother | A person that is related to a patient, but who is not a direct target of care | |
| entry:DeathLocation | 0..1 | BackboneElement | DeathLocation | |
| resource | 0..1 | DeathLocation | Details and position information for a physical place | |
| entry:DeathDate | 0..1 | BackboneElement | DeathDate | |
| resource | 0..1 | DeathDate | Measurements and simple assertions | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | I | 0..* | Bundle | Contains a collection of resources | ||||
| id | Σ | 0..1 | string | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| aliasStatus | 0..1 | boolean | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AliasStatus | |||||
| replaceStatus | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/ReplaceStatus Binding: Replacement Status VS (required) | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| identifier | Σ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| certificateNumber | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CertificateNumber | |||||
| auxiliaryStateIdentifier1 | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier1 | |||||
| auxiliaryStateIdentifier2 | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/AuxiliaryStateIdentifier2 | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | Death Record Identifier (YYYYJJNNNNNN) Example General: 123456 Max Length: 12 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection | ||||
| timestamp | Σ | 0..1 | instant | When the bundle was assembled | ||||
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| 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 | ||||
| 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 | ||||
| Slices for entry | ΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry: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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | Σ | 1..1 | Resource | A resource in the bundle | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:Decedent | ΣI | 1..1 | BackboneElement | Decedent This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | Decedent | Information about an individual or animal receiving health care services | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DecedentFather | ΣI | 0..1 | BackboneElement | DecedentFather This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DecedentFather | A person that is related to a patient, but who is not a direct target of care | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DecedentMother | ΣI | 0..1 | BackboneElement | DecedentMother This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DecedentMother | A person that is related to a patient, but who is not a direct target of care | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DeathLocation | ΣI | 0..1 | BackboneElement | DeathLocation This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | 0..1 | DeathLocation | Details and position information for a physical place | |||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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) | ||||
| entry:DeathDate | ΣI | 0..1 | BackboneElement | DeathDate This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource | I | 0..1 | DeathDate | Measurements and simple assertions | ||||
| search | ΣI | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| 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 cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| 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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Bundle.meta.security | extensible | All Security Labels |
| Bundle.meta.tag | example | CommonTags |
| Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Bundle.identifier.use | required | IdentifierUse |
| Bundle.identifier.type | extensible | Identifier Type Codes |
| Bundle.type | required | Fixed Value: collection |
| Bundle.entry.search.mode | required | SearchEntryMode |
| Bundle.entry.request.method | required | HTTPVerb |
| Bundle.entry:Decedent.search.mode | required | SearchEntryMode |
| Bundle.entry:Decedent.request.method | required | HTTPVerb |
| Bundle.entry:DecedentFather.search.mode | required | SearchEntryMode |
| Bundle.entry:DecedentFather.request.method | required | HTTPVerb |
| Bundle.entry:DecedentMother.search.mode | required | SearchEntryMode |
| Bundle.entry:DecedentMother.request.method | required | HTTPVerb |
| Bundle.entry:DeathLocation.search.mode | required | SearchEntryMode |
| Bundle.entry:DeathLocation.request.method | required | HTTPVerb |
| Bundle.entry:DeathDate.search.mode | required | SearchEntryMode |
| Bundle.entry:DeathDate.request.method | required | HTTPVerb |
IG © 2022+ HL7 Public Health Working Group. Package hl7.fhir.us.vrdr#2.0.0 based on FHIR 4.0.1. Generated 2022-08-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change