Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-bundle-document-1 | Version: 0.0.1 | |||
| Draft as of 2024-12-19 | Computable Name: ADHABundleDocument | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The purpose of this profile is to provide a collection of resources handled as a document for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Bundle that are supported.
This profile is designed to set a core Bundle standard for:
None.
This profile is not referenced by another profile in this implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle |
0..* | Bundle | Contains a collection of resources | |
  identifier |
S | 1..1 | Identifier | Persistent identifier for the bundle |
| type |
S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document |
| timestamp |
S | 0..1 | instant | When the bundle was assembled |
| link |
0..0 | |||
  Slices for entry |
S | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
  entry:All Slices |
Content/Rules for all slices | |||
  fullUrl |
S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
 entry:composition |
1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
 resource |
0..1 | ADHACompositionDocument | Composition for the Australian realm | |
 entry:patient |
1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 identifier |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 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. ele-1: All FHIR elements must have a @value or children Fixed Value: document |
| timestamp |
SΣ | 0..1 | instant | When the bundle was assembled ele-1: All FHIR elements must have a @value or children |
| Slices for entry |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| fullUrl |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) ele-1: All FHIR elements must have a @value or children |
| entry:composition |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| resource |
0..1 | ADHACompositionDocument | Composition for the Australian realm | |
| entry:patient |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| resource |
0..1 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | ||||
| 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 |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
SΣ | 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 | ||||
| timestamp |
SΣ | 0..1 | instant | When the bundle was assembled | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
 Slices for entry |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 |
SΣ | 1..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:composition |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 | ADHACompositionDocument | Composition for the Australian realm | |||||
 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:patient |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |||||
| 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 | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard | ||||
| Bundle.entry:composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard | ||||
| Bundle.entry:patient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry:patient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
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 | |
| identifier |
S | 1..1 | Identifier | Persistent identifier for the bundle |
| type |
S | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document |
| timestamp |
S | 0..1 | instant | When the bundle was assembled |
| link |
0..0 | |||
| Slices for entry |
S | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
| entry:All Slices |
Content/Rules for all slices | |||
| fullUrl |
S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| entry:composition |
1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | ADHACompositionDocument | Composition for the Australian realm | |
| entry:patient |
1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| identifier |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 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. ele-1: All FHIR elements must have a @value or children Fixed Value: document |
| timestamp |
SΣ | 0..1 | instant | When the bundle was assembled ele-1: All FHIR elements must have a @value or children |
| Slices for entry |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| fullUrl |
SΣ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) ele-1: All FHIR elements must have a @value or children |
| entry:composition |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| resource |
0..1 | ADHACompositionDocument | Composition for the Australian realm | |
| entry:patient |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| resource |
0..1 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource | ||||
| 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 |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
SΣ | 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 | ||||
| timestamp |
SΣ | 0..1 | instant | When the bundle was assembled | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| Slices for entry |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 |
SΣ | 1..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:composition |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 | ADHACompositionDocument | Composition for the Australian realm | |||||
| 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:patient |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference 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 | ADHAPatientCore | A patient in the context of electronic exchange of health information | |||||
| 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 | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard | ||||
| Bundle.entry:composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard | ||||
| Bundle.entry:patient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry:patient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard |
This structure is derived from Bundle
Summary
Mandatory: 4 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
