HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-submission-bundle | Version: 0.1.1 | |||
| Draft as of 2026-10-16 | Computable Name: SASubmissionBundle | |||
The request body of POST [base]/Claim/$submit. A collection Bundle containing the Special Authority Application
(Claim), the clinical criteria and answers (QuestionnaireResponse), the Patient, the Applicant and optional
Referrer (Practitioner) and the optional submitting Organization. The Bundle is accepted or rejected atomically.
All references between entries SHALL resolve within the Bundle.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection (extensions allowed) | |
| timestamp |
0..1 | instant | When the bundle was assembled | |
  Slices for entry |
C | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   entry:All Slices |
Content/Rules for all slices | |||
   modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
 resource |
1..1 | Resource | A resource in the bundle | |
 entry:claim |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
 resource |
0..1 | SAClaim  |
Claim, Pre-determination or Pre-authorization | |
| entry:questionnaireResponse |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAQuestionnaireResponse |
A structured set of questions and their answers | |
| entry:patient |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAPatient |
Information about an individual or animal receiving health care services | |
| entry:practitioner |
C | 1..2 | BackboneElement | Applicant, and optional Referrer Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |
 entry:organization |
C | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAOrganization |
A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
0..* | Bundle | Contains a collection of resources | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: collection (extensions allowed) | |
| timestamp |
0..1 | instant | When the bundle was assembled | |
| Slices for entry |
4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:All Slices |
Content/Rules for all slices | |||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
1..1 | Resource | A resource in the bundle | |
| search |
0..0 | Search related information | ||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||
| response |
0..0 | Results of execution (transaction/batch/history) | ||
| entry:claim |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAClaim | Claim, Pre-determination or Pre-authorization | |
| entry:questionnaireResponse |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAQuestionnaireResponse | A structured set of questions and their answers | |
| entry:patient |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAPatient | Information about an individual or animal receiving health care services | |
| entry:practitioner |
1..2 | BackboneElement | Applicant, and optional Referrer | |
| resource |
0..1 | SAPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:organization |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAOrganization | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
 meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier |
0..1 | Identifier | Persistent identifier for the bundle | |||||
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection (extensions allowed) | |||||
| timestamp |
0..1 | instant | When the bundle was assembled | |||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
 link |
0..* | BackboneElement | Links related to this Bundle | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||
 url |
1..1 | uri | Reference details for the link | |||||
| Slices for entry |
C | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | Resource | A resource in the bundle | |||||
| entry:claim |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAClaim |
Claim, Pre-determination or Pre-authorization | |||||
 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:questionnaireResponse |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAQuestionnaireResponse |
A structured set of questions and their answers | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache currency | |||||
| ifModifiedSince |
0..1 | instant | For managing cache currency | |||||
| ifMatch |
0..1 | string | For managing update contention | |||||
| ifNoneExist |
0..1 | string | For conditional creates | |||||
| response |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:patient |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAPatient |
Information about an individual or animal receiving health care services | |||||
| 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:practitioner |
C | 1..2 | BackboneElement | Applicant, and optional Referrer Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| 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:organization |
C | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAOrganization |
A grouping of people or organizations with a common purpose | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache currency | |||||
| ifModifiedSince |
0..1 | instant | For managing cache currency | |||||
| ifMatch |
0..1 | string | For managing update contention | |||||
| ifNoneExist |
0..1 | string | For conditional creates | |||||
| response |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.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:claim.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:claim.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:questionnaireResponse.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:questionnaireResponse.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
Summary
Mandatory: 6 elements
Must-Support: 9 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection (extensions allowed) | |
| timestamp |
0..1 | instant | When the bundle was assembled | |
| Slices for entry |
C | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| entry:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
1..1 | Resource | A resource in the bundle | |
| entry:claim |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAClaim |
Claim, Pre-determination or Pre-authorization | |
| entry:questionnaireResponse |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAQuestionnaireResponse |
A structured set of questions and their answers | |
| entry:patient |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAPatient |
Information about an individual or animal receiving health care services | |
| entry:practitioner |
C | 1..2 | BackboneElement | Applicant, and optional Referrer Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:organization |
C | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
0..1 | SAOrganization |
A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
0..* | Bundle | Contains a collection of resources | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: collection (extensions allowed) | |
| timestamp |
0..1 | instant | When the bundle was assembled | |
| Slices for entry |
4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:All Slices |
Content/Rules for all slices | |||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| resource |
1..1 | Resource | A resource in the bundle | |
| search |
0..0 | Search related information | ||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||
| response |
0..0 | Results of execution (transaction/batch/history) | ||
| entry:claim |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAClaim | Claim, Pre-determination or Pre-authorization | |
| entry:questionnaireResponse |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAQuestionnaireResponse | A structured set of questions and their answers | |
| entry:patient |
1..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAPatient | Information about an individual or animal receiving health care services | |
| entry:practitioner |
1..2 | BackboneElement | Applicant, and optional Referrer | |
| resource |
0..1 | SAPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:organization |
0..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource |
0..1 | SAOrganization | A grouping of people or organizations with a common purpose | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier |
0..1 | Identifier | Persistent identifier for the bundle | |||||
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection (extensions allowed) | |||||
| timestamp |
0..1 | instant | When the bundle was assembled | |||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
0..* | BackboneElement | Links related to this Bundle | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||
| url |
1..1 | uri | Reference details for the link | |||||
| Slices for entry |
C | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | Resource | A resource in the bundle | |||||
| entry:claim |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAClaim |
Claim, Pre-determination or Pre-authorization | |||||
| 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:questionnaireResponse |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAQuestionnaireResponse |
A structured set of questions and their answers | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache currency | |||||
| ifModifiedSince |
0..1 | instant | For managing cache currency | |||||
| ifMatch |
0..1 | string | For managing update contention | |||||
| ifNoneExist |
0..1 | string | For conditional creates | |||||
| response |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:patient |
C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAPatient |
Information about an individual or animal receiving health care services | |||||
| 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:practitioner |
C | 1..2 | BackboneElement | Applicant, and optional Referrer Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| 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:organization |
C | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | SAOrganization |
A grouping of people or organizations with a common purpose | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | |||||
| url |
1..1 | uri | URL for HTTP equivalent of this entry | |||||
| ifNoneMatch |
0..1 | string | For managing cache currency | |||||
| ifModifiedSince |
0..1 | instant | For managing cache currency | |||||
| ifMatch |
0..1 | string | For managing update contention | |||||
| ifNoneExist |
0..1 | string | For conditional creates | |||||
| response |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.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:claim.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:claim.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:questionnaireResponse.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:questionnaireResponse.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Bundle
Summary
Mandatory: 6 elements
Must-Support: 9 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron