Smart Health Checks
0.3.0 - ci-build Australia flag

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-09-05 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:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate SHC App
.... 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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SOΣ 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... request SOΣC 1..1 BackboneElement Additional execution information (transaction/batch/history)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:post.request.methodrequiredFixed Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patch.request.methodrequiredFixed Value: PATCH
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:post, Bundle.entry:patchmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:post, Bundle.entry:patchfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SO 1..1 instant When the bundle was assembled
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... method SO 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SO 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... entry:patch SO 0..* BackboneElement Entries for patching existing resources
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... request SO 1..1 BackboneElement Additional execution information (transaction/batch/history)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... method SO 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: PATCH
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SO 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SOΣ 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:post.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:post.request.methodrequiredFixed Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patch.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:patch.request.methodrequiredFixed Value: PATCH
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:post, Bundle.entry:patchmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:post, Bundle.entry:patchfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate SHC App
.... 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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SOΣ 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... request SOΣC 1..1 BackboneElement Additional execution information (transaction/batch/history)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:post.request.methodrequiredFixed Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patch.request.methodrequiredFixed Value: PATCH
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:post, Bundle.entry:patchmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:post, Bundle.entry:patchfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SO 1..1 instant When the bundle was assembled
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... method SO 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: POST
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SO 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... entry:patch SO 0..* BackboneElement Entries for patching existing resources
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... request SO 1..1 BackboneElement Additional execution information (transaction/batch/history)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... method SO 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Fixed Value: PATCH
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SO 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
... timestamp SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SOΣ 1..1 An allergy or intolerance statement in an Australian healthcare context
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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
ObligationsActor
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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... resource SO 1..1 SmartHealthChecksPatch Parameters for patching elements supported in Smart Health Checks
ObligationsActor
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)
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... url SOΣ 1..1 uri URL for HTTP equivalent of this entry
ObligationsActor
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:post.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:post.request.methodrequiredFixed Value: POST
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patch.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:patch.request.methodrequiredFixed Value: PATCH
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:post, Bundle.entry:patchmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:post, Bundle.entry:patchfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

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