Smart Health Checks
0.3.0 - ci-build

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Smart Health Checks Extract Bundle

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCExtractBundle | Version: 0.3.0
Draft as of 2025-10-01 | Computable Name: SmartHealthChecksExtractBundle
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

This profile sets the expectations for a Bundle resource when used to represent a transaction bundle of resources extracted by the SHC App following the completion of a Smart Health Checks Questionnaire. This bundle is used to write patient information to the SHC Host FHIR server.

Usages:

- Examples for this Profile: Bundle/sdc-template-extract-928bbdd27d15
- CapabilityStatements using this Profile: SHC App and SHC Host FHIR Server

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
type | SO Σ | 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: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO Σ | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
Slices for entry | Σ C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.method 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:post | SO Σ C | 0..* | BackboneElement | Entries for creating new resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO Σ | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
request | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
entry:patch | SO Σ C | 0..* | BackboneElement | Entries for patching existing resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
request | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry:post.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | fullUrl cannot be a version specific reference | `fullUrl.contains('/_history/').not()`
bdl-9 | error | Bundle | A document must have an identifier with a system and a value | `type = 'document' implies (identifier.system.exists() and identifier.value.exists())`
bdl-10 | error | Bundle | A document must have a date | `type = 'document' implies (timestamp.hasValue())`
bdl-11 | error | Bundle | A document must have a Composition as the first resource | `type = 'document' implies entry.first().resource.is(Composition)`
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource | `type = 'message' implies entry.first().resource.is(MessageHeader)`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle |  | 0..* | Bundle | Contains a collection of resources
type | SO | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
Slices for entry |  | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.method
entry:post | SO | 0..* | BackboneElement | Entries for creating new resources
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
fullUrl | SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
request | SO | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
method | SO | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
entry:patch | SO | 0..* | BackboneElement | Entries for patching existing resources
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
fullUrl | SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
request | SO | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
method | SO | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle
type | SO Σ | 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: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO Σ | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
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, Closed by value:request.method 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:post | SO Σ C | 0..* | BackboneElement | Entries for creating new resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO Σ | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
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 | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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:patch | SO Σ C | 0..* | BackboneElement | Entries for patching existing resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.language | Base | preferred | Common Languages | 📍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:post.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:post.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | fullUrl cannot be a version specific reference | `fullUrl.contains('/_history/').not()`
bdl-9 | error | Bundle | A document must have an identifier with a system and a value | `type = 'document' implies (identifier.system.exists() and identifier.value.exists())`
bdl-10 | error | Bundle | A document must have a date | `type = 'document' implies (timestamp.hasValue())`
bdl-11 | error | Bundle | A document must have a Composition as the first resource | `type = 'document' implies entry.first().resource.is(Composition)`
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource | `type = 'message' implies entry.first().resource.is(MessageHeader)`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Bundle

Summary

Mandatory: 2 elements(6 nested mandatory elements)
Must-Support: 14 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

- Smart Health Checks AllergyIntolerance (https://smartforms.csiro.au/ig/StructureDefinition/SHCAllergyIntolerance)
- Smart Health Checks Condition (https://smartforms.csiro.au/ig/StructureDefinition/SHCCondition)
- Smart Health Checks Immunization (https://smartforms.csiro.au/ig/StructureDefinition/SHCImmunization)
- Smart Health Checks MedicationStatement (https://smartforms.csiro.au/ig/StructureDefinition/SHCMedicationStatement)
- Smart Health Checks Blood Pressure (https://smartforms.csiro.au/ig/StructureDefinition/SHCBloodPressure)
- Smart Health Checks Body Height (https://smartforms.csiro.au/ig/StructureDefinition/SHCBodyHeight)
- Smart Health Checks Body Weight (https://smartforms.csiro.au/ig/StructureDefinition/SHCBodyWeight)
- Smart Health Checks Heart Rate (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeartRate)
- Smart Health Checks Heart Rhythm (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeartRhythm)
- Smart Health Checks Smoking Status (https://smartforms.csiro.au/ig/StructureDefinition/SHCSmokingStatus)
- Smart Health Checks Waist Circumference (https://smartforms.csiro.au/ig/StructureDefinition/SHCWaistCircumference)
- Smart Health Checks Head Circumference (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeadCircumference)
- Smart Health Checks Patch AllergyIntolerance (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchAllergyIntolerance)
- Smart Health Checks Patch Condition (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchCondition)
- Smart Health Checks Patch MedicationStatement (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchMedicationStatement)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Bundle.entry (Closed)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
type | SO Σ | 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: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO Σ | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
Slices for entry | Σ C | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.method 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:post | SO Σ C | 0..* | BackboneElement | Entries for creating new resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO Σ | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
request | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
entry:patch | SO Σ C | 0..* | BackboneElement | Entries for patching existing resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
request | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry:post.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | fullUrl cannot be a version specific reference | `fullUrl.contains('/_history/').not()`
bdl-9 | error | Bundle | A document must have an identifier with a system and a value | `type = 'document' implies (identifier.system.exists() and identifier.value.exists())`
bdl-10 | error | Bundle | A document must have a date | `type = 'document' implies (timestamp.hasValue())`
bdl-11 | error | Bundle | A document must have a Composition as the first resource | `type = 'document' implies entry.first().resource.is(Composition)`
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource | `type = 'message' implies entry.first().resource.is(MessageHeader)`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle |  | 0..* | Bundle | Contains a collection of resources
type | SO | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
Slices for entry |  | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.method
entry:post | SO | 0..* | BackboneElement | Entries for creating new resources
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
fullUrl | SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
request | SO | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
method | SO | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
entry:patch | SO | 0..* | BackboneElement | Entries for patching existing resources
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
fullUrl | SO | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
request | SO | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
method | SO | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle
type | SO Σ | 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: transaction
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
timestamp | SO Σ | 1..1 | instant | When the bundle was assembled
Obligations | Actor
SHALL:populate | SHC App
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, Closed by value:request.method 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:post | SO Σ C | 0..* | BackboneElement | Entries for creating new resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO Σ | 1..1 |  | An allergy or intolerance statement in an Australian healthcare context
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource |  |  | AllergyIntolerance(SmartHealthChecksAllergyIntolerance) |
resource |  |  | Condition(SmartHealthChecksCondition) |
resource |  |  | Immunization(SmartHealthChecksImmunization) |
resource |  |  | MedicationStatement(SmartHealthChecksMedicationStatement) |
resource |  |  | Observation(SmartHealthChecksBloodPressure | SmartHealthChecksBodyHeight | SmartHealthChecksBodyWeight | SmartHealthChecksHeartRate | SmartHealthChecksHeartRhythm | SmartHealthChecksSmokingStatus | SmartHealthChecksWaistCircumference | SmartHealthChecksHeadCircumference) |
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 | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: POST
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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:patch | SO Σ C | 0..* | BackboneElement | Entries for patching existing resources 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
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | SO | 1..1 | SmartHealthChecksPatchAllergyIntolerance, SmartHealthChecksPatchCondition, SmartHealthChecksPatchMedicationStatement | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ C | 1..1 | BackboneElement | Additional execution information (transaction/batch/history)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Fixed Value: PATCH
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
url | SO Σ | 1..1 | uri | URL for HTTP equivalent of this entry
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.language | Base | preferred | Common Languages | 📍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:post.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:post.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:patch.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:post, Bundle.entry:patch | fullUrl cannot be a version specific reference | `fullUrl.contains('/_history/').not()`
bdl-9 | error | Bundle | A document must have an identifier with a system and a value | `type = 'document' implies (identifier.system.exists() and identifier.value.exists())`
bdl-10 | error | Bundle | A document must have a date | `type = 'document' implies (timestamp.hasValue())`
bdl-11 | error | Bundle | A document must have a Composition as the first resource | `type = 'document' implies entry.first().resource.is(Composition)`
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource | `type = 'message' implies entry.first().resource.is(MessageHeader)`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Bundle

Summary

Mandatory: 2 elements(6 nested mandatory elements)
Must-Support: 14 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

- Smart Health Checks AllergyIntolerance (https://smartforms.csiro.au/ig/StructureDefinition/SHCAllergyIntolerance)
- Smart Health Checks Condition (https://smartforms.csiro.au/ig/StructureDefinition/SHCCondition)
- Smart Health Checks Immunization (https://smartforms.csiro.au/ig/StructureDefinition/SHCImmunization)
- Smart Health Checks MedicationStatement (https://smartforms.csiro.au/ig/StructureDefinition/SHCMedicationStatement)
- Smart Health Checks Blood Pressure (https://smartforms.csiro.au/ig/StructureDefinition/SHCBloodPressure)
- Smart Health Checks Body Height (https://smartforms.csiro.au/ig/StructureDefinition/SHCBodyHeight)
- Smart Health Checks Body Weight (https://smartforms.csiro.au/ig/StructureDefinition/SHCBodyWeight)
- Smart Health Checks Heart Rate (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeartRate)
- Smart Health Checks Heart Rhythm (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeartRhythm)
- Smart Health Checks Smoking Status (https://smartforms.csiro.au/ig/StructureDefinition/SHCSmokingStatus)
- Smart Health Checks Waist Circumference (https://smartforms.csiro.au/ig/StructureDefinition/SHCWaistCircumference)
- Smart Health Checks Head Circumference (https://smartforms.csiro.au/ig/StructureDefinition/SHCHeadCircumference)
- Smart Health Checks Patch AllergyIntolerance (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchAllergyIntolerance)
- Smart Health Checks Patch Condition (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchCondition)
- Smart Health Checks Patch MedicationStatement (https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchMedicationStatement)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Bundle.entry (Closed)

Other representations of profile: CSV, Excel, Schematron