SHINNYIG - Local Development build (v0.2). See the Directory of published versions
Resource Profile: SHINNYBundleProfile
| Official URL: http://shinny.org/StructureDefinition/SHINNYBundleProfile | Version: 0.2 | |||
| Draft as of 2023-07-28 | Computable Name: SHINNYBundleProfile | |||
Contains a collection of resources. This is an extension of the base FHIR Bundle with some additional restrictions.
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  meta | S | 1..1 | SHINNYMeta | Metadata about a resource |
 type | 1..1 | code | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) | |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
| total | 0..0 | |||
| link | 0..0 | |||
 entry | ||||
 search | 0..0 | |||
| request | ||||
| method | 1..1 | code | POST | DELETE Binding: SHINNYHTTPVerbsVS (required) | |
| ifNoneMatch | 0..0 | |||
| ifMatch | 0..0 | |||
 ifNoneExist | 0..0 | |||
 response | ||||
 location | 0..0 | |||
| etag | 0..0 | |||
| lastModified | 0..0 | |||
| signature | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Bundle.type | required | SHINNYBundleTypeVS |
| Bundle.entry.request.method | required | SHINNYHTTPVerbsVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources |
| meta | S | 1..1 | SHINNYMeta | Metadata about a resource |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type | Σ | 1..1 | code | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) |
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Bundle.type | required | SHINNYBundleTypeVS |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | S | 1..1 | SHINNYMeta | Metadata about a 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 | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| entry | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | Resource | A resource in the bundle | ||||
| 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 | POST | DELETE Binding: SHINNYHTTPVerbsVS (required) | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| 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) | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | SHINNYBundleTypeVS | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | SHINNYHTTPVerbsVS |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| meta | S | 1..1 | SHINNYMeta | Metadata about a resource |
| type | 1..1 | code | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) | |
| timestamp | S | 1..1 | instant | When the bundle was assembled |
| total | 0..0 | |||
| link | 0..0 | |||
| entry | ||||
| search | 0..0 | |||
| request | ||||
| method | 1..1 | code | POST | DELETE Binding: SHINNYHTTPVerbsVS (required) | |
| ifNoneMatch | 0..0 | |||
| ifMatch | 0..0 | |||
| ifNoneExist | 0..0 | |||
| response | ||||
| location | 0..0 | |||
| etag | 0..0 | |||
| lastModified | 0..0 | |||
| signature | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Bundle.type | required | SHINNYBundleTypeVS |
| Bundle.entry.request.method | required | SHINNYHTTPVerbsVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources |
| meta | S | 1..1 | SHINNYMeta | Metadata about a resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type | Σ | 1..1 | code | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) |
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Bundle.type | required | SHINNYBundleTypeVS |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | S | 1..1 | SHINNYMeta | Metadata about a 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 | Only type 'transaction' is supported Binding: SHINNYBundleTypeVS (required) | ||||
| timestamp | SΣ | 1..1 | instant | When the bundle was assembled | ||||
| entry | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | Resource | A resource in the bundle | ||||
| 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 | POST | DELETE Binding: SHINNYHTTPVerbsVS (required) | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| 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) | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | SHINNYBundleTypeVS | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | SHINNYHTTPVerbsVS |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Other representations of profile: CSV, Excel, Schematron