Birth And Fetal Death (BFDR) FHIR Implementation Guide
2.0.0 - STU2 - CIBuild
Birth And Fetal Death (BFDR) FHIR Implementation Guide
2.0.0 - STU2 - CIBuild
Birth And Fetal Death (BFDR) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-bfdr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Bundle-document-fetal-death-report | Version: 2.0.0 | ||||
| Standards status: Draft | Computable Name: BundleDocumentFetalDeathReport | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.5 | |||||
This Bundle profile represents a Fetal Death Document Bundle. It contains any one of the Fetal Death Compositions.
| Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
|---|---|---|---|---|---|---|
| Fetal Death | 3 | Certificate Number | FILENO | identifier.extension[fetalDeathReportNumber].value | string(6) | |
| Fetal Death | 5 | Auxiliary State file number | AUXNO | identifier.extension[localFileNumber1].value | string(12) | |
| Fetal Death | NA | Auxiliary State file number (2) | *NO IJE MAPPING* | identifier.extension[localFileNumber2].value | string(12) | |
| Fetal Death | NA | Record Identifier | *NO IJE MAPPING* | identifier.value | string(12) | YYYYJJNNNNNN, YYYY = year, JJ = jurisdiction, and NNNNNN = certificate number |
| Item # | Form Field | FHIR Profile Field | Reference |
|---|---|---|---|
| - | Local File No | identifier.extension[localFileNumber1].value | Report of Fetal Death |
| - | State File Number | identifier.extension[birthCertificateNumber].value | Report of Fetal Death |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
  Slices for extension |
Content/Rules for all slices | |||
  extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |
 extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2 | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |
 value |
1..1 | string | Record Identifier (YYYYJJNNNNNN) Example General: 123456 Max Length:12 | |
| 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: document (no extensions allowed) | |
 Slices for entry |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource Constraints: bdl-5, bdl-8 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 | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 entry:FetalDeathComposition |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 resource |
1..1 | CompositionProviderFetalDeathReport  , CompositionJurisdictionFetalDeathReport  |
A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
0..* | Bundle | Contains a collection of resources | |
| identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |
| extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2 | |
| system |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |
| value |
1..1 | string | Record Identifier (YYYYJJNNNNNN) Max Length:12 | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document (no extensions allowed) | |
| Slices for entry |
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource | |
| entry:FetalDeathComposition |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
1..1 | CompositionProviderFetalDeathReport, CompositionJurisdictionFetalDeathReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |||||
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |||||
| extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/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 |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |||||
| value |
1..1 | string | 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: document (no extensions allowed) | |||||
| timestamp |
0..1 | instant | When the bundle was assembled | |||||
| total |
C | 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 |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource Constraints: bdl-5, bdl-8 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 |
0..1 | Resource | A resource in the bundle | |||||
| search |
C | 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 |
C | 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 |
C | 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:FetalDeathComposition |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 |
1..1 | CompositionProviderFetalDeathReport , CompositionJurisdictionFetalDeathReport |
A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
 search |
C | 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 |
C | 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 |
C | 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:FetalDeathComposition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:FetalDeathComposition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
Summary
Mandatory: 6 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |
| extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2 | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |
| value |
1..1 | string | Record Identifier (YYYYJJNNNNNN) Example General: 123456 Max Length:12 | |
| 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: document (no extensions allowed) | |
| Slices for entry |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource Constraints: bdl-5, bdl-8 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 | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| entry:FetalDeathComposition |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | CompositionProviderFetalDeathReport , CompositionJurisdictionFetalDeathReport |
A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
0..* | Bundle | Contains a collection of resources | |
| identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |
| extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier2 | |
| system |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |
| value |
1..1 | string | Record Identifier (YYYYJJNNNNNN) Max Length:12 | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document (no extensions allowed) | |
| Slices for entry |
1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource | |
| entry:FetalDeathComposition |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
1..1 | CompositionProviderFetalDeathReport, CompositionJurisdictionFetalDeathReport | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension:fetalDeathReportNumber |
0..1 | string | Fetal Death Report Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CertificateNumber | |||||
| extension:localFileNumber1 |
0..1 | string | Local File Number 1 URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/AuxiliaryStateIdentifier1 | |||||
| extension:localFileNumber2 |
0..1 | string | Local File Number 2 URL: http://hl7.org/fhir/us/vr-common-library/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 |
1..1 | uri | FHIR requires a codesystem Fixed Value: http://hl7.org/fhir/us/vr-common-library/CodeSystem/codesystem-ije-vr (no extensions allowed) | |||||
| value |
1..1 | string | 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: document (no extensions allowed) | |||||
| timestamp |
0..1 | instant | When the bundle was assembled | |||||
| total |
C | 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 |
C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:$this.resource Constraints: bdl-5, bdl-8 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 |
0..1 | Resource | A resource in the bundle | |||||
| search |
C | 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 |
C | 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 |
C | 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:FetalDeathComposition |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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 |
1..1 | CompositionProviderFetalDeathReport , CompositionJurisdictionFetalDeathReport |
A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| search |
C | 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 |
C | 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 |
C | 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:FetalDeathComposition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:FetalDeathComposition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
Summary
Mandatory: 6 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Public Health.
Package hl7.fhir.us.bfdr#2.0.0 based on FHIR 4.0.1.
Generated
2026-11-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change